Excel.ChartAreaFormat class

Encapsulates the format properties for the overall chart area.

[ API set: ExcelApi 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

border

Represents the border format of chart area, which includes color, linestyle, and weight. Read-only.

[ API set: ExcelApi 1.7 ]

fill

Represents the fill format of an object, which includes background formatting information. Read-only.

[ API set: ExcelApi 1.1 ]

font

Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.

[ API set: ExcelApi 1.1 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Property Details

border

Represents the border format of chart area, which includes color, linestyle, and weight. Read-only.

[ API set: ExcelApi 1.7 ]

readonly border: Excel.ChartBorder;
Property Value

fill

Represents the fill format of an object, which includes background formatting information. Read-only.

[ API set: ExcelApi 1.1 ]

readonly fill: Excel.ChartFill;
Property Value

font

Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only.

[ API set: ExcelApi 1.1 ]

readonly font: Excel.ChartFont;
Property Value

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.ChartAreaFormat;
Parameters
option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.ChartAreaFormat - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartAreaFormat - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

toJSON(): Excel.Interfaces.ChartAreaFormatData;
Returns