Excel.Interfaces.ChartCollectionLoadOptions interface

Package:

excel

A collection of all the chart objects on a worksheet.

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	For EACH ITEM in the collection: Represents chart axes.
dataLabels	For EACH ITEM in the collection: Represents the data labels on the chart.
format	For EACH ITEM in the collection: Encapsulates the format properties for the chart area.
height	For EACH ITEM in the collection: Specifies the height, in points, of the chart object.
left	For EACH ITEM in the collection: The distance, in points, from the left side of the chart to the worksheet origin.
legend	For EACH ITEM in the collection: Represents the legend for the chart.
name	For EACH ITEM in the collection: Specifies the name of a chart object.
series	For EACH ITEM in the collection: Represents either a single series or collection of series in the chart.
title	For EACH ITEM in the collection: Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.
top	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Specifies the width, in points, of the chart object.
worksheet	For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Represents chart axes.

axes?: Excel.Interfaces.ChartAxesLoadOptions;

Property Value

Excel.Interfaces.ChartAxesLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

dataLabels

For EACH ITEM in the collection: Represents the data labels on the chart.

dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;

Property Value

Excel.Interfaces.ChartDataLabelsLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

format

For EACH ITEM in the collection: Encapsulates the format properties for the chart area.

format?: Excel.Interfaces.ChartAreaFormatLoadOptions;

Property Value

Excel.Interfaces.ChartAreaFormatLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

height

For EACH ITEM in the collection: Specifies the height, in points, of the chart object.

height?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

left

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Represents the legend for the chart.

legend?: Excel.Interfaces.ChartLegendLoadOptions;

Property Value

Excel.Interfaces.ChartLegendLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

name

For EACH ITEM in the collection: Specifies the name of a chart object.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

series

For EACH ITEM in the collection: 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 ]

title

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the width, in points, of the chart object.

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

worksheet

For EACH ITEM in the collection: The worksheet containing the current chart.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.2 ]