Excel.Interfaces.ChartLoadOptions interface

Package:

excel

Represents a chart object in a workbook. To learn more about the chart object model, see Work with charts using the Excel JavaScript API.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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.
pivotOptions	Encapsulates the options for a pivot chart.
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.
worksheet	The worksheet containing the current chart.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

axes

Represents chart axes.

axes?: Excel.Interfaces.ChartAxesLoadOptions;

Property Value

Excel.Interfaces.ChartAxesLoadOptions

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

chartType

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

chartType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

dataLabels

Represents the data labels on the chart.

dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;

Property Value

Excel.Interfaces.ChartDataLabelsLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

displayBlanksAs

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

displayBlanksAs?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

format

Encapsulates the format properties for the chart area.

format?: Excel.Interfaces.ChartAreaFormatLoadOptions;

Property Value

Excel.Interfaces.ChartAreaFormatLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

height

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

height?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

id

The unique ID of chart.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

left

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

left?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

legend

Represents the legend for the chart.

legend?: Excel.Interfaces.ChartLegendLoadOptions;

Property Value

Excel.Interfaces.ChartLegendLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

name

Specifies the name of a chart object.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

pivotOptions

Encapsulates the options for a pivot chart.

pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions;

Property Value

Excel.Interfaces.ChartPivotOptionsLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

plotArea

Represents the plot area for the chart.

plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions;

Property Value

Excel.Interfaces.ChartPlotAreaLoadOptions

Remarks

[ API set: ExcelApi 1.8 ]

plotBy

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

plotBy?: boolean;

Property Value

boolean

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.ChartSeriesCollectionLoadOptions;

Property Value

Excel.Interfaces.ChartSeriesCollectionLoadOptions

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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.ChartTitleLoadOptions;

Property Value

Excel.Interfaces.ChartTitleLoadOptions

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

width

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

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

worksheet

The worksheet containing the current chart.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.2 ]