Edit

Share via

Excel.Interfaces.ChartSeriesUpdateData interface

  • Reference
Package:
excel

An interface for updating data on the ChartSeries object, for use in chartSeries.set({ ... }).

Properties

axisGroup

Specifies the group for the specified series.
chartType

Represents the chart type of a series. See Excel.ChartType for details.
dataLabels

Represents a collection of all data labels in the series.
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.
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.
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.
format

Represents the formatting of a chart series, which includes fill and line formatting.
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.
hasDataLabels

Specifies if the series has data labels.
invertIfNegative

True if Excel inverts the pattern in the item when it corresponds to a negative number.
markerBackgroundColor

Specifies the marker background color of a chart series.
markerForegroundColor

Specifies the marker foreground color of a chart series.
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.
markerStyle

Specifies the marker style of a chart series. See Excel.ChartMarkerStyle for details.
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.
plotOrder

Specifies the plot order of a chart series within the chart group.
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.
showShadow

Specifies if the series has a shadow.
smooth

Specifies if the series is smooth. Only applicable to line and scatter charts.
splitType

Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.
varyByCategories

True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series.

Property Details

axisGroup

Specifies the group for the specified series.

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

Property Value

Excel.ChartAxisGroup | "Primary" | "Secondary"

Remarks

[ API set: ExcelApi 1.8 ]

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

[ API set: ExcelApi 1.7 ]

dataLabels

Represents a collection of all data labels in the series.

dataLabels?: Excel.Interfaces.ChartDataLabelsUpdateData;

Property Value

Excel.Interfaces.ChartDataLabelsUpdateData

Remarks

[ API set: ExcelApi 1.8 ]

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

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.8 ]

filtered

Specifies if the series is filtered. Not applicable for surface charts.

filtered?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.8 ]

format

Represents the formatting of a chart series, which includes fill and line formatting.

format?: Excel.Interfaces.ChartSeriesFormatUpdateData;

Property Value

Excel.Interfaces.ChartSeriesFormatUpdateData

Remarks

[ API set: ExcelApi 1.1 ]

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

[ API set: ExcelApi 1.7 ]

hasDataLabels

Specifies if the series has data labels.

hasDataLabels?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

invertIfNegative

True if Excel inverts the pattern in the item when it corresponds to a negative number.

invertIfNegative?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

markerBackgroundColor

Specifies the marker background color of a chart series.

markerBackgroundColor?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

markerForegroundColor

Specifies the marker foreground color of a chart series.

markerForegroundColor?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.1 ]

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

[ API set: ExcelApi 1.8 ]

plotOrder

Specifies the plot order of a chart series within the chart group.

plotOrder?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.8 ]

showShadow

Specifies if the series has a shadow.

showShadow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

smooth

Specifies if the series is smooth. Only applicable to line and scatter charts.

smooth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.8 ]

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

[ API set: ExcelApi 1.8 ]