ExcelScript.Chart interface

Active le graphique dans l’interface utilisateur Excel.

activate(): void;

Retourne

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

Retourne

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);
}

Supprime l’objet de graphique.

delete(): void;

Retourne

Représente les axes du graphique.

getAxes(): ChartAxes;

Retourne

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;

Retourne

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

getChartType(): ChartType;

Retourne

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

getDataLabels(): ChartDataLabels;

Retourne

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;

Retourne

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

getDisplayBlanksAs(): ChartDisplayBlanksAs;

Retourne

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

getFormat(): ChartAreaFormat;

Retourne

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

getHeight(): number;

Retourne

L’ID unique du graphique.

getId(): string;

Retourne

Restitue le graphique sous la forme d’une image encodée en Base64 en le mettant à l’échelle pour qu’il s’adapte 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

Retourne

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;
}

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

getLeft(): number;

Retourne

Représente la légende du graphique.

getLegend(): ChartLegend;

Retourne

Spécifie le nom d’un objet graphique.

getName(): string;

Retourne

Encapsule les options pour le graphique croisé dynamique.

getPivotOptions(): ChartPivotOptions;

Retourne

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

getPlotArea(): ChartPlotArea;

Retourne

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;

Retourne

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);
  }
}

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

getPlotVisibleOnly(): boolean;

Retourne

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

getSeries(): ChartSeries[];

Retourne

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);
  });
}

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;

Retourne

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

getShowAllFieldButtons(): boolean;

Retourne

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;

Retourne

Spécifie le style de graphique pour le graphique.

getStyle(): number;

Retourne

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

getTitle(): ChartTitle;

Retourne

Exemples

/**
 * This sample sets the title text for an existing 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];
  
  // Set the chart title.
  chart.getTitle().setText("Quarterly Sales by Product");
}

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;

Retourne

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

getWidth(): number;

Retourne

Feuille de calcul contenant le graphique actuel.

getWorksheet(): Worksheet;

Retourne

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

Retourne

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

setChartType(chartType: ChartType): void;

Paramètres

Retourne

Redéfinit les données sources du graphique.

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

Paramètres

Retourne

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

setDisplayBlanksAs(displayBlanksAs: ChartDisplayBlanksAs): void;

Paramètres

Retourne

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

setHeight(height: number): void;

Paramètres

Retourne

Exemples

/**
 * This sample sets the height of an existing 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];
  
  // Set the chart height to 300 points.
  chart.setHeight(300);
}

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

Retourne

Exemples

/**
 * This sample sets the left position of an existing 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];
  
  // Set the left position to 50 points from the left edge.
  chart.setLeft(50);
}

Spécifie le nom d’un objet graphique.

setName(name: string): void;

Paramètres

Retourne

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");
}

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

Retourne

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);
  }
}

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

Retourne

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

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

Paramètres

Retourne

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");
}

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

Retourne

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

setShowAllFieldButtons(showAllFieldButtons: boolean): void;

Paramètres

Retourne

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.

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum: boolean): void;

Paramètres

Retourne

Spécifie le style de graphique pour le graphique.

setStyle(style: number): void;

Paramètres

Retourne

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

Retourne

Exemples

/**
 * This sample sets the top position of an existing 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];
  
  // Set the top position to 100 points from the top edge.
  chart.setTop(100);
}

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

setWidth(width: number): void;

Paramètres

Retourne

Exemples

/**
 * This sample sets the width of an existing 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];
  
  // Set the chart width to 500 points.
  chart.setWidth(500);
}