Excel.Interfaces.ChartSeriesData interface
An interface describing the data returned by calling chartSeries.toJSON().
Properties
| axis |
Specifies the group for the specified series. |
| bin |
Encapsulates the bin options for histogram charts and pareto charts. |
| boxwhisker |
Encapsulates the options for the box and whisker charts. |
| bubble |
This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts. |
| chart |
Represents the chart type of a series. See |
| data |
Represents a collection of all data labels in the series. |
| doughnut |
Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws an |
| explosion | Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie). |
| filtered | Specifies if the series is filtered. Not applicable for surface charts. |
| first |
Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360. |
| format | Represents the formatting of a chart series, which includes fill and line formatting. |
| gap |
Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of line and pie charts. Throws an invalid argument exception on invalid charts. |
| gradient |
Specifies the color for maximum value of a region map chart series. |
| gradient |
Specifies the type for maximum value of a region map chart series. |
| gradient |
Specifies the maximum value of a region map chart series. |
| gradient |
Specifies the color for the midpoint value of a region map chart series. |
| gradient |
Specifies the type for the midpoint value of a region map chart series. |
| gradient |
Specifies the midpoint value of a region map chart series. |
| gradient |
Specifies the color for the minimum value of a region map chart series. |
| gradient |
Specifies the type for the minimum value of a region map chart series. |
| gradient |
Specifies the minimum value of a region map chart series. |
| gradient |
Specifies the series gradient style of a region map chart. |
| has |
Specifies if the series has data labels. |
| invert |
Specifies the fill color for negative data points in a series. |
| invert |
True if Excel inverts the pattern in the item when it corresponds to a negative number. |
| map |
Encapsulates the options for a region map chart. |
| marker |
Specifies the marker background color of a chart series. |
| marker |
Specifies the marker foreground color of a chart series. |
| marker |
Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. |
| marker |
Specifies the marker style of a chart series. See |
| name | Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. |
| overlap | Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts. |
| parent |
Specifies the series parent label strategy area for a treemap chart. |
| plot |
Specifies the plot order of a chart series within the chart group. |
| points | Returns a collection of all points in the series. |
| second |
Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. |
| show |
Specifies whether connector lines are shown in waterfall charts. |
| show |
Specifies whether leader lines are displayed for each data label in the series. |
| show |
Specifies if the series has a shadow. |
| smooth | Specifies if the series is smooth. Only applicable to line and scatter charts. |
| split |
Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split. |
| split |
Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. |
| trendlines | The collection of trendlines in the series. |
| vary |
True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series. |
| x |
Represents the error bar object of a chart series. |
| y |
Represents the error bar object of a chart series. |
Property Details
axisGroup
Specifies the group for the specified series.
axisGroup?: Excel.ChartAxisGroup | "Primary" | "Secondary";Property Value
Excel.ChartAxisGroup | "Primary" | "Secondary"
Remarks
binOptions
Encapsulates the bin options for histogram charts and pareto charts.
binOptions?: Excel.Interfaces.ChartBinOptionsData;Property Value
Remarks
boxwhiskerOptions
Encapsulates the options for the box and whisker charts.
boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsData;Property Value
Remarks
bubbleScale
This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts.
bubbleScale?: number;Property Value
number
Remarks
chartType
Represents the chart type of a series. See Excel.ChartType for details.
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";Property Value
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"
Remarks
dataLabels
Represents a collection of all data labels in the series.
dataLabels?: Excel.Interfaces.ChartDataLabelsData;Property Value
Remarks
doughnutHoleSize
Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. Throws an InvalidArgument error on invalid charts.
doughnutHoleSize?: number;Property Value
number
Remarks
explosion
Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie).
explosion?: number;Property Value
number
Remarks
filtered
Specifies if the series is filtered. Not applicable for surface charts.
filtered?: boolean;Property Value
boolean
Remarks
firstSliceAngle
Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360.
firstSliceAngle?: number;Property Value
number
Remarks
format
Represents the formatting of a chart series, which includes fill and line formatting.
format?: Excel.Interfaces.ChartSeriesFormatData;Property Value
Remarks
gapWidth
Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of line and pie charts. Throws an invalid argument exception on invalid charts.
gapWidth?: number;Property Value
number
Remarks
gradientMaximumColor
Specifies the color for maximum value of a region map chart series.
gradientMaximumColor?: string;Property Value
string
Remarks
gradientMaximumType
Specifies the type for maximum value of a region map chart series.
gradientMaximumType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";Property Value
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Remarks
gradientMaximumValue
Specifies the maximum value of a region map chart series.
gradientMaximumValue?: number;Property Value
number
Remarks
gradientMidpointColor
Specifies the color for the midpoint value of a region map chart series.
gradientMidpointColor?: string;Property Value
string
Remarks
gradientMidpointType
Specifies the type for the midpoint value of a region map chart series.
gradientMidpointType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";Property Value
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Remarks
gradientMidpointValue
Specifies the midpoint value of a region map chart series.
gradientMidpointValue?: number;Property Value
number
Remarks
gradientMinimumColor
Specifies the color for the minimum value of a region map chart series.
gradientMinimumColor?: string;Property Value
string
Remarks
gradientMinimumType
Specifies the type for the minimum value of a region map chart series.
gradientMinimumType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";Property Value
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Remarks
gradientMinimumValue
Specifies the minimum value of a region map chart series.
gradientMinimumValue?: number;Property Value
number
Remarks
gradientStyle
Specifies the series gradient style of a region map chart.
gradientStyle?: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor";Property Value
Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"
Remarks
hasDataLabels
Specifies if the series has data labels.
hasDataLabels?: boolean;Property Value
boolean
Remarks
invertColor
Specifies the fill color for negative data points in a series.
invertColor?: string;Property Value
string
Remarks
invertIfNegative
True if Excel inverts the pattern in the item when it corresponds to a negative number.
invertIfNegative?: boolean;Property Value
boolean
Remarks
mapOptions
Encapsulates the options for a region map chart.
mapOptions?: Excel.Interfaces.ChartMapOptionsData;Property Value
Remarks
markerBackgroundColor
Specifies the marker background color of a chart series.
markerBackgroundColor?: string;Property Value
string
Remarks
markerForegroundColor
Specifies the marker foreground color of a chart series.
markerForegroundColor?: string;Property Value
string
Remarks
markerSize
Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
markerSize?: number;Property Value
number
Remarks
markerStyle
Specifies the marker style of a chart series. See Excel.ChartMarkerStyle for details.
markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";Property Value
Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"
Remarks
name
Specifies the name of a series in a chart. The name's length should not be greater than 255 characters.
name?: string;Property Value
string
Remarks
overlap
Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.
overlap?: number;Property Value
number
Remarks
parentLabelStrategy
Specifies the series parent label strategy area for a treemap chart.
parentLabelStrategy?: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping";Property Value
Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"
Remarks
plotOrder
Specifies the plot order of a chart series within the chart group.
plotOrder?: number;Property Value
number
Remarks
points
Returns a collection of all points in the series.
points?: Excel.Interfaces.ChartPointData[];Property Value
Remarks
secondPlotSize
Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200.
secondPlotSize?: number;Property Value
number
Remarks
showConnectorLines
Specifies whether connector lines are shown in waterfall charts.
showConnectorLines?: boolean;Property Value
boolean
Remarks
showLeaderLines
Specifies whether leader lines are displayed for each data label in the series.
showLeaderLines?: boolean;Property Value
boolean
Remarks
showShadow
Specifies if the series has a shadow.
showShadow?: boolean;Property Value
boolean
Remarks
smooth
Specifies if the series is smooth. Only applicable to line and scatter charts.
smooth?: boolean;Property Value
boolean
Remarks
splitType
Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.
splitType?: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit";Property Value
Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"
Remarks
splitValue
Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.
splitValue?: number;Property Value
number
Remarks
trendlines
The collection of trendlines in the series.
trendlines?: Excel.Interfaces.ChartTrendlineData[];Property Value
Remarks
varyByCategories
True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.
varyByCategories?: boolean;Property Value
boolean
Remarks
xErrorBars
Represents the error bar object of a chart series.
xErrorBars?: Excel.Interfaces.ChartErrorBarsData;Property Value
Remarks
yErrorBars
Represents the error bar object of a chart series.
yErrorBars?: Excel.Interfaces.ChartErrorBarsData;Property Value
Remarks
Office Add-ins