Excel.ChartAxes class

Represents the chart axes.

[ API set: ExcelApi 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

categoryAxis

Represents the category axis in a chart. Read-only.

[ API set: ExcelApi 1.1 ]

seriesAxis

Represents the series axis of a 3-dimensional chart. Read-only.

[ API set: ExcelApi 1.1 ]

valueAxis

Represents the value axis in an axis. Read-only.

[ API set: ExcelApi 1.1 ]

Methods

getItem(type, group)

Returns the specific axis identified by type and group.

[ API set: ExcelApi 1.7 ]

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

categoryAxis

Represents the category axis in a chart. Read-only.

[ API set: ExcelApi 1.1 ]

readonly categoryAxis: Excel.ChartAxis;
Property Value

seriesAxis

Represents the series axis of a 3-dimensional chart. Read-only.

[ API set: ExcelApi 1.1 ]

readonly seriesAxis: Excel.ChartAxis;
Property Value

valueAxis

Represents the value axis in an axis. Read-only.

[ API set: ExcelApi 1.1 ]

readonly valueAxis: Excel.ChartAxis;
Property Value

Method Details

getItem(type, group)

Returns the specific axis identified by type and group.

[ API set: ExcelApi 1.7 ]

getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup): Excel.ChartAxis;
Parameters
type
Excel.ChartAxisType

Specifies the axis type. See Excel.ChartAxisType for details.

group
Excel.ChartAxisGroup

Optional. Specifies the axis group. See Excel.ChartAxisGroup for details.

Returns

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.ChartAxes;
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.ChartAxes - 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.ChartAxes - 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.ChartAxesData;
Returns