Edit

Share via

Excel.Interfaces.ChartData interface

  • Reference
Package:
excel

An interface describing the data returned by calling chart.toJSON().

Properties

axes

Represents chart axes.
categoryLabelLevel

Specifies a chart category label level enumeration constant, referring to the level of the source category labels.
chartType

Specifies the type of the chart. See Excel.ChartType for details.
dataLabels

Represents the data labels on the chart.
displayBlanksAs

Specifies the way that blank cells are plotted on a chart.
format

Encapsulates the format properties for the chart area.
height

Specifies the height, in points, of the chart object.
id

The unique ID of chart.
left

The distance, in points, from the left side of the chart to the worksheet origin.
legend

Represents the legend for the chart.
name

Specifies the name of a chart object.
plotArea

Represents the plot area for the chart.
plotBy

Specifies the way columns or rows are used as data series on the chart.
plotVisibleOnly

True if only visible cells are plotted. False if both visible and hidden cells are plotted.
series

Represents either a single series or collection of series in the chart.
seriesNameLevel

Specifies a chart series name level enumeration constant, referring to the level of the source series names.
showAllFieldButtons

Specifies whether to display all field buttons on a PivotChart.
showDataLabelsOverMaximum

Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only.
style

Specifies the chart style for the chart.
title

Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.
top

Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).
width

Specifies the width, in points, of the chart object.

Property Details

axes

Represents chart axes.

axes?: Excel.Interfaces.ChartAxesData;

Property Value

Excel.Interfaces.ChartAxesData

Remarks

[ API set: ExcelApi 1.1 ]

categoryLabelLevel

Specifies a chart category label level enumeration constant, referring to the level of the source category labels.

categoryLabelLevel?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

chartType

Specifies the type of the chart. 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 the data labels on the chart.

dataLabels?: Excel.Interfaces.ChartDataLabelsData;

Property Value

Excel.Interfaces.ChartDataLabelsData

Remarks

[ API set: ExcelApi 1.1 ]

displayBlanksAs

Specifies the way that blank cells are plotted on a chart.

displayBlanksAs?: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";

Property Value

Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"

Remarks

[ API set: ExcelApi 1.8 ]

format

Encapsulates the format properties for the chart area.

format?: Excel.Interfaces.ChartAreaFormatData;

Property Value

Excel.Interfaces.ChartAreaFormatData

Remarks

[ API set: ExcelApi 1.1 ]

height

Specifies the height, in points, of the chart object.

height?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

id

The unique ID of chart.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

left

The distance, in points, from the left side of the chart to the worksheet origin.

left?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

legend

Represents the legend for the chart.

legend?: Excel.Interfaces.ChartLegendData;

Property Value

Excel.Interfaces.ChartLegendData

Remarks

[ API set: ExcelApi 1.1 ]

name

Specifies the name of a chart object.

name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

plotArea

Represents the plot area for the chart.

plotArea?: Excel.Interfaces.ChartPlotAreaData;

Property Value

Excel.Interfaces.ChartPlotAreaData

Remarks

[ API set: ExcelApi 1.8 ]

plotBy

Specifies the way columns or rows are used as data series on the chart.

plotBy?: Excel.ChartPlotBy | "Rows" | "Columns";

Property Value

Excel.ChartPlotBy | "Rows" | "Columns"

Remarks

[ API set: ExcelApi 1.8 ]

plotVisibleOnly

True if only visible cells are plotted. False if both visible and hidden cells are plotted.

plotVisibleOnly?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

series

Represents either a single series or collection of series in the chart.

series?: Excel.Interfaces.ChartSeriesData[];

Property Value

Excel.Interfaces.ChartSeriesData[]

Remarks

[ API set: ExcelApi 1.1 ]

seriesNameLevel

Specifies a chart series name level enumeration constant, referring to the level of the source series names.

seriesNameLevel?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

showAllFieldButtons

Specifies whether to display all field buttons on a PivotChart.

showAllFieldButtons?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

showDataLabelsOverMaximum

Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only.

showDataLabelsOverMaximum?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

style

Specifies the chart style for the chart.

style?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

title

Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.

title?: Excel.Interfaces.ChartTitleData;

Property Value

Excel.Interfaces.ChartTitleData

Remarks

[ API set: ExcelApi 1.1 ]

top

Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

top?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

width

Specifies the width, in points, of the chart object.

width?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]