ExcelScript.ChartLegend interface

Colis:

ExcelScript

Représente la légende d’un graphique.

Remarques

Exemples

/**
 * This sample configures the chart legend.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Configure the legend.
  const legend = chart.getLegend();
  legend.setPosition(ExcelScript.ChartLegendPosition.bottom);
  legend.setVisible(true);
}

Méthode

getFormat()	Représente le format d’une légende de graphique, à savoir le format du remplissage et de la police.
getHeight()	Spécifie la hauteur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
getLeft()	Spécifie la valeur de gauche, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
getLegendEntries()	Représente une collection de legendEntries dans la légende.
getOverlay()	Spécifie si la légende du graphique doit chevaucher le corps principal du graphique.
getPosition()	Spécifie la position de la légende sur le graphique. Pour plus d’informations, consultez ExcelScript.ChartLegendPosition .
getShowShadow()	Spécifie si la légende comporte une ombre sur le graphique.
getTop()	Spécifie le haut d’une légende de graphique.
getVisible()	Spécifie si la légende du graphique est visible.
getWidth()	Spécifie la largeur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
setHeight(height)	Spécifie la hauteur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
setLeft(left)	Spécifie la valeur de gauche, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.
setOverlay(overlay)	Spécifie si la légende du graphique doit chevaucher le corps principal du graphique.
setPosition(position)	Spécifie la position de la légende sur le graphique. Pour plus d’informations, consultez ExcelScript.ChartLegendPosition .
setShowShadow(showShadow)	Spécifie si la légende comporte une ombre sur le graphique.
setTop(top)	Spécifie le haut d’une légende de graphique.
setVisible(visible)	Spécifie si la légende du graphique est visible.
setWidth(width)	Spécifie la largeur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.

Détails de la méthode

getFormat()

Représente le format d’une légende de graphique, à savoir le format du remplissage et de la police.

getFormat(): ChartLegendFormat;

Retourne

ExcelScript.ChartLegendFormat

getHeight()

Spécifie la hauteur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.

getHeight(): number;

Retourne

number

getLeft()

Spécifie la valeur de gauche, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.

getLeft(): number;

Retourne

number

getLegendEntries()

Représente une collection de legendEntries dans la légende.

getLegendEntries(): ChartLegendEntry[];

Retourne

ExcelScript.ChartLegendEntry[]

getOverlay()

Spécifie si la légende du graphique doit chevaucher le corps principal du graphique.

getOverlay(): boolean;

Retourne

boolean

getPosition()

Spécifie la position de la légende sur le graphique. Pour plus d’informations, consultez ExcelScript.ChartLegendPosition .

getPosition(): ChartLegendPosition;

Retourne

ExcelScript.ChartLegendPosition

getShowShadow()

Spécifie si la légende comporte une ombre sur le graphique.

getShowShadow(): boolean;

Retourne

boolean

getTop()

Spécifie le haut d’une légende de graphique.

getTop(): number;

Retourne

number

getVisible()

Spécifie si la légende du graphique est visible.

getVisible(): boolean;

Retourne

boolean

getWidth()

Spécifie la largeur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.

getWidth(): number;

Retourne

number

setHeight(height)

Spécifie la hauteur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.

setHeight(height: number): void;

Paramètres

height

number

Retourne

void

setLeft(left)

Spécifie la valeur de gauche, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.

setLeft(left: number): void;

Paramètres

left

number

Retourne

void

setOverlay(overlay)

Spécifie si la légende du graphique doit chevaucher le corps principal du graphique.

setOverlay(overlay: boolean): void;

Paramètres

overlay

boolean

Retourne

void

setPosition(position)

Spécifie la position de la légende sur le graphique. Pour plus d’informations, consultez ExcelScript.ChartLegendPosition .

setPosition(position: ChartLegendPosition): void;

Paramètres

position

ExcelScript.ChartLegendPosition

Retourne

void

Exemples

/**
 * This sample sets the legend position on a chart.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Position the legend on the right side.
  chart.getLegend().setPosition(ExcelScript.ChartLegendPosition.right);
}

setShowShadow(showShadow)

Spécifie si la légende comporte une ombre sur le graphique.

setShowShadow(showShadow: boolean): void;

Paramètres

showShadow

boolean

Retourne

void

setTop(top)

Spécifie le haut d’une légende de graphique.

setTop(top: number): void;

Paramètres

top

number

Retourne

void

setVisible(visible)

Spécifie si la légende du graphique est visible.

setVisible(visible: boolean): void;

Paramètres

visible

boolean

Retourne

void

Exemples

/**
 * This sample hides the chart legend.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Hide the legend.
  chart.getLegend().setVisible(false);
}

setWidth(width)

Spécifie la largeur, en points, de la légende sur le graphique. La valeur est null si la légende n’est pas visible.

setWidth(width: number): void;

Paramètres

width

number

Retourne

void