Excel.ChartSeries class
Représente une série dans un graphique.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Propriétés
axis |
Spécifie le groupe pour la série spécifiée. |
bin |
Encapsule les options bin uniquement pour les histogrammes et graphiques de pareto. |
boxwhisker |
Résume les options pour le graphique de zone et valeur. |
bubble |
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. |
chart |
Représente le type de graphique d’une série. Pour plus d’informations, consultez |
context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
data |
Représente une collection de toutes les étiquettes de données de la série. |
doughnut |
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 |
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. |
first |
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. |
gap |
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. |
gradient |
Spécifie la couleur de la valeur maximale d’une série de graphiques de carte de région. |
gradient |
Spécifie le type de valeur maximale d’une série de graphiques de carte de région. |
gradient |
Spécifie la valeur maximale d’une série de graphiques de carte de région. |
gradient |
Spécifie la couleur de la valeur milieu d’une série de graphiques de carte de région. |
gradient |
Spécifie le type de la valeur de point intermédiaire d’une série de graphiques de carte de région. |
gradient |
Spécifie la valeur du point médian d’une série de graphiques de carte de région. |
gradient |
Spécifie la couleur de la valeur minimale d’une série de graphiques de carte de régions. |
gradient |
Spécifie le type pour la valeur minimale d’une série de graphiques de carte de région. |
gradient |
Spécifie la valeur minimale d’une série de graphiques de carte de région. |
gradient |
Spécifie le style de dégradé de série d’un graphique de carte de région. |
has |
Spécifie si la série a des étiquettes de données. |
invert |
Spécifie la couleur de remplissage des points de données négatifs d’une série. |
invert |
True si Excel inverse le modèle dans l’élément lorsqu’il correspond à un nombre négatif. |
map |
Encapsule les options pour le graphique carte de région. |
marker |
Spécifie la couleur d’arrière-plan du marqueur d’une série de graphiques. |
marker |
Spécifie la couleur de premier plan du marqueur d’une série de graphiques. |
marker |
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. |
marker |
Spécifie le style de marqueur d’une série de graphiques. Pour plus d’informations, consultez |
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. |
parent |
Spécifie la zone de stratégie d’étiquette parente de série pour un graphique treemap. |
plot |
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. |
second |
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. |
show |
Spécifie si les lignes de connecteur sont affichées dans les graphiques en cascade. |
show |
Spécifie si des lignes d’leader sont affichées pour chaque étiquette de données de la série. |
show |
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. |
split |
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. |
split |
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. |
vary |
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. |
x |
Représente l’objet de la barre d’erreur pour une série de graphique. |
y |
Représente l’objet de la barre d’erreur pour une série de graphique. |
Méthodes
delete() | Supprime la série graphique. |
get |
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. |
get |
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 |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
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. |
set |
Définit les tailles de bulles d’une série de graphiques. Fonctionne uniquement pour les graphiques en bulles. |
set |
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. |
set |
Définit les valeurs de l’axe x d’une série de graphiques. |
toJSON() | Remplace la méthode JavaScript |
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
binOptions
Encapsule les options bin uniquement pour les histogrammes et graphiques de pareto.
readonly binOptions: Excel.ChartBinOptions;
Valeur de propriété
Remarques
boxwhiskerOptions
Résume les options pour le graphique de zone et valeur.
readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions;
Valeur de propriété
Remarques
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
hasDataLabels
Spécifie si la série a des étiquettes de données.
hasDataLabels: boolean;
Valeur de propriété
boolean
Remarques
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
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
mapOptions
Encapsule les options pour le graphique carte de région.
readonly mapOptions: Excel.ChartMapOptions;
Valeur de propriété
Remarques
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
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
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
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
points
Retourne une collection de tous les points de la série.
readonly points: Excel.ChartPointsCollection;
Valeur de propriété
Remarques
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
showConnectorLines
Spécifie si les lignes de connecteur sont affichées dans les graphiques en cascade.
showConnectorLines: boolean;
Valeur de propriété
boolean
Remarques
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
showShadow
Spécifie si la série a une ombre.
showShadow: boolean;
Valeur de propriété
boolean
Remarques
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
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
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
trendlines
Collection de courbes de tendance dans la série.
readonly trendlines: Excel.ChartTrendlineCollection;
Valeur de propriété
Remarques
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
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
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
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();
});
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
OfficeExtension.ClientResult<string[]>
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
OfficeExtension.ClientResult<string[]>
Remarques
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
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
toJSON()
Remplace la méthode JavaScript toJSON()
afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify()
. (JSON.stringify
appelle à 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.ChartSeriesData
que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.ChartSeriesData;