Partager via


ExcelScript.ChartSeries interface

Représente une série dans un graphique.

Remarques

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

Méthode

addChartTrendline(type)

Ajoute une nouvelle courbe de tendance à la collection de courbes de tendance.

delete()

Supprime la série graphique.

getAxisGroup()

Spécifie le groupe pour la série spécifiée.

getBinOptions()

Encapsule les options bin uniquement pour les histogrammes et graphiques de pareto.

getBoxwhiskerOptions()

Résume les options pour le graphique de zone et valeur.

getBubbleScale()

Peut être une valeur d’entier entre 0 (zéro) et 300 correspondant à un pourcentage de la taille par défaut. Cette propriété s'applique uniquement aux graphiques en bulles.

getChartTrendline(index)

Obtient un objet de courbe de tendance par index, qui est l’ordre d’insertion dans le tableau d’éléments.

getChartType()

Représente le type de graphique d’une série. Pour plus d’informations, consultez ExcelScript.ChartType .

getDataLabels()

Représente une collection de toutes les étiquettes de données de la série.

getDimensionDataSourceString(dimension)

Obtient la représentation sous forme de chaîne de la source de données de la série de graphiques. La représentation sous forme de chaîne peut être une information telle qu’une adresse de cellule.

getDimensionDataSourceType(dimension)

Obtient le type de source de données de la série de graphiques.

getDimensionValues(dimension)

Obtient les valeurs d’une dimension unique de la série de graphiques. Il peut s’agir de valeurs de catégorie ou de données, selon la dimension spécifiée et la façon dont les données sont mappées pour la série de graphiques.

getDoughnutHoleSize()

Représente la taille du centre d’une série de graphiques en anneaux. Valide uniquement sur les graphiques en anneau et en anneau explosé. Génère une InvalidArgument erreur sur les graphiques non valides.

getExplosion()

Spécifie la valeur d’explosion d’un graphique en secteurs ou d’un graphique en anneau. Renvoie 0 (zéro) s’il n’y a aucune explosion (la pointe de la coupe est dans le centre du graphique).

getFiltered()

Spécifie si la série est filtrée. Non applicable pour les graphiques en surface.

getFirstSliceAngle()

Spécifie l’angle de la première tranche de graphique en secteurs ou en anneau, en degrés (dans le sens des aiguilles d’une montre à partir de la verticale). S’applique uniquement aux graphiques en secteurs, graphiques en secteurs 3D et graphiques en anneaux. Peut être une valeur comprise entre 0 et 360.

getFormat()

Représente le format d’une série de graphique, à savoir le format de remplissage et des lignes.

getGapWidth()

Représente la largeur de l’intervalle d’une série de graphique. Valide uniquement sur les graphiques à barres et histogrammes, ainsi que sur des classes spécifiques de graphiques en courbes et en secteurs. Lève une exception d’argument non valide sur les graphiques non valides.

getGradientMaximumColor()

Spécifie la couleur de la valeur maximale d’une série de graphiques de carte de région.

getGradientMaximumType()

Spécifie le type de valeur maximale d’une série de graphiques de carte de région.

getGradientMaximumValue()

Spécifie la valeur maximale d’une série de graphiques de carte de région.

getGradientMidpointColor()

Spécifie la couleur de la valeur milieu d’une série de graphiques de carte de région.

getGradientMidpointType()

Spécifie le type de la valeur de point intermédiaire d’une série de graphiques de carte de région.

getGradientMidpointValue()

Spécifie la valeur du point médian d’une série de graphiques de carte de région.

getGradientMinimumColor()

Spécifie la couleur de la valeur minimale d’une série de graphiques de carte de régions.

getGradientMinimumType()

Spécifie le type pour la valeur minimale d’une série de graphiques de carte de région.

getGradientMinimumValue()

Spécifie la valeur minimale d’une série de graphiques de carte de région.

getGradientStyle()

Spécifie le style de dégradé de série d’un graphique de carte de région.

getHasDataLabels()

Spécifie si la série a des étiquettes de données.

getInvertColor()

Spécifie la couleur de remplissage des points de données négatifs d’une série.

getInvertIfNegative()

True si Excel inverse le modèle dans l’élément lorsqu’il correspond à un nombre négatif.

getMapOptions()

Encapsule les options pour le graphique carte de région.

getMarkerBackgroundColor()

Spécifie la couleur d’arrière-plan du marqueur d’une série de graphiques.

getMarkerForegroundColor()

Spécifie la couleur de premier plan du marqueur d’une série de graphiques.

getMarkerSize()

Spécifie la taille de marqueur d’une série de graphiques. La plage de tailles prise en charge est comprise entre 2 et 72. Cette méthode retourne une erreur InvalidArgument si elle est définie avec une taille en dehors de la plage prise en charge.

getMarkerStyle()

Spécifie le style de marqueur d’une série de graphiques. Pour plus d’informations, consultez ExcelScript.ChartMarkerStyle .

getName()

Spécifie le nom d’une série dans un graphique. La longueur du nom ne doit pas être supérieure à 255 caractères.

getOverlap()

Spécifie comment barres et colonnes sont positionnées. Peut être une valeur comprise entre -100 et 100. S’applique uniquement aux graphiques en barres 2D et en colonnes 2D.

getParentLabelStrategy()

Spécifie la zone de stratégie d’étiquette parente de série pour un graphique treemap.

getPlotOrder()

Spécifie l’ordre de traçage d’une série de graphiques dans le groupe de graphiques.

getPoints()

Retourne une collection de tous les points de la série.

getSecondPlotSize()

Spécifie la taille de la section secondaire d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur, sous la forme d’un pourcentage de la taille du secteur principal. Peut être une valeur comprise entre 5 et 200.

getShowConnectorLines()

Spécifie si les lignes de connecteur sont affichées dans les graphiques en cascade.

getShowLeaderLines()

Spécifie si des lignes d’leader sont affichées pour chaque étiquette de données de la série.

getShowShadow()

Spécifie si la série a une ombre.

getSmooth()

Spécifie si la série est lisse. Applicable uniquement aux graphiques en courbes et à nuages de points.

getSplitType()

Spécifie la façon dont les deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur sont fractionnées.

getSplitValue()

Spécifie la valeur de seuil qui sépare deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur.

getTrendlines()

Collection de courbes de tendance dans la série.

getVaryByCategories()

True si Excel affecte une couleur ou un modèle différent à chaque marqueur de données. Le graphique ne doit contenir qu’une seule série.

getXErrorBars()

Représente l’objet de la barre d’erreur pour une série de graphique.

getYErrorBars()

Représente l’objet de la barre d’erreur pour une série de graphique.

setAxisGroup(axisGroup)

Spécifie le groupe pour la série spécifiée.

setBubbleScale(bubbleScale)

Peut être une valeur d’entier entre 0 (zéro) et 300 correspondant à un pourcentage de la taille par défaut. Cette propriété s'applique uniquement aux graphiques en bulles.

setBubbleSizes(sourceData)

Définit les tailles de bulles d’une série de graphiques. Fonctionne uniquement pour les graphiques en bulles.

setChartType(chartType)

Représente le type de graphique d’une série. Pour plus d’informations, consultez ExcelScript.ChartType .

setDoughnutHoleSize(doughnutHoleSize)

Représente la taille du centre d’une série de graphiques en anneaux. Valide uniquement sur les graphiques en anneau et en anneau explosé. Génère une InvalidArgument erreur sur les graphiques non valides.

setExplosion(explosion)

Spécifie la valeur d’explosion d’un graphique en secteurs ou d’un graphique en anneau. Renvoie 0 (zéro) s’il n’y a aucune explosion (la pointe de la coupe est dans le centre du graphique).

setFiltered(filtered)

Spécifie si la série est filtrée. Non applicable pour les graphiques en surface.

setFirstSliceAngle(firstSliceAngle)

Spécifie l’angle de la première tranche de graphique en secteurs ou en anneau, en degrés (dans le sens des aiguilles d’une montre à partir de la verticale). S’applique uniquement aux graphiques en secteurs, graphiques en secteurs 3D et graphiques en anneaux. Peut être une valeur comprise entre 0 et 360.

setGapWidth(gapWidth)

Représente la largeur de l’intervalle d’une série de graphique. Valide uniquement sur les graphiques à barres et histogrammes, ainsi que sur des classes spécifiques de graphiques en courbes et en secteurs. Lève une exception d’argument non valide sur les graphiques non valides.

setGradientMaximumColor(gradientMaximumColor)

Spécifie la couleur de la valeur maximale d’une série de graphiques de carte de région.

setGradientMaximumType(gradientMaximumType)

Spécifie le type de valeur maximale d’une série de graphiques de carte de région.

setGradientMaximumValue(gradientMaximumValue)

Spécifie la valeur maximale d’une série de graphiques de carte de région.

setGradientMidpointColor(gradientMidpointColor)

Spécifie la couleur de la valeur milieu d’une série de graphiques de carte de région.

setGradientMidpointType(gradientMidpointType)

Spécifie le type de la valeur de point intermédiaire d’une série de graphiques de carte de région.

setGradientMidpointValue(gradientMidpointValue)

Spécifie la valeur du point médian d’une série de graphiques de carte de région.

setGradientMinimumColor(gradientMinimumColor)

Spécifie la couleur de la valeur minimale d’une série de graphiques de carte de régions.

setGradientMinimumType(gradientMinimumType)

Spécifie le type pour la valeur minimale d’une série de graphiques de carte de région.

setGradientMinimumValue(gradientMinimumValue)

Spécifie la valeur minimale d’une série de graphiques de carte de région.

setGradientStyle(gradientStyle)

Spécifie le style de dégradé de série d’un graphique de carte de région.

setHasDataLabels(hasDataLabels)

Spécifie si la série a des étiquettes de données.

setInvertColor(invertColor)

Spécifie la couleur de remplissage des points de données négatifs d’une série.

setInvertIfNegative(invertIfNegative)

True si Excel inverse le modèle dans l’élément lorsqu’il correspond à un nombre négatif.

setMarkerBackgroundColor(markerBackgroundColor)

Spécifie la couleur d’arrière-plan du marqueur d’une série de graphiques.

setMarkerForegroundColor(markerForegroundColor)

Spécifie la couleur de premier plan du marqueur d’une série de graphiques.

setMarkerSize(markerSize)

Spécifie la taille de marqueur d’une série de graphiques. La plage de tailles prise en charge est comprise entre 2 et 72. Cette méthode retourne une erreur InvalidArgument si elle est définie avec une taille en dehors de la plage prise en charge.

setMarkerStyle(markerStyle)

Spécifie le style de marqueur d’une série de graphiques. Pour plus d’informations, consultez ExcelScript.ChartMarkerStyle .

setName(name)

Spécifie le nom d’une série dans un graphique. La longueur du nom ne doit pas être supérieure à 255 caractères.

setOverlap(overlap)

Spécifie comment barres et colonnes sont positionnées. Peut être une valeur comprise entre -100 et 100. S’applique uniquement aux graphiques en barres 2D et en colonnes 2D.

setParentLabelStrategy(parentLabelStrategy)

Spécifie la zone de stratégie d’étiquette parente de série pour un graphique treemap.

setPlotOrder(plotOrder)

Spécifie l’ordre de traçage d’une série de graphiques dans le groupe de graphiques.

setSecondPlotSize(secondPlotSize)

Spécifie la taille de la section secondaire d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur, sous la forme d’un pourcentage de la taille du secteur principal. Peut être une valeur comprise entre 5 et 200.

setShowConnectorLines(showConnectorLines)

Spécifie si les lignes de connecteur sont affichées dans les graphiques en cascade.

setShowLeaderLines(showLeaderLines)

Spécifie si des lignes d’leader sont affichées pour chaque étiquette de données de la série.

setShowShadow(showShadow)

Spécifie si la série a une ombre.

setSmooth(smooth)

Spécifie si la série est lisse. Applicable uniquement aux graphiques en courbes et à nuages de points.

setSplitType(splitType)

Spécifie la façon dont les deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur sont fractionnées.

setSplitValue(splitValue)

Spécifie la valeur de seuil qui sépare deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur.

setValues(sourceData)

Définit les valeurs d’une série de graphiques. Pour les nuages de points, il fait référence aux valeurs de l’axe y.

setVaryByCategories(varyByCategories)

True si Excel affecte une couleur ou un modèle différent à chaque marqueur de données. Le graphique ne doit contenir qu’une seule série.

setXAxisValues(sourceData)

Définit les valeurs de l’axe x d’une série de graphiques.

Détails de la méthode

addChartTrendline(type)

Ajoute une nouvelle courbe de tendance à la collection de courbes de tendance.

addChartTrendline(type?: ChartTrendlineType): ChartTrendline;

Paramètres

type
ExcelScript.ChartTrendlineType

Spécifie le type de courbe de tendance. La valeur par défaut est « Linéaire ». Pour plus d’informations, consultez ExcelScript.ChartTrendline .

Retourne

delete()

Supprime la série graphique.

delete(): void;

Retourne

void

Exemples

/**
 * This sample creates a bubble chart and manually adds each series.
 */
function main(workbook: ExcelScript.Workbook) {
  const sheet = workbook.getActiveWorksheet();
  
  // Add sample data.
  const data = [
    ["Product", "Price ($)", "Quality Score", "Market Share"],
    ["Keyboards", 85, 88, 25],
    ["Mice", 120, 80, 20]
  ];
  const dataRange = sheet.getRange("A1:D3");
  dataRange.setValues(data);
  
  // Create bubble chart - start with headers to create empty chart.
  const chart = sheet.addChart(
    ExcelScript.ChartType.bubble,
    sheet.getRange("B1:D1")
  );
  chart.setPosition("A5");
  chart.getTitle().setText("Product Analysis");
  
  // Remove any default series that were created.
  while (chart.getSeries().length > 0) {
    chart.getSeries()[0].delete();
  }
  
  // Add each product as its own series.
  for (let i = 2; i <= 3; i++) {
    const productName = sheet.getRange(`A${i}`).getValue() as string;
    const newSeries = chart.addChartSeries(productName);
    newSeries.setXAxisValues(sheet.getRange(`B${i}:B${i}`));
    newSeries.setValues(sheet.getRange(`C${i}:C${i}`));
    newSeries.setBubbleSizes(sheet.getRange(`D${i}:D${i}`));
  }
}

getAxisGroup()

Spécifie le groupe pour la série spécifiée.

getAxisGroup(): ChartAxisGroup;

Retourne

getBinOptions()

Encapsule les options bin uniquement pour les histogrammes et graphiques de pareto.

getBinOptions(): ChartBinOptions;

Retourne

getBoxwhiskerOptions()

Résume les options pour le graphique de zone et valeur.

getBoxwhiskerOptions(): ChartBoxwhiskerOptions;

Retourne

getBubbleScale()

Peut être une valeur d’entier entre 0 (zéro) et 300 correspondant à un pourcentage de la taille par défaut. Cette propriété s'applique uniquement aux graphiques en bulles.

getBubbleScale(): number;

Retourne

number

getChartTrendline(index)

Obtient un objet de courbe de tendance par index, qui est l’ordre d’insertion dans le tableau d’éléments.

getChartTrendline(index: number): ChartTrendline;

Paramètres

index

number

Représente l’ordre d’insertion dans le tableau d’éléments.

Retourne

getChartType()

Représente le type de graphique d’une série. Pour plus d’informations, consultez ExcelScript.ChartType .

getChartType(): ChartType;

Retourne

getDataLabels()

Représente une collection de toutes les étiquettes de données de la série.

getDataLabels(): ChartDataLabels;

Retourne

Exemples

/**
 * This sample accesses and configures data labels for a series.
 * 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 data labels via series.
  const series = chart.getSeries()[0];
  const dataLabels = series.getDataLabels();
  dataLabels.setShowPercentage(true);
  dataLabels.setShowValue(false);
}

getDimensionDataSourceString(dimension)

Obtient la représentation sous forme de chaîne de la source de données de la série de graphiques. La représentation sous forme de chaîne peut être une information telle qu’une adresse de cellule.

getDimensionDataSourceString(dimension: ChartSeriesDimension): string;

Paramètres

dimension
ExcelScript.ChartSeriesDimension

Dimension de l’axe d’où proviennent les données.

Retourne

string

getDimensionDataSourceType(dimension)

Obtient le type de source de données de la série de graphiques.

getDimensionDataSourceType(
            dimension: ChartSeriesDimension
        ): ChartDataSourceType;

Paramètres

dimension
ExcelScript.ChartSeriesDimension

Dimension de l’axe d’où proviennent les données.

Retourne

getDimensionValues(dimension)

Obtient les valeurs d’une dimension unique de la série de graphiques. Il peut s’agir de valeurs de catégorie ou de données, selon la dimension spécifiée et la façon dont les données sont mappées pour la série de graphiques.

getDimensionValues(dimension: ChartSeriesDimension): string[];

Paramètres

dimension
ExcelScript.ChartSeriesDimension

Dimension de l’axe d’où proviennent les données.

Retourne

string[]

getDoughnutHoleSize()

Représente la taille du centre d’une série de graphiques en anneaux. Valide uniquement sur les graphiques en anneau et en anneau explosé. Génère une InvalidArgument erreur sur les graphiques non valides.

getDoughnutHoleSize(): number;

Retourne

number

getExplosion()

Spécifie la valeur d’explosion d’un graphique en secteurs ou d’un graphique en anneau. Renvoie 0 (zéro) s’il n’y a aucune explosion (la pointe de la coupe est dans le centre du graphique).

getExplosion(): number;

Retourne

number

getFiltered()

Spécifie si la série est filtrée. Non applicable pour les graphiques en surface.

getFiltered(): boolean;

Retourne

boolean

getFirstSliceAngle()

Spécifie l’angle de la première tranche de graphique en secteurs ou en anneau, en degrés (dans le sens des aiguilles d’une montre à partir de la verticale). S’applique uniquement aux graphiques en secteurs, graphiques en secteurs 3D et graphiques en anneaux. Peut être une valeur comprise entre 0 et 360.

getFirstSliceAngle(): number;

Retourne

number

getFormat()

Représente le format d’une série de graphique, à savoir le format de remplissage et des lignes.

getFormat(): ChartSeriesFormat;

Retourne

Exemples

/**
 * This sample gets the series format to customize appearance.
 * 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];
  
  // Customize the series color.
  const series = chart.getSeries()[0];
  const format = series.getFormat();
  format.getFill().setSolidColor("#B0C4DE");
}

getGapWidth()

Représente la largeur de l’intervalle d’une série de graphique. Valide uniquement sur les graphiques à barres et histogrammes, ainsi que sur des classes spécifiques de graphiques en courbes et en secteurs. Lève une exception d’argument non valide sur les graphiques non valides.

getGapWidth(): number;

Retourne

number

getGradientMaximumColor()

Spécifie la couleur de la valeur maximale d’une série de graphiques de carte de région.

getGradientMaximumColor(): string;

Retourne

string

getGradientMaximumType()

Spécifie le type de valeur maximale d’une série de graphiques de carte de région.

getGradientMaximumType(): ChartGradientStyleType;

Retourne

getGradientMaximumValue()

Spécifie la valeur maximale d’une série de graphiques de carte de région.

getGradientMaximumValue(): number;

Retourne

number

getGradientMidpointColor()

Spécifie la couleur de la valeur milieu d’une série de graphiques de carte de région.

getGradientMidpointColor(): string;

Retourne

string

getGradientMidpointType()

Spécifie le type de la valeur de point intermédiaire d’une série de graphiques de carte de région.

getGradientMidpointType(): ChartGradientStyleType;

Retourne

getGradientMidpointValue()

Spécifie la valeur du point médian d’une série de graphiques de carte de région.

getGradientMidpointValue(): number;

Retourne

number

getGradientMinimumColor()

Spécifie la couleur de la valeur minimale d’une série de graphiques de carte de régions.

getGradientMinimumColor(): string;

Retourne

string

getGradientMinimumType()

Spécifie le type pour la valeur minimale d’une série de graphiques de carte de région.

getGradientMinimumType(): ChartGradientStyleType;

Retourne

getGradientMinimumValue()

Spécifie la valeur minimale d’une série de graphiques de carte de région.

getGradientMinimumValue(): number;

Retourne

number

getGradientStyle()

Spécifie le style de dégradé de série d’un graphique de carte de région.

getGradientStyle(): ChartGradientStyle;

Retourne

getHasDataLabels()

Spécifie si la série a des étiquettes de données.

getHasDataLabels(): boolean;

Retourne

boolean

getInvertColor()

Spécifie la couleur de remplissage des points de données négatifs d’une série.

getInvertColor(): string;

Retourne

string

getInvertIfNegative()

True si Excel inverse le modèle dans l’élément lorsqu’il correspond à un nombre négatif.

getInvertIfNegative(): boolean;

Retourne

boolean

getMapOptions()

Encapsule les options pour le graphique carte de région.

getMapOptions(): ChartMapOptions;

Retourne

getMarkerBackgroundColor()

Spécifie la couleur d’arrière-plan du marqueur d’une série de graphiques.

getMarkerBackgroundColor(): string;

Retourne

string

getMarkerForegroundColor()

Spécifie la couleur de premier plan du marqueur d’une série de graphiques.

getMarkerForegroundColor(): string;

Retourne

string

getMarkerSize()

Spécifie la taille de marqueur d’une série de graphiques. La plage de tailles prise en charge est comprise entre 2 et 72. Cette méthode retourne une erreur InvalidArgument si elle est définie avec une taille en dehors de la plage prise en charge.

getMarkerSize(): number;

Retourne

number

getMarkerStyle()

Spécifie le style de marqueur d’une série de graphiques. Pour plus d’informations, consultez ExcelScript.ChartMarkerStyle .

getMarkerStyle(): ChartMarkerStyle;

Retourne

getName()

Spécifie le nom d’une série dans un graphique. La longueur du nom ne doit pas être supérieure à 255 caractères.

getName(): string;

Retourne

string

Exemples

/**
 * This sample logs the names of each of the chart series 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");

  // Log the name of each chart series in the chart.
  let seriesList = chart.getSeries();
  seriesList.forEach((series) => {
    console.log(series.getName());
  });
}

getOverlap()

Spécifie comment barres et colonnes sont positionnées. Peut être une valeur comprise entre -100 et 100. S’applique uniquement aux graphiques en barres 2D et en colonnes 2D.

getOverlap(): number;

Retourne

number

getParentLabelStrategy()

Spécifie la zone de stratégie d’étiquette parente de série pour un graphique treemap.

getParentLabelStrategy(): ChartParentLabelStrategy;

Retourne

getPlotOrder()

Spécifie l’ordre de traçage d’une série de graphiques dans le groupe de graphiques.

getPlotOrder(): number;

Retourne

number

getPoints()

Retourne une collection de tous les points de la série.

getPoints(): ChartPoint[];

Retourne

getSecondPlotSize()

Spécifie la taille de la section secondaire d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur, sous la forme d’un pourcentage de la taille du secteur principal. Peut être une valeur comprise entre 5 et 200.

getSecondPlotSize(): number;

Retourne

number

getShowConnectorLines()

Spécifie si les lignes de connecteur sont affichées dans les graphiques en cascade.

getShowConnectorLines(): boolean;

Retourne

boolean

getShowLeaderLines()

Spécifie si des lignes d’leader sont affichées pour chaque étiquette de données de la série.

getShowLeaderLines(): boolean;

Retourne

boolean

getShowShadow()

Spécifie si la série a une ombre.

getShowShadow(): boolean;

Retourne

boolean

getSmooth()

Spécifie si la série est lisse. Applicable uniquement aux graphiques en courbes et à nuages de points.

getSmooth(): boolean;

Retourne

boolean

getSplitType()

Spécifie la façon dont les deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur sont fractionnées.

getSplitType(): ChartSplitType;

Retourne

getSplitValue()

Spécifie la valeur de seuil qui sépare deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur.

getSplitValue(): number;

Retourne

number

getTrendlines()

Collection de courbes de tendance dans la série.

getTrendlines(): ChartTrendline[];

Retourne

getVaryByCategories()

True si Excel affecte une couleur ou un modèle différent à chaque marqueur de données. Le graphique ne doit contenir qu’une seule série.

getVaryByCategories(): boolean;

Retourne

boolean

getXErrorBars()

Représente l’objet de la barre d’erreur pour une série de graphique.

getXErrorBars(): ChartErrorBars;

Retourne

getYErrorBars()

Représente l’objet de la barre d’erreur pour une série de graphique.

getYErrorBars(): ChartErrorBars;

Retourne

Exemples

/**
 * This script adds error bars for the standard error of each chart series point.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range for the chart.
  const worksheet = workbook.getWorksheet("Sample");
  const dataRange = worksheet.getRange("A1:B15");

  // Create a line chart.
  const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);

  // For each series, add error bars for the standard error on each point
  const allSeries = chart.getSeries();
  allSeries.forEach((series) => {
    series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
    series.getYErrorBars().setVisible(true);
  });
}

setAxisGroup(axisGroup)

Spécifie le groupe pour la série spécifiée.

setAxisGroup(axisGroup: ChartAxisGroup): void;

Paramètres

Retourne

void

setBubbleScale(bubbleScale)

Peut être une valeur d’entier entre 0 (zéro) et 300 correspondant à un pourcentage de la taille par défaut. Cette propriété s'applique uniquement aux graphiques en bulles.

setBubbleScale(bubbleScale: number): void;

Paramètres

bubbleScale

number

Retourne

void

setBubbleSizes(sourceData)

Définit les tailles de bulles d’une série de graphiques. Fonctionne uniquement pour les graphiques en bulles.

setBubbleSizes(sourceData: Range): void;

Paramètres

sourceData
ExcelScript.Range

Objet Range correspondant aux données sources.

Retourne

void

Exemples

/**
 * This sample sets bubble sizes for a bubble chart series.
 */
function main(workbook: ExcelScript.Workbook) {
  const sheet = workbook.getActiveWorksheet();
  
  // Add sample data.
  const data = [
    ["Product", "Price ($)", "Quality Score", "Market Share"],
    ["Product A", 85, 88, 25]
  ];
  const dataRange = sheet.getRange("A1:D2");
  dataRange.setValues(data);
  
  // Create bubble chart.
  const chart = sheet.addChart(
    ExcelScript.ChartType.bubble,
    sheet.getRange("B1:D1")
  );
  chart.setPosition("A4");
  
  // Remove default series.
  while (chart.getSeries().length > 0) {
    chart.getSeries()[0].delete();
  }
  
  // Add series with bubble sizes.
  const newSeries = chart.addChartSeries("Product A");
  newSeries.setXAxisValues(sheet.getRange("B2:B2"));
  newSeries.setValues(sheet.getRange("C2:C2"));
  newSeries.setBubbleSizes(sheet.getRange("D2:D2"));
}

setChartType(chartType)

Représente le type de graphique d’une série. Pour plus d’informations, consultez ExcelScript.ChartType .

setChartType(chartType: ChartType): void;

Paramètres

Retourne

void

setDoughnutHoleSize(doughnutHoleSize)

Représente la taille du centre d’une série de graphiques en anneaux. Valide uniquement sur les graphiques en anneau et en anneau explosé. Génère une InvalidArgument erreur sur les graphiques non valides.

setDoughnutHoleSize(doughnutHoleSize: number): void;

Paramètres

doughnutHoleSize

number

Retourne

void

setExplosion(explosion)

Spécifie la valeur d’explosion d’un graphique en secteurs ou d’un graphique en anneau. Renvoie 0 (zéro) s’il n’y a aucune explosion (la pointe de la coupe est dans le centre du graphique).

setExplosion(explosion: number): void;

Paramètres

explosion

number

Retourne

void

setFiltered(filtered)

Spécifie si la série est filtrée. Non applicable pour les graphiques en surface.

setFiltered(filtered: boolean): void;

Paramètres

filtered

boolean

Retourne

void

setFirstSliceAngle(firstSliceAngle)

Spécifie l’angle de la première tranche de graphique en secteurs ou en anneau, en degrés (dans le sens des aiguilles d’une montre à partir de la verticale). S’applique uniquement aux graphiques en secteurs, graphiques en secteurs 3D et graphiques en anneaux. Peut être une valeur comprise entre 0 et 360.

setFirstSliceAngle(firstSliceAngle: number): void;

Paramètres

firstSliceAngle

number

Retourne

void

setGapWidth(gapWidth)

Représente la largeur de l’intervalle d’une série de graphique. Valide uniquement sur les graphiques à barres et histogrammes, ainsi que sur des classes spécifiques de graphiques en courbes et en secteurs. Lève une exception d’argument non valide sur les graphiques non valides.

setGapWidth(gapWidth: number): void;

Paramètres

gapWidth

number

Retourne

void

setGradientMaximumColor(gradientMaximumColor)

Spécifie la couleur de la valeur maximale d’une série de graphiques de carte de région.

setGradientMaximumColor(gradientMaximumColor: string): void;

Paramètres

gradientMaximumColor

string

Retourne

void

setGradientMaximumType(gradientMaximumType)

Spécifie le type de valeur maximale d’une série de graphiques de carte de région.

setGradientMaximumType(
            gradientMaximumType: ChartGradientStyleType
        ): void;

Paramètres

Retourne

void

setGradientMaximumValue(gradientMaximumValue)

Spécifie la valeur maximale d’une série de graphiques de carte de région.

setGradientMaximumValue(gradientMaximumValue: number): void;

Paramètres

gradientMaximumValue

number

Retourne

void

setGradientMidpointColor(gradientMidpointColor)

Spécifie la couleur de la valeur milieu d’une série de graphiques de carte de région.

setGradientMidpointColor(gradientMidpointColor: string): void;

Paramètres

gradientMidpointColor

string

Retourne

void

setGradientMidpointType(gradientMidpointType)

Spécifie le type de la valeur de point intermédiaire d’une série de graphiques de carte de région.

setGradientMidpointType(
            gradientMidpointType: ChartGradientStyleType
        ): void;

Paramètres

gradientMidpointType
ExcelScript.ChartGradientStyleType

Retourne

void

setGradientMidpointValue(gradientMidpointValue)

Spécifie la valeur du point médian d’une série de graphiques de carte de région.

setGradientMidpointValue(gradientMidpointValue: number): void;

Paramètres

gradientMidpointValue

number

Retourne

void

setGradientMinimumColor(gradientMinimumColor)

Spécifie la couleur de la valeur minimale d’une série de graphiques de carte de régions.

setGradientMinimumColor(gradientMinimumColor: string): void;

Paramètres

gradientMinimumColor

string

Retourne

void

setGradientMinimumType(gradientMinimumType)

Spécifie le type pour la valeur minimale d’une série de graphiques de carte de région.

setGradientMinimumType(
            gradientMinimumType: ChartGradientStyleType
        ): void;

Paramètres

Retourne

void

setGradientMinimumValue(gradientMinimumValue)

Spécifie la valeur minimale d’une série de graphiques de carte de région.

setGradientMinimumValue(gradientMinimumValue: number): void;

Paramètres

gradientMinimumValue

number

Retourne

void

setGradientStyle(gradientStyle)

Spécifie le style de dégradé de série d’un graphique de carte de région.

setGradientStyle(gradientStyle: ChartGradientStyle): void;

Paramètres

Retourne

void

setHasDataLabels(hasDataLabels)

Spécifie si la série a des étiquettes de données.

setHasDataLabels(hasDataLabels: boolean): void;

Paramètres

hasDataLabels

boolean

Retourne

void

Exemples

/**
 * This sample enables data labels on a chart series.
 * 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];
  
  // Enable data labels on the series.
  const series = chart.getSeries()[0];
  series.setHasDataLabels(true);
}

setInvertColor(invertColor)

Spécifie la couleur de remplissage des points de données négatifs d’une série.

setInvertColor(invertColor: string): void;

Paramètres

invertColor

string

Retourne

void

setInvertIfNegative(invertIfNegative)

True si Excel inverse le modèle dans l’élément lorsqu’il correspond à un nombre négatif.

setInvertIfNegative(invertIfNegative: boolean): void;

Paramètres

invertIfNegative

boolean

Retourne

void

setMarkerBackgroundColor(markerBackgroundColor)

Spécifie la couleur d’arrière-plan du marqueur d’une série de graphiques.

setMarkerBackgroundColor(markerBackgroundColor: string): void;

Paramètres

markerBackgroundColor

string

Retourne

void

setMarkerForegroundColor(markerForegroundColor)

Spécifie la couleur de premier plan du marqueur d’une série de graphiques.

setMarkerForegroundColor(markerForegroundColor: string): void;

Paramètres

markerForegroundColor

string

Retourne

void

setMarkerSize(markerSize)

Spécifie la taille de marqueur d’une série de graphiques. La plage de tailles prise en charge est comprise entre 2 et 72. Cette méthode retourne une erreur InvalidArgument si elle est définie avec une taille en dehors de la plage prise en charge.

setMarkerSize(markerSize: number): void;

Paramètres

markerSize

number

Retourne

void

Exemples

/**
 * This sample sets the marker size for a line chart series.
 * This assumes the active worksheet has a line chart with markers.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the marker size for all series.
  const series = chart.getSeries();
  series.forEach((s) => {
    s.setMarkerSize(8);
  });
}

setMarkerStyle(markerStyle)

Spécifie le style de marqueur d’une série de graphiques. Pour plus d’informations, consultez ExcelScript.ChartMarkerStyle .

setMarkerStyle(markerStyle: ChartMarkerStyle): void;

Paramètres

Retourne

void

Exemples

/**
 * This sample sets the marker style for a line chart series.
 * This assumes the active worksheet has a line chart with markers.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the marker style to circle.
  const series = chart.getSeries()[0];
  series.setMarkerStyle(ExcelScript.ChartMarkerStyle.circle);
}

setName(name)

Spécifie le nom d’une série dans un graphique. La longueur du nom ne doit pas être supérieure à 255 caractères.

setName(name: string): void;

Paramètres

name

string

Retourne

void

Exemples

/**
 * This sample sets the name of chart series.
 * This assumes the active worksheet has a chart with at least 4 series.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set names for all series.
  const seriesCollection = chart.getSeries();
  seriesCollection[0].setName("Solar");
  seriesCollection[1].setName("Wind");
  seriesCollection[2].setName("Hydro");
  seriesCollection[3].setName("Geothermal");
}

setOverlap(overlap)

Spécifie comment barres et colonnes sont positionnées. Peut être une valeur comprise entre -100 et 100. S’applique uniquement aux graphiques en barres 2D et en colonnes 2D.

setOverlap(overlap: number): void;

Paramètres

overlap

number

Retourne

void

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

setParentLabelStrategy(parentLabelStrategy)

Spécifie la zone de stratégie d’étiquette parente de série pour un graphique treemap.

setParentLabelStrategy(
            parentLabelStrategy: ChartParentLabelStrategy
        ): void;

Paramètres

Retourne

void

setPlotOrder(plotOrder)

Spécifie l’ordre de traçage d’une série de graphiques dans le groupe de graphiques.

setPlotOrder(plotOrder: number): void;

Paramètres

plotOrder

number

Retourne

void

setSecondPlotSize(secondPlotSize)

Spécifie la taille de la section secondaire d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur, sous la forme d’un pourcentage de la taille du secteur principal. Peut être une valeur comprise entre 5 et 200.

setSecondPlotSize(secondPlotSize: number): void;

Paramètres

secondPlotSize

number

Retourne

void

setShowConnectorLines(showConnectorLines)

Spécifie si les lignes de connecteur sont affichées dans les graphiques en cascade.

setShowConnectorLines(showConnectorLines: boolean): void;

Paramètres

showConnectorLines

boolean

Retourne

void

setShowLeaderLines(showLeaderLines)

Spécifie si des lignes d’leader sont affichées pour chaque étiquette de données de la série.

setShowLeaderLines(showLeaderLines: boolean): void;

Paramètres

showLeaderLines

boolean

Retourne

void

setShowShadow(showShadow)

Spécifie si la série a une ombre.

setShowShadow(showShadow: boolean): void;

Paramètres

showShadow

boolean

Retourne

void

setSmooth(smooth)

Spécifie si la série est lisse. Applicable uniquement aux graphiques en courbes et à nuages de points.

setSmooth(smooth: boolean): void;

Paramètres

smooth

boolean

Retourne

void

setSplitType(splitType)

Spécifie la façon dont les deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur sont fractionnées.

setSplitType(splitType: ChartSplitType): void;

Paramètres

Retourne

void

setSplitValue(splitValue)

Spécifie la valeur de seuil qui sépare deux sections d’un graphique en secteurs de secteur ou d’un graphique en barres de secteur.

setSplitValue(splitValue: number): void;

Paramètres

splitValue

number

Retourne

void

setValues(sourceData)

Définit les valeurs d’une série de graphiques. Pour les nuages de points, il fait référence aux valeurs de l’axe y.

setValues(sourceData: Range): void;

Paramètres

sourceData
ExcelScript.Range

Objet Range correspondant aux données sources.

Retourne

void

setVaryByCategories(varyByCategories)

True si Excel affecte une couleur ou un modèle différent à chaque marqueur de données. Le graphique ne doit contenir qu’une seule série.

setVaryByCategories(varyByCategories: boolean): void;

Paramètres

varyByCategories

boolean

Retourne

void

setXAxisValues(sourceData)

Définit les valeurs de l’axe x d’une série de graphiques.

setXAxisValues(sourceData: Range): void;

Paramètres

sourceData
ExcelScript.Range

Objet Range correspondant aux données sources.

Retourne

void