Excel.ChartPlotArea class

Package:

excel

This object represents the attributes for a chart plot area.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.8 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
format	Specifies the formatting of a chart plot area.
height	Specifies the height value of a plot area.
insideHeight	Specifies the inside height value of a plot area.
insideLeft	Specifies the inside left value of a plot area.
insideTop	Specifies the inside top value of a plot area.
insideWidth	Specifies the inside width value of a plot area.
left	Specifies the left value of a plot area.
position	Specifies the position of a plot area.
top	Specifies the top value of a plot area.
width	Specifies the width value of a plot area.

Methods

load(options)	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

Excel.RequestContext

format

Specifies the formatting of a chart plot area.

readonly format: Excel.ChartPlotAreaFormat;

Property Value

Excel.ChartPlotAreaFormat

Remarks

[ API set: ExcelApi 1.8 ]

height

Specifies the height value of a plot area.

height: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

insideHeight

Specifies the inside height value of a plot area.

insideHeight: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

insideLeft

Specifies the inside left value of a plot area.

insideLeft: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

insideTop

Specifies the inside top value of a plot area.

insideTop: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

insideWidth

Specifies the inside width value of a plot area.

insideWidth: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

left

Specifies the left value of a plot area.

left: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

position

Specifies the position of a plot area.

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

Property Value

Excel.ChartPlotAreaPosition | "Automatic" | "Custom"

Remarks

[ API set: ExcelApi 1.8 ]

top

Specifies the top value of a plot area.

top: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

width

Specifies the width value of a plot area.

width: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

Method Details

load(options)

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

load(options?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea;

Parameters

options

Excel.Interfaces.ChartPlotAreaLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartPlotArea

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

Excel.ChartPlotArea

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; }

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

Excel.ChartPlotArea

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

Excel.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

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

Excel.Interfaces.ChartPlotAreaData