Partager via


Excel.ChartSeries class

Représente une série dans un graphique.

Extends

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

axisGroup

Spécifie le groupe pour 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 plus d’informations, consultez Excel.ChartType .

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

dataLabels

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

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).

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 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 de la valeur milieu d’une série de graphiques de carte de région.

gradientMidpointType

Spécifie le type de la valeur de point intermédiaire 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égions.

gradientMinimumType

Spécifie le type pour la 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 dégradé de série d’un graphique de carte de région.

hasDataLabels

Spécifie si la série a 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 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.

markerStyle

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

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.

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

plotOrder

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

points

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

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.

showConnectorLines

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

showLeaderLines

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

showShadow

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

smooth

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

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.

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.

trendlines

Collection de courbes de tendance dans la série.

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.

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(dimensionString)

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(dimensionString)

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.

getDimensionValues(dimensionString)

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.

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 passer un objet brut avec les propriétés appropriées ou 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 les tailles de bulles d’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 nuages de points, il fait référence aux 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.ChartSeriesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

axisGroup

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

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

Valeur de propriété

Excel.ChartAxisGroup | "Primary" | "Secondary"

Remarques

[ Ensemble 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

[ Ensemble 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

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.9 ]

chartType

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

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

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"

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

dataLabels

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

readonly dataLabels: Excel.ChartDataLabels;

Valeur de propriété

Remarques

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

doughnutHoleSize: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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).

explosion: number;

Valeur de propriété

number

Remarques

[ Ensemble 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

[ Ensemble 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

[ Ensemble 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

[ Ensemble 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 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

[ Ensemble 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

[ Ensemble 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

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.9 ]

gradientMidpointColor

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

gradientMidpointColor: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

gradientMidpointType

Spécifie le type de la valeur de point intermédiaire 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

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.9 ]

gradientMinimumColor

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

gradientMinimumColor: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

gradientMinimumType

Spécifie le type pour la 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

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.9 ]

gradientStyle

Spécifie le style de dégradé 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

[ Ensemble d’API : ExcelApi 1.9 ]

hasDataLabels

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

hasDataLabels: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

[ Ensemble 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

[ Ensemble 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

[ Ensemble 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

[ Ensemble 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

[ Ensemble 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 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.

markerSize: number;

Valeur de propriété

number

Remarques

[ Ensemble 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 plus d’informations, consultez Excel.ChartMarkerStyle .

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

[ Ensemble 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 être supérieure à 255 caractères.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.8 ]

parentLabelStrategy

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

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

Valeur de propriété

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

Remarques

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.7 ]

points

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

readonly points: Excel.ChartPointsCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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.

secondPlotSize: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

showConnectorLines

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

showConnectorLines: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

showLeaderLines

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

showLeaderLines: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

showShadow

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

showShadow: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

smooth

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

smooth: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

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.

splitValue: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

trendlines

Collection de courbes de tendance dans la série.

readonly trendlines: Excel.ChartTrendlineCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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.

varyByCategories: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.9 ]

Détails de la méthode

delete()

Supprime la série graphique.

delete(): void;

Retours

void

Remarques

[ Ensemble 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

[ Ensemble 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(dimensionString)

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

Paramètres

dimensionString

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

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

Retours

Remarques

[ Ensemble 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

[ Ensemble 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(dimensionString)

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

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

Paramètres

dimensionString

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

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

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.15 ]

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

Paramètres

dimension
Excel.ChartSeriesDimension

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

Retours

Remarques

[ Ensemble 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(dimensionString)

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

Paramètres

dimensionString

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

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

Retours

Remarques

[ Ensemble 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 qui spécifient 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 passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties
Excel.Interfaces.ChartSeriesUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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 les tailles de bulles d’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

[ Ensemble 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 nuages de points, il fait référence aux valeurs de l’axe y.

setValues(sourceData: Range): void;

Paramètres

sourceData
Excel.Range

Objet Range correspondant aux données sources.

Retours

void

Remarques

[ Ensemble 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

[ Ensemble 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.ChartSeriesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ChartSeriesData;

Retours