Excel.Interfaces.ChartLoadOptions interface

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

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

axes

Represents chart axes.

[ API set: ExcelApi 1.1 ]

categoryLabelLevel

Returns or sets a ChartCategoryLabelLevel enumeration constant referring to the level of where the category labels are being sourced from. Read/Write.

[ API set: ExcelApi 1.8 ]

chartType

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

[ API set: ExcelApi 1.7 ]

dataLabels

Represents the datalabels on the chart.

[ API set: ExcelApi 1.1 ]

displayBlanksAs

Returns or sets the way that blank cells are plotted on a chart. Read/Write.

[ API set: ExcelApi 1.8 ]

format

Encapsulates the format properties for the chart area.

[ API set: ExcelApi 1.1 ]

height

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

[ API set: ExcelApi 1.1 ]

id

The unique id of chart. Read-only.

[ API set: ExcelApi 1.7 ]

left

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

[ API set: ExcelApi 1.1 ]

legend

Represents the legend for the chart.

[ API set: ExcelApi 1.1 ]

name

Represents the name of a chart object.

[ API set: ExcelApi 1.1 ]

pivotOptions

Encapsulates the options for a pivot chart.

[ API set: ExcelApi 1.9 ]

plotArea

Represents the plotArea for the chart.

[ API set: ExcelApi 1.8 ]

plotBy

Returns or sets the way columns or rows are used as data series on the chart. Read/Write.

[ API set: ExcelApi 1.8 ]

plotVisibleOnly

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

[ API set: ExcelApi 1.8 ]

series

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

[ API set: ExcelApi 1.1 ]

seriesNameLevel

Returns or sets a ChartSeriesNameLevel enumeration constant referring to the level of where the series names are being sourced from. Read/Write.

[ API set: ExcelApi 1.8 ]

showAllFieldButtons

Represents whether to display all field buttons on a PivotChart.

[ API set: ExcelApi 1.7 ]

showDataLabelsOverMaximum

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

[ API set: ExcelApi 1.8 ]

style

Returns or sets the chart style for the chart. Read/Write.

[ API set: ExcelApi 1.8 ]

title

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

[ API set: ExcelApi 1.1 ]

top

Represents 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).

[ API set: ExcelApi 1.1 ]

width

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

[ API set: ExcelApi 1.1 ]

worksheet

The worksheet containing the current chart.

[ API set: ExcelApi 1.2 ]

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

axes

Represents chart axes.

[ API set: ExcelApi 1.1 ]

axes?: Excel.Interfaces.ChartAxesLoadOptions;

Property Value

categoryLabelLevel

Returns or sets a ChartCategoryLabelLevel enumeration constant referring to the level of where the category labels are being sourced from. Read/Write.

[ API set: ExcelApi 1.8 ]

categoryLabelLevel?: boolean;

Property Value

boolean

chartType

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

[ API set: ExcelApi 1.7 ]

chartType?: boolean;

Property Value

boolean

dataLabels

Represents the datalabels on the chart.

[ API set: ExcelApi 1.1 ]

dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;

Property Value

displayBlanksAs

Returns or sets the way that blank cells are plotted on a chart. Read/Write.

[ API set: ExcelApi 1.8 ]

displayBlanksAs?: boolean;

Property Value

boolean

format

Encapsulates the format properties for the chart area.

[ API set: ExcelApi 1.1 ]

format?: Excel.Interfaces.ChartAreaFormatLoadOptions;

Property Value

height

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

[ API set: ExcelApi 1.1 ]

height?: boolean;

Property Value

boolean

id

The unique id of chart. Read-only.

[ API set: ExcelApi 1.7 ]

id?: boolean;

Property Value

boolean

left

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

[ API set: ExcelApi 1.1 ]

left?: boolean;

Property Value

boolean

legend

Represents the legend for the chart.

[ API set: ExcelApi 1.1 ]

legend?: Excel.Interfaces.ChartLegendLoadOptions;

Property Value

name

Represents the name of a chart object.

[ API set: ExcelApi 1.1 ]

name?: boolean;

Property Value

boolean

pivotOptions

Encapsulates the options for a pivot chart.

[ API set: ExcelApi 1.9 ]

pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions;

Property Value

plotArea

Represents the plotArea for the chart.

[ API set: ExcelApi 1.8 ]

plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions;

Property Value

plotBy

Returns or sets the way columns or rows are used as data series on the chart. Read/Write.

[ API set: ExcelApi 1.8 ]

plotBy?: boolean;

Property Value

boolean

plotVisibleOnly

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

[ API set: ExcelApi 1.8 ]

plotVisibleOnly?: boolean;

Property Value

boolean

series

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

[ API set: ExcelApi 1.1 ]

series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions;

Property Value

seriesNameLevel

Returns or sets a ChartSeriesNameLevel enumeration constant referring to the level of where the series names are being sourced from. Read/Write.

[ API set: ExcelApi 1.8 ]

seriesNameLevel?: boolean;

Property Value

boolean

showAllFieldButtons

Represents whether to display all field buttons on a PivotChart.

[ API set: ExcelApi 1.7 ]

showAllFieldButtons?: boolean;

Property Value

boolean

showDataLabelsOverMaximum

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

[ API set: ExcelApi 1.8 ]

showDataLabelsOverMaximum?: boolean;

Property Value

boolean

style

Returns or sets the chart style for the chart. Read/Write.

[ API set: ExcelApi 1.8 ]

style?: boolean;

Property Value

boolean

title

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

[ API set: ExcelApi 1.1 ]

title?: Excel.Interfaces.ChartTitleLoadOptions;

Property Value

top

Represents 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).

[ API set: ExcelApi 1.1 ]

top?: boolean;

Property Value

boolean

width

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

[ API set: ExcelApi 1.1 ]

width?: boolean;

Property Value

boolean

worksheet

The worksheet containing the current chart.

[ API set: ExcelApi 1.2 ]

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value