Excel.ChartPlotArea class

This object represents the attributes for a chart plotArea object.

[ API set: ExcelApi 1.8 ]

Extends
OfficeExtension.ClientObject

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

format

Represents the formatting of a chart plotArea.

[ API set: ExcelApi 1.8 ]

height

Represents the height value of plotArea.

[ API set: ExcelApi 1.8 ]

insideHeight

Represents the insideHeight value of plotArea.

[ API set: ExcelApi 1.8 ]

insideLeft

Represents the insideLeft value of plotArea.

[ API set: ExcelApi 1.8 ]

insideTop

Represents the insideTop value of plotArea.

[ API set: ExcelApi 1.8 ]

insideWidth

Represents the insideWidth value of plotArea.

[ API set: ExcelApi 1.8 ]

left

Represents the left value of plotArea.

[ API set: ExcelApi 1.8 ]

position

Represents the position of plotArea.

[ API set: ExcelApi 1.8 ]

top

Represents the top value of plotArea.

[ API set: ExcelApi 1.8 ]

width

Represents the width value of plotArea.

[ API set: ExcelApi 1.8 ]

Methods

load(option)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartPlotArea object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartPlotAreaData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

format

Represents the formatting of a chart plotArea.

[ API set: ExcelApi 1.8 ]

readonly format: Excel.ChartPlotAreaFormat;

Property Value

height

Represents the height value of plotArea.

[ API set: ExcelApi 1.8 ]

height: number;

Property Value

number

insideHeight

Represents the insideHeight value of plotArea.

[ API set: ExcelApi 1.8 ]

insideHeight: number;

Property Value

number

insideLeft

Represents the insideLeft value of plotArea.

[ API set: ExcelApi 1.8 ]

insideLeft: number;

Property Value

number

insideTop

Represents the insideTop value of plotArea.

[ API set: ExcelApi 1.8 ]

insideTop: number;

Property Value

number

insideWidth

Represents the insideWidth value of plotArea.

[ API set: ExcelApi 1.8 ]

insideWidth: number;

Property Value

number

left

Represents the left value of plotArea.

[ API set: ExcelApi 1.8 ]

left: number;

Property Value

number

position

Represents the position of plotArea.

[ API set: ExcelApi 1.8 ]

position: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";

Property Value

Excel.ChartPlotAreaPosition | "Automatic" | "Custom"

top

Represents the top value of plotArea.

[ API set: ExcelApi 1.8 ]

top: number;

Property Value

number

width

Represents the width value of plotArea.

[ API set: ExcelApi 1.8 ]

width: number;

Property Value

number

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?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea;

Parameters

Returns

Remarks

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

load(option?: string | string[]): Excel.ChartPlotArea - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ChartPlotArea - 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.ChartPlotArea - 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.

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.ChartPlotArea;

Parameters

propertyNames
string | string[]

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

Returns

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.ChartPlotArea;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ChartPlotAreaUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.ChartPlotAreaUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Excel.ChartPlotArea): void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartPlotArea): void;

Parameters

properties
Excel.ChartPlotArea

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartPlotArea object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartPlotAreaData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartPlotAreaData;

Returns