Excel.ChartSeries class

Représente une série dans un graphique.

Extends

Remarques

Jeu d’API : ExcelApi 1.1

Utilisateur

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code adds data labels to the chart and positions them to demonstrate leader lines.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  
  // Enable data labels for the series. Leader lines are enabled by default.
  series.hasDataLabels = true;
  series.points.load("items");
  await context.sync();
  
  // Load the top position for each data label.
  series.points.items.forEach((point) => point.dataLabel.load("top"));
  await context.sync();

  // Move some data labels to create distance from their chart points.
  const point1 = series.points.items[1]; 
  const point2 = series.points.items[2]; 
  point1.dataLabel.top -= 50; 
  point2.dataLabel.top += 50;
  
  // Format the data labels.
  series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle;
  series.dataLabels.showCategoryName = true;
  series.dataLabels.format.border.weight = 1;
  
  await context.sync();
});

Propriétés

axisGroup

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

binOptions

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

boxwhiskerOptions

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

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.

chartType

Représente le type de graphique d’une série. Pour Excel.ChartType plus de détails.

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

dataLabels

Représente un ensemble de toutes les étiquettes de données de la série.

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 éclaté. Génère une InvalidArgument erreur sur les graphiques non valides.

explosion

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

filtered

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

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.

format

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

gapWidth

Représente la largeur de l’intervalle d’une série de graphique. Valide uniquement sur les graphiques à barres et en 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.

gradientMaximumColor

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

gradientMaximumType

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

gradientMaximumValue

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

gradientMidpointColor

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

gradientMidpointType

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

gradientMidpointValue

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

gradientMinimumColor

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

gradientMinimumType

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

gradientMinimumValue

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

gradientStyle

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

hasDataLabels

Indique si la série comporte des étiquettes de données.

invertColor

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

invertIfNegative

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

mapOptions

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

markerBackgroundColor

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

markerForegroundColor

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

markerSize

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

markerStyle

Spécifie le style de marqueur d’une série de graphiques. Pour Excel.ChartMarkerStyle plus de détails.

name

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

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.

parentLabelStrategy

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

plotOrder

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

points

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

secondPlotSize

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

showConnectorLines

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

showLeaderLines

Indique si des lignes de repère sont affichées pour chaque étiquette de données dans la série.

showShadow

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

smooth

Indique si la série est lisse. S’applique uniquement aux graphiques en courbes et en nuages de points.

splitType

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

splitValue

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

trendlines

Collection de courbes de tendance de la série.

varyByCategories

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

xErrorBars

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

yErrorBars

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

Méthodes

delete()

Supprime la série graphique.

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)

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.

getDimensionDataSourceType(dimension)

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

getDimensionValues(dimension)

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

getDimensionValues(dimension)

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

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

setBubbleSizes(sourceData)

Définit la taille des bulles pour une série de graphiques. Fonctionne uniquement pour les graphiques en bulles.

setValues(sourceData)

Définit les valeurs d’une série de graphiques. Pour les graphiques en nuages, il s’agit des valeurs de l’axe Y.

setXAxisValues(sourceData)

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

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ChartSeries est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartSeriesDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

axisGroup

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

axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

Valeur de propriété

Excel.ChartAxisGroup | "Primary" | "Secondary"

Remarques

Jeu d’API : ExcelApi 1.8

binOptions

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

readonly binOptions: Excel.ChartBinOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

boxwhiskerOptions

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

readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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.

bubbleScale: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

chartType

Représente le type de graphique d’une série. Pour Excel.ChartType plus de détails.

chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";

Valeur de propriété

Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx"

Remarques

Jeu d’API : ExcelApi 1.7

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

dataLabels

Représente un ensemble de toutes les étiquettes de données de la série.

readonly dataLabels: Excel.ChartDataLabels;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

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 éclaté. Génère une InvalidArgument erreur sur les graphiques non valides.

doughnutHoleSize: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.7

explosion

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

explosion: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

filtered

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

filtered: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

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.

firstSliceAngle: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

format

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

readonly format: Excel.ChartSeriesFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

gapWidth

Représente la largeur de l’intervalle d’une série de graphique. Valide uniquement sur les graphiques à barres et en 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.

gapWidth: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.7

gradientMaximumColor

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

gradientMaximumColor: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

gradientMaximumType

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

gradientMaximumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";

Valeur de propriété

Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"

Remarques

Jeu d’API : ExcelApi 1.9

gradientMaximumValue

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

gradientMaximumValue: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

gradientMidpointColor

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

gradientMidpointColor: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

gradientMidpointType

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

gradientMidpointType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";

Valeur de propriété

Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"

Remarques

Jeu d’API : ExcelApi 1.9

gradientMidpointValue

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

gradientMidpointValue: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

gradientMinimumColor

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

gradientMinimumColor: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

gradientMinimumType

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

gradientMinimumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";

Valeur de propriété

Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"

Remarques

Jeu d’API : ExcelApi 1.9

gradientMinimumValue

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

gradientMinimumValue: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

gradientStyle

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

gradientStyle: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor";

Valeur de propriété

Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"

Remarques

Jeu d’API : ExcelApi 1.9

hasDataLabels

Indique si la série comporte des étiquettes de données.

hasDataLabels: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code adds data labels to the chart and positions them to demonstrate leader lines.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  
  // Enable data labels for the series. Leader lines are enabled by default.
  series.hasDataLabels = true;
  series.points.load("items");
  await context.sync();
  
  // Load the top position for each data label.
  series.points.items.forEach((point) => point.dataLabel.load("top"));
  await context.sync();

  // Move some data labels to create distance from their chart points.
  const point1 = series.points.items[1]; 
  const point2 = series.points.items[2]; 
  point1.dataLabel.top -= 50; 
  point2.dataLabel.top += 50;
  
  // Format the data labels.
  series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle;
  series.dataLabels.showCategoryName = true;
  series.dataLabels.format.border.weight = 1;
  
  await context.sync();
});

invertColor

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

invertColor: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

invertIfNegative

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

invertIfNegative: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.8

mapOptions

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

readonly mapOptions: Excel.ChartMapOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

markerBackgroundColor

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

markerBackgroundColor: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 
  
    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerForegroundColor

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

markerForegroundColor: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 
  
    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerSize

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

markerSize: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 
  
    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerStyle

Spécifie le style de marqueur d’une série de graphiques. Pour Excel.ChartMarkerStyle plus de détails.

markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";

Valeur de propriété

Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 
  
    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

name

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

name: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.1

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.

overlap: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

parentLabelStrategy

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

parentLabelStrategy: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping";

Valeur de propriété

Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"

Remarques

Jeu d’API : ExcelApi 1.9

plotOrder

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

plotOrder: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.7

points

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

readonly points: Excel.ChartPointsCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code adds data labels to the chart and positions them to demonstrate leader lines.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  
  // Enable data labels for the series. Leader lines are enabled by default.
  series.hasDataLabels = true;
  series.points.load("items");
  await context.sync();
  
  // Load the top position for each data label.
  series.points.items.forEach((point) => point.dataLabel.load("top"));
  await context.sync();

  // Move some data labels to create distance from their chart points.
  const point1 = series.points.items[1]; 
  const point2 = series.points.items[2]; 
  point1.dataLabel.top -= 50; 
  point2.dataLabel.top += 50;
  
  // Format the data labels.
  series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle;
  series.dataLabels.showCategoryName = true;
  series.dataLabels.format.border.weight = 1;
  
  await context.sync();
});

secondPlotSize

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

secondPlotSize: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.8

showConnectorLines

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

showConnectorLines: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

showLeaderLines

Indique si des lignes de repère sont affichées pour chaque étiquette de données dans la série.

showLeaderLines: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code disables leader lines for chart data labels.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  const dataLabels = series.dataLabels;
  
  // Disable leader lines.
  dataLabels.showLeaderLines = false;
  
  await context.sync();
});

showShadow

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

showShadow: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

smooth

Indique si la série est lisse. S’applique uniquement aux graphiques en courbes et en nuages de points.

smooth: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

splitType

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

splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit";

Valeur de propriété

Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"

Remarques

Jeu d’API : ExcelApi 1.8

splitValue

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

splitValue: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

trendlines

Collection de courbes de tendance de la série.

readonly trendlines: Excel.ChartTrendlineCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

varyByCategories

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

varyByCategories: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.8

xErrorBars

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

readonly xErrorBars: Excel.ChartErrorBars;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

yErrorBars

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

readonly yErrorBars: Excel.ChartErrorBars;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Détails de la méthode

delete()

Supprime la série graphique.

delete(): void;

Retours

void

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");
  const seriesCollection = sheet.charts.getItemAt(0).series;
  seriesCollection.load("count");
  await context.sync();

  if (seriesCollection.count > 0) {
    const series = seriesCollection.getItemAt(0);

    // Delete the first series.
    series.delete();
  }

  await context.sync();
});

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: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string>;

Paramètres

dimension
Excel.ChartSeriesDimension

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

Retours

Remarques

Jeu d’API : ExcelApi 1.15

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml

// This function retrieves the data source information of a chart series in the Sample worksheet.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  // Get the first chart series from the first chart on the worksheet.
  const seriesCollection = sheet.charts.getItemAt(0).series;
  const series = seriesCollection.getItemAt(0);

  // Get the series data source string and type values. 
  const dataSourceString = series.getDimensionDataSourceString("Values");
  const dataSourceType = series.getDimensionDataSourceType("Values");

  series.load("name");
  await context.sync();
  
  // Log the data source information to the console.
  console.log(series.name + " data source string: " + dataSourceString.value);
  console.log(series.name + " data source type: " + dataSourceType.value);
});

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: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string>;

Paramètres

dimension

"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"

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

Retours

Remarques

Jeu d’API : ExcelApi 1.15

getDimensionDataSourceType(dimension)

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

getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;

Paramètres

dimension
Excel.ChartSeriesDimension

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

Retours

Remarques

Jeu d’API : ExcelApi 1.15

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml

// This function retrieves the data source information of a chart series in the Sample worksheet.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  // Get the first chart series from the first chart on the worksheet.
  const seriesCollection = sheet.charts.getItemAt(0).series;
  const series = seriesCollection.getItemAt(0);

  // Get the series data source string and type values. 
  const dataSourceString = series.getDimensionDataSourceString("Values");
  const dataSourceType = series.getDimensionDataSourceType("Values");

  series.load("name");
  await context.sync();
  
  // Log the data source information to the console.
  console.log(series.name + " data source string: " + dataSourceString.value);
  console.log(series.name + " data source type: " + dataSourceType.value);
});

getDimensionDataSourceType(dimension)

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

getDimensionDataSourceType(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;

Paramètres

dimension

"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"

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

Retours

Remarques

Jeu d’API : ExcelApi 1.15

getDimensionValues(dimension)

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

getDimensionValues(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string[]>;

Paramètres

dimension
Excel.ChartSeriesDimension

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

Retours

Remarques

Jeu d’API : ExcelApi 1.12

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  // The sample chart is of type `Excel.ChartType.bubble`.
  const bubbleChart = sheet.charts.getItem("Product Chart");

  // Get the first series in the chart.
  const firstSeries = bubbleChart.series.getItemAt(0);

  // Get the values for the dimensions we're interested in.
  const bubbleSize = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.bubbleSizes);
  const xValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.xvalues);
  const yValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.yvalues);
  const category = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.categories);

  await context.sync();

  // Log the information.
  console.log(`Series ${category.value} - X: ${xValues.value}, Y: ${yValues.value}, Bubble: ${bubbleSize.value}`);
});

getDimensionValues(dimension)

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

getDimensionValues(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string[]>;

Paramètres

dimension

"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"

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

Retours

Remarques

Jeu d’API : ExcelApi 1.12

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries;

Paramètres

options
Excel.Interfaces.ChartSeriesLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.ChartSeries;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Exemples

// Rename the 1st series of Chart1 to "New Series Name".
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.series.getItemAt(0).name = "New Series Name";
    await context.sync();

    console.log("Series1 Renamed");
});

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartSeries;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.ChartSeriesUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.ChartSeriesUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.ChartSeries): void;

Paramètres

properties
Excel.ChartSeries

Retours

void

setBubbleSizes(sourceData)

Définit la taille des bulles pour une série de graphiques. Fonctionne uniquement pour les graphiques en bulles.

setBubbleSizes(sourceData: Range): void;

Paramètres

sourceData
Excel.Range

Objet Range correspondant aux données sources.

Retours

void

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml

await Excel.run(async (context) => {
  /*
    The table is expected to look like this:
    Product, Inventory, Price, Current Market Share
    Calamansi, 2000, $2.45, 10%
    ...

    We want each bubble to represent a single row.
  */

  // Get the worksheet and table data.
  const sheet = context.workbook.worksheets.getItem("Sample");
  const table = sheet.tables.getItem("Sales");
  const dataRange = table.getDataBodyRange();

  // Get the table data without the row names.
  const valueRange = dataRange.getOffsetRange(0, 1).getResizedRange(0, -1);

  // Create the chart.
  const bubbleChart = sheet.charts.add(Excel.ChartType.bubble, valueRange);
  bubbleChart.name = "Product Chart";

  // Remove the default series, since we want a unique series for each row.
  bubbleChart.series.getItemAt(0).delete();

  // Load the data necessary to make a chart series.
  dataRange.load(["rowCount", "values"]);
  await context.sync();

  // For each row, create a chart series (a bubble).
  for (let i = 0; i < dataRange.rowCount; i++) {
    const newSeries = bubbleChart.series.add(dataRange.values[i][0], i);
    newSeries.setXAxisValues(dataRange.getCell(i, 1));
    newSeries.setValues(dataRange.getCell(i, 2));
    newSeries.setBubbleSizes(dataRange.getCell(i, 3));

    // Show the product name and market share percentage.
    newSeries.dataLabels.showSeriesName = true;
    newSeries.dataLabels.showBubbleSize = true;
    newSeries.dataLabels.showValue = false;
  }

  await context.sync();
});

setValues(sourceData)

Définit les valeurs d’une série de graphiques. Pour les graphiques en nuages, il s’agit des valeurs de l’axe Y.

setValues(sourceData: Range): void;

Paramètres

sourceData
Excel.Range

Objet Range correspondant aux données sources.

Retours

void

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  let seriesCollection = sheet.charts.getItemAt(0);
  let rangeSelection = sheet.getRange("C2:C7");
  let xRangeSelection = sheet.getRange("A1:A7");

  // Add a series.
  let newSeries = seriesCollection.series.add("Qtr2");
  newSeries.setValues(rangeSelection);
  newSeries.setXAxisValues(xRangeSelection);

  await context.sync();
});

setXAxisValues(sourceData)

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

setXAxisValues(sourceData: Range): void;

Paramètres

sourceData
Excel.Range

Objet Range correspondant aux données sources.

Retours

void

Remarques

Jeu d’API : ExcelApi 1.7

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.ChartSeries est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartSeriesDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartSeriesData;

Retours