Excel.ChartAxis class

Package:

excel

Represents a single axis in a chart.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.1 ]

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 object, which includes line and font formatting.
majorGridlines	Returns an object that represents the major gridlines for the specified axis.
majorUnit	Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.
maximum	Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
minimum	Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
minorGridlines	Returns an object that represents the minor gridlines for the specified axis.
minorUnit	Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.
title	Represents the axis title.

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.ChartAxis object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartAxisData) 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

Represents the formatting of a chart object, which includes line and font formatting.

readonly format: Excel.ChartAxisFormat;

Property Value

Excel.ChartAxisFormat

Remarks

[ API set: ExcelApi 1.1 ]

majorGridlines

Returns an object that represents the major gridlines for the specified axis.

readonly majorGridlines: Excel.ChartGridlines;

Property Value

Excel.ChartGridlines

Remarks

[ API set: ExcelApi 1.1 ]

majorUnit

Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.

majorUnit: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.1 ]

maximum

Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.

maximum: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.1 ]

minimum

Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.

minimum: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.1 ]

minorGridlines

Returns an object that represents the minor gridlines for the specified axis.

readonly minorGridlines: Excel.ChartGridlines;

Property Value

Excel.ChartGridlines

Remarks

[ API set: ExcelApi 1.1 ]

minorUnit

Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.

minorUnit: any;

Property Value

any

Remarks

[ API set: ExcelApi 1.1 ]

title

Represents the axis title.

readonly title: Excel.ChartAxisTitle;

Property Value

Excel.ChartAxisTitle

Remarks

[ API set: ExcelApi 1.1 ]

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.ChartAxisLoadOptions): Excel.ChartAxis;

Parameters

options

Excel.Interfaces.ChartAxisLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartAxis

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.ChartAxis;

Parameters

propertyNames

string | string[]

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

Returns

Excel.ChartAxis

Examples

// Get the maximum of Chart Axis from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const axis = chart.axes.valueAxis;
    axis.load('maximum');
    await context.sync();

    console.log(axis.maximum);
});

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.ChartAxis;

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

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.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Excel.Interfaces.ChartAxisUpdateData

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.ChartAxis): void;

Parameters

properties

Excel.ChartAxis

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.ChartAxis object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartAxisData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartAxisData;

Returns

Excel.Interfaces.ChartAxisData