ExcelScript.ChartSeries interface

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

addChartTrendline(type?: ChartTrendlineType): ChartTrendline;

Paramètres

Retours

Supprime la série graphique.

delete(): void;

Retours

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

getAxisGroup(): ChartAxisGroup;

Retours

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

getBinOptions(): ChartBinOptions;

Retours

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

getBoxwhiskerOptions(): ChartBoxwhiskerOptions;

Retours

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;

Retours

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

Retours

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

getChartType(): ChartType;

Retours

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

getDataLabels(): ChartDataLabels;

Retours

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

Retours

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

getDimensionDataSourceType(
            dimension: ChartSeriesDimension
        ): ChartDataSourceType;

Paramètres

Retours

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

Retours

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;

Retours

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;

Retours

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

getFiltered(): boolean;

Retours

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;

Retours

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

getFormat(): ChartSeriesFormat;

Retours

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;

Retours

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

getGradientMaximumColor(): string;

Retours

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

getGradientMaximumType(): ChartGradientStyleType;

Retours

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

getGradientMaximumValue(): number;

Retours

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

getGradientMidpointColor(): string;

Retours

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

getGradientMidpointType(): ChartGradientStyleType;

Retours

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

getGradientMidpointValue(): number;

Retours

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

getGradientMinimumColor(): string;

Retours

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

getGradientMinimumType(): ChartGradientStyleType;

Retours

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

getGradientMinimumValue(): number;

Retours

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

getGradientStyle(): ChartGradientStyle;

Retours

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

getHasDataLabels(): boolean;

Retours

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

getInvertColor(): string;

Retours

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

getInvertIfNegative(): boolean;

Retours

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

getMapOptions(): ChartMapOptions;

Retours

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

getMarkerBackgroundColor(): string;

Retours

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

getMarkerForegroundColor(): string;

Retours

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;

Retours

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

getMarkerStyle(): ChartMarkerStyle;

Retours

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;

Retours

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

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;

Retours

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

getParentLabelStrategy(): ChartParentLabelStrategy;

Retours

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

getPlotOrder(): number;

Retours

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

getPoints(): ChartPoint[];

Retours

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;

Retours

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

getShowConnectorLines(): boolean;

Retours

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

getShowLeaderLines(): boolean;

Retours

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

getShowShadow(): boolean;

Retours

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

getSmooth(): boolean;

Retours

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;

Retours

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;

Retours

Collection de courbes de tendance dans la série.

getTrendlines(): ChartTrendline[];

Retours

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;

Retours

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

getXErrorBars(): ChartErrorBars;

Retours

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

getYErrorBars(): ChartErrorBars;

Retours

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

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

setAxisGroup(axisGroup: ChartAxisGroup): void;

Paramètres

Retours

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

Retours

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

Retours

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

setChartType(chartType: ChartType): void;

Paramètres

Retours

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

Retours

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

Retours

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

setFiltered(filtered: boolean): void;

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

setGradientMaximumType(
            gradientMaximumType: ChartGradientStyleType
        ): void;

Paramètres

Retours

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

setGradientMaximumValue(gradientMaximumValue: number): void;

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

setGradientMinimumValue(gradientMinimumValue: number): void;

Paramètres

Retours

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

setGradientStyle(gradientStyle: ChartGradientStyle): void;

Paramètres

Retours

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

setHasDataLabels(hasDataLabels: boolean): void;

Paramètres

Retours

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

setInvertColor(invertColor: string): void;

Paramètres

Retours

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

setInvertIfNegative(invertIfNegative: boolean): void;

Paramètres

Retours

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

setMarkerBackgroundColor(markerBackgroundColor: string): void;

Paramètres

Retours

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

setMarkerForegroundColor(markerForegroundColor: string): void;

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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 la zone de stratégie d’étiquette parente de série pour un graphique treemap.

setParentLabelStrategy(
            parentLabelStrategy: ChartParentLabelStrategy
        ): void;

Paramètres

Retours

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

setPlotOrder(plotOrder: number): void;

Paramètres

Retours

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

Retours

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

setShowConnectorLines(showConnectorLines: boolean): void;

Paramètres

Retours

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

Retours

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

setShowShadow(showShadow: boolean): void;

Paramètres

Retours

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

setSmooth(smooth: boolean): void;

Paramètres

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

setXAxisValues(sourceData: Range): void;

Paramètres

Retours