ExcelScript.Chart interface

Référence

Paquet:: ExcelScript

Représente un objet de graphique dans un classeur.

Méthodes

activate()	Active le graphique dans l’interface utilisateur Excel.
addChartSeries(name, index)	Ajouter une nouvelle série à la collection. La nouvelle série ajoutée n’est pas visible tant que les valeurs, les valeurs de l’axe X ou les tailles de bulles ne sont pas définies (selon le type de graphique).
delete()	Supprime l’objet de graphique.
getAxes()	Représente les axes du graphique.
getCategoryLabelLevel()	Spécifie une constante d’énumération de niveau d’étiquette de catégorie de graphique, faisant référence au niveau des étiquettes de catégorie source.
getChartType()	Spécifie le type du graphique. Pour plus d’informations, consultez `ExcelScript.ChartType` .
getDataLabels()	Représente les étiquettes des données sur le graphique.
getDataTable()	Obtient la table de données sur le graphique. Si le graphique n’autorise pas de table de données, cette méthode retourne `undefined`.
getDisplayBlanksAs()	Spécifie la façon dont les cellules vides sont tracées sur un graphique.
getFormat()	Regroupe les propriétés de format de la zone de graphique.
getHeight()	Spécifie la hauteur, en points, de l’objet de graphique.
getId()	L’ID unique du graphique.
getImage(width, height, fittingMode)	Affiche le graphique sous forme d’image codée en Base64 ajustée aux dimensions spécifiées. Les proportions sont conservées dans le cadre du redimensionnement.
getLeft()	La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul.
getLegend()	Représente la légende du graphique.
getName()	Spécifie le nom d’un objet graphique.
getPivotOptions()	Encapsule les options pour le graphique croisé dynamique.
getPlotArea()	Représente la zone de traçage du graphique.
getPlotBy()	Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique.
getPlotVisibleOnly()	Vrai si seules les cellules visibles sont tracées. Faux si les deux cellules visibles et masquées sont tracées.
getSeries()	Représente une série ou une collection de séries dans le graphique.
getSeriesNameLevel()	Spécifie une constante d’énumération de niveau de nom de série de graphique, faisant référence au niveau des noms des séries sources.
getShowAllFieldButtons()	Spécifie s’il faut afficher tous les boutons de champ sur un graphique croisé dynamique.
getShowDataLabelsOverMaximum()	Spécifie s’il faut afficher les étiquettes de données lorsque la valeur est supérieure à la valeur maximale sur l’axe des valeurs. Si l’axe des valeurs devient plus petit que la taille des points de données, vous pouvez utiliser cette propriété pour définir s’il faut afficher les étiquettes de données. Cette propriété s'applique uniquement aux graphiques 2D.
getStyle()	Spécifie le style de graphique pour le graphique.
getTitle()	Représente le titre du graphique indiqué et comprend le texte, la visibilité, la position et la mise en forme du titre.
getTop()	Spécifie la distance, en points, entre le bord supérieur de l’objet et le haut de la ligne 1 (dans une feuille de calcul) ou le haut de la zone de graphique (sur un graphique).
getWidth()	Spécifie la largeur, en points, de l’objet graphique.
getWorksheet()	Feuille de calcul contenant le graphique actuel.
setCategoryLabelLevel(categoryLabelLevel)	Spécifie une constante d’énumération de niveau d’étiquette de catégorie de graphique, faisant référence au niveau des étiquettes de catégorie source.
setChartType(chartType)	Spécifie le type du graphique. Pour plus d’informations, consultez `ExcelScript.ChartType` .
setData(sourceData, seriesBy)	Redéfinit les données sources du graphique.
setDisplayBlanksAs(displayBlanksAs)	Spécifie la façon dont les cellules vides sont tracées sur un graphique.
setHeight(height)	Spécifie la hauteur, en points, de l’objet de graphique.
setLeft(left)	La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul.
setName(name)	Spécifie le nom d’un objet graphique.
setPlotBy(plotBy)	Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique.
setPlotVisibleOnly(plotVisibleOnly)	Vrai si seules les cellules visibles sont tracées. Faux si les deux cellules visibles et masquées sont tracées.
setPosition(startCell, endCell)	Positionne le graphique par rapport aux cellules dans la feuille de calcul.
setSeriesNameLevel(seriesNameLevel)	Spécifie une constante d’énumération de niveau de nom de série de graphique, faisant référence au niveau des noms des séries sources.
setShowAllFieldButtons(showAllFieldButtons)	Spécifie s’il faut afficher tous les boutons de champ sur un graphique croisé dynamique.
setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)	Spécifie s’il faut afficher les étiquettes de données lorsque la valeur est supérieure à la valeur maximale sur l’axe des valeurs. Si l’axe des valeurs devient plus petit que la taille des points de données, vous pouvez utiliser cette propriété pour définir s’il faut afficher les étiquettes de données. Cette propriété s'applique uniquement aux graphiques 2D.
setStyle(style)	Spécifie le style de graphique pour le graphique.
setTop(top)	Spécifie la distance, en points, entre le bord supérieur de l’objet et le haut de la ligne 1 (dans une feuille de calcul) ou le haut de la zone de graphique (sur un graphique).
setWidth(width)	Spécifie la largeur, en points, de l’objet graphique.

Détails de la méthode

activate()

Active le graphique dans l’interface utilisateur Excel.

activate(): void;

Retours

void

addChartSeries(name, index)

Ajouter une nouvelle série à la collection. La nouvelle série ajoutée n’est pas visible tant que les valeurs, les valeurs de l’axe X ou les tailles de bulles ne sont pas définies (selon le type de graphique).

addChartSeries(name?: string, index?: number): ChartSeries;

Paramètres

name: string

Facultatif. Nom de la série.

index: number

Facultatif. Valeur d’index de la série à ajouter. Avec indice zéro.

Retours

ExcelScript.ChartSeries

Exemples

/**
 * This sample produces a line chart with two series.
 * The chart assumes data in A1:E5 that looks like this:
 * Product Qtr1 Qtr2 Qtr3 Qtr4
 * Frames 5000 7000 6544 4377
 * Saddles 400 323 276 651
 */
function main(workbook: ExcelScript.Workbook) {
  // Establish the ranges to use.
  const sheet = workbook.getActiveWorksheet();
  const headerRange = sheet.getRange("A1:E1");
  const firstSeriesRange = sheet.getRange("A2:E2");
  const secondSeriesRange = sheet.getRange("A3:E3");

  // Create the chart.
  const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);

  // Add the first chart series.
  const firstSeries = lineChart.addChartSeries();
  firstSeries.setXAxisValues(headerRange);
  firstSeries.setValues(firstSeriesRange);

  // Add the second chart series.
  const secondSeries = lineChart.addChartSeries();
  secondSeries.setXAxisValues(headerRange);
  secondSeries.setValues(secondSeriesRange);
}

delete()

Supprime l’objet de graphique.

delete(): void;

Retours

void

getAxes()

Représente les axes du graphique.

getAxes(): ChartAxes;

Retours

ExcelScript.ChartAxes

getCategoryLabelLevel()

Spécifie une constante d’énumération de niveau d’étiquette de catégorie de graphique, faisant référence au niveau des étiquettes de catégorie source.

getCategoryLabelLevel(): number;

Retours

number

getChartType()

Spécifie le type du graphique. Pour plus d’informations, consultez ExcelScript.ChartType .

getChartType(): ChartType;

Retours

ExcelScript.ChartType

getDataLabels()

Représente les étiquettes des données sur le graphique.

getDataLabels(): ChartDataLabels;

Retours

ExcelScript.ChartDataLabels

getDataTable()

Obtient la table de données sur le graphique. Si le graphique n’autorise pas de table de données, cette méthode retourne undefined.

getDataTable(): ChartDataTable;

Retours

ExcelScript.ChartDataTable

getDisplayBlanksAs()

Spécifie la façon dont les cellules vides sont tracées sur un graphique.

getDisplayBlanksAs(): ChartDisplayBlanksAs;

Retours

ExcelScript.ChartDisplayBlanksAs

getFormat()

Regroupe les propriétés de format de la zone de graphique.

getFormat(): ChartAreaFormat;

Retours

ExcelScript.ChartAreaFormat

getHeight()

Spécifie la hauteur, en points, de l’objet de graphique.

getHeight(): number;

Retours

number

getId()

L’ID unique du graphique.

getId(): string;

Retours

string

getImage(width, height, fittingMode)

Affiche le graphique sous forme d’image codée en Base64 ajustée aux dimensions spécifiées. Les proportions sont conservées dans le cadre du redimensionnement.

getImage(
            width?: number,
            height?: number,
            fittingMode?: ImageFittingMode
        ): string;

Paramètres

width: number

Facultatif. Largeur souhaitée de l’image produite.

height: number

Facultatif. Hauteur souhaitée de l’image produite.

fittingMode: ExcelScript.ImageFittingMode

Facultatif. Méthode utilisée pour mettre à l’échelle le graphique aux dimensions spécifiées (si la hauteur et la largeur sont définies).

Retours

string

Exemples

/**
 * This script returns an image of the first chart in the first worksheet.
 * That image is 600x400 pixels and the chart will be 
 * stretched to fill those dimensions.
 * The returned image can be used in a Power Automate flow.
 */
function main(workbook: ExcelScript.Workbook): string {
  // Get the first chart in the first worksheet.
  const firstSheet = workbook.getFirstWorksheet();
  const firstChart = firstSheet.getCharts()[0];

  // Get an image of the chart as a base64-encoded string.
  const base64String = firstChart.getImage(
    600, /* Width */
    400, /* Height */
    ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */
  );

  return base64String;
}

getLeft()

La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul.

getLeft(): number;

Retours

number

getLegend()

Représente la légende du graphique.

getLegend(): ChartLegend;

Retours

ExcelScript.ChartLegend

getName()

Spécifie le nom d’un objet graphique.

getName(): string;

Retours

string

getPivotOptions()

Encapsule les options pour le graphique croisé dynamique.

getPivotOptions(): ChartPivotOptions;

Retours

ExcelScript.ChartPivotOptions

getPlotArea()

Représente la zone de traçage du graphique.

getPlotArea(): ChartPlotArea;

Retours

ExcelScript.ChartPlotArea

getPlotBy()

Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique.

getPlotBy(): ChartPlotBy;

Retours

ExcelScript.ChartPlotBy

Exemples

/**
 * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
  
  // Switch the row and column for the chart's data source.
  if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
    // If the chart is grouped by columns, switch it to rows.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
  } else {
    // If the chart is grouped by rows, switch it to columns.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
  }
}

getPlotVisibleOnly()

Vrai si seules les cellules visibles sont tracées. Faux si les deux cellules visibles et masquées sont tracées.

getPlotVisibleOnly(): boolean;

Retours

boolean

getSeries()

Représente une série ou une collection de séries dans le graphique.

getSeries(): ChartSeries[];

Retours

ExcelScript.ChartSeries[]

Exemples

/**
 * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let chart = selectedSheet.getChart("ColumnClusteredChart");

  // Set the overlap of every column of each series within a category.
  let seriesList = chart.getSeries();
  seriesList.forEach((series) => {
    // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
    series.setOverlap(25);
  });
}

getSeriesNameLevel()

Spécifie une constante d’énumération de niveau de nom de série de graphique, faisant référence au niveau des noms des séries sources.

getSeriesNameLevel(): number;

Retours

number

getShowAllFieldButtons()

Spécifie s’il faut afficher tous les boutons de champ sur un graphique croisé dynamique.

getShowAllFieldButtons(): boolean;

Retours

boolean

getShowDataLabelsOverMaximum()

Spécifie s’il faut afficher les étiquettes de données lorsque la valeur est supérieure à la valeur maximale sur l’axe des valeurs. Si l’axe des valeurs devient plus petit que la taille des points de données, vous pouvez utiliser cette propriété pour définir s’il faut afficher les étiquettes de données. Cette propriété s'applique uniquement aux graphiques 2D.

getShowDataLabelsOverMaximum(): boolean;

Retours

boolean

getStyle()

Spécifie le style de graphique pour le graphique.

getStyle(): number;

Retours

number

getTitle()

Représente le titre du graphique indiqué et comprend le texte, la visibilité, la position et la mise en forme du titre.

getTitle(): ChartTitle;

Retours

ExcelScript.ChartTitle

getTop()

Spécifie la distance, en points, entre le bord supérieur de l’objet et le haut de la ligne 1 (dans une feuille de calcul) ou le haut de la zone de graphique (sur un graphique).

getTop(): number;

Retours

number

getWidth()

Spécifie la largeur, en points, de l’objet graphique.

getWidth(): number;

Retours

number

getWorksheet()

Feuille de calcul contenant le graphique actuel.

getWorksheet(): Worksheet;

Retours

ExcelScript.Worksheet

setCategoryLabelLevel(categoryLabelLevel)

Spécifie une constante d’énumération de niveau d’étiquette de catégorie de graphique, faisant référence au niveau des étiquettes de catégorie source.

setCategoryLabelLevel(categoryLabelLevel: number): void;

Paramètres

categoryLabelLevel: number

Retours

void

setChartType(chartType)

Spécifie le type du graphique. Pour plus d’informations, consultez ExcelScript.ChartType .

setChartType(chartType: ChartType): void;

Paramètres

chartType: ExcelScript.ChartType

Retours

void

setData(sourceData, seriesBy)

Redéfinit les données sources du graphique.

setData(sourceData: Range, seriesBy?: ChartSeriesBy): void;

Paramètres

sourceData: ExcelScript.Range

Objet de plage correspondant aux données sources.

seriesBy: ExcelScript.ChartSeriesBy

Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique. Il peut s’agir de l’un des éléments suivants : Auto (valeur par défaut), Lignes et Colonnes. Pour plus d’informations, consultez ExcelScript.ChartSeriesBy .

Retours

void

setDisplayBlanksAs(displayBlanksAs)

Spécifie la façon dont les cellules vides sont tracées sur un graphique.

setDisplayBlanksAs(displayBlanksAs: ChartDisplayBlanksAs): void;

Paramètres

displayBlanksAs: ExcelScript.ChartDisplayBlanksAs

Retours

void

setHeight(height)

Spécifie la hauteur, en points, de l’objet de graphique.

setHeight(height: number): void;

Paramètres

height: number

Retours

void

setLeft(left)

La distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul.

setLeft(left: number): void;

Paramètres

left: number

Retours

void

setName(name)

Spécifie le nom d’un objet graphique.

setName(name: string): void;

Paramètres

name: string

Retours

void

Exemples

/**
 * This sample creates a column-clustered chart based on the current worksheet's data.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the data range.
  let range = selectedSheet.getUsedRange();

  // Insert a chart using the data on the current worksheet.
  let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

  // Name the chart for easy access in other scripts.
  chart.setName("ColumnChart");
}

setPlotBy(plotBy)

Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique.

setPlotBy(plotBy: ChartPlotBy): void;

Paramètres

plotBy: ExcelScript.ChartPlotBy

Retours

void

Exemples

/**
 * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
  
  // Switch the row and column for the chart's data source.
  if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
    // If the chart is grouped by columns, switch it to rows.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
  } else {
    // If the chart is grouped by rows, switch it to columns.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
  }
}

setPlotVisibleOnly(plotVisibleOnly)

Vrai si seules les cellules visibles sont tracées. Faux si les deux cellules visibles et masquées sont tracées.

setPlotVisibleOnly(plotVisibleOnly: boolean): void;

Paramètres

plotVisibleOnly: boolean

Retours

void

setPosition(startCell, endCell)

Positionne le graphique par rapport aux cellules dans la feuille de calcul.

setPosition(startCell: Range | string, endCell?: Range | string): void;

Paramètres

startCell: ExcelScript.Range | string

Cellule de début. Il s’agit de l’emplacement où le graphique sera déplacé. La cellule de début est la cellule supérieure gauche ou supérieure droite, selon les paramètres d’affichage droite-gauche définis par l’utilisateur.

endCell: ExcelScript.Range | string

Facultatif. Cellule de fin. Si une valeur est indiquée, la largeur et la hauteur du graphique seront définies de manière à couvrir entièrement cette cellule/plage.

Retours

void

Exemples

/**
 * This sample moves an existing chart to a specific place on the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();
  
  // Get an existing chart named "ColumnChart".
  let chart = selectedSheet.getChart("ColumnChart");

  // Place the chart over the range "F1:L13".
  chart.setPosition("F1", "L13");
}

setSeriesNameLevel(seriesNameLevel)

Spécifie une constante d’énumération de niveau de nom de série de graphique, faisant référence au niveau des noms des séries sources.

setSeriesNameLevel(seriesNameLevel: number): void;

Paramètres

seriesNameLevel: number

Retours

void

setShowAllFieldButtons(showAllFieldButtons)

Spécifie s’il faut afficher tous les boutons de champ sur un graphique croisé dynamique.

setShowAllFieldButtons(showAllFieldButtons: boolean): void;

Paramètres

showAllFieldButtons: boolean

Retours

void

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum: boolean): void;

Paramètres

showDataLabelsOverMaximum: boolean

Retours

void

setStyle(style)

Spécifie le style de graphique pour le graphique.

setStyle(style: number): void;

Paramètres

style: number

Retours

void

setTop(top)

Spécifie la distance, en points, entre le bord supérieur de l’objet et le haut de la ligne 1 (dans une feuille de calcul) ou le haut de la zone de graphique (sur un graphique).

setTop(top: number): void;

Paramètres

top: number

Retours

void

setWidth(width)

Spécifie la largeur, en points, de l’objet graphique.

setWidth(width: number): void;

Paramètres

width: number

Retours

void