Edit

Share via

Excel.Interfaces.ChartLoadOptions interface

  • Reference
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.
chartType

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

Represents the data labels on the 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.
series

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

Specifies whether to display all field buttons on a PivotChart.
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 ]

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 ]

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 ]

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 ]

showAllFieldButtons

Specifies whether to display all field buttons on a PivotChart.

showAllFieldButtons?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

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 ]