Excel.ChartAxisTitle class

Package:

excel

Represents the title of a chart axis.

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	Specifies the formatting of the chart axis title.
text	Specifies the axis title.
visible	Specifies if the axis title is visible.

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.
setFormula(formula)	A string value that represents the formula of chart axis title using A1-style notation.
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.ChartAxisTitle object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartAxisTitleData) 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 the chart axis title.

readonly format: Excel.ChartAxisTitleFormat;

Property Value

Excel.ChartAxisTitleFormat

Remarks

[ API set: ExcelApi 1.1 ]

text

Specifies the axis title.

text: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

visible

Specifies if the axis title is visible.

visible: boolean;

Property Value

boolean

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.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle;

Parameters

options

Excel.Interfaces.ChartAxisTitleLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartAxisTitle

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.ChartAxisTitle

Examples

// Add "Values" as the title for the value Axis.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); 
    chart.axes.valueAxis.title.text = "Values";
    await context.sync();
    
    console.log("Axis Title Added ");
});

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

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

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

Parameters

properties

Excel.Interfaces.ChartAxisTitleUpdateData

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

Parameters

properties

Excel.ChartAxisTitle

Returns

void

setFormula(formula)

A string value that represents the formula of chart axis title using A1-style notation.

setFormula(formula: string): void;

Parameters

formula

string

A string that represents the formula to set.

Returns

void

Remarks

[ API set: ExcelApi 1.8 ]

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

toJSON(): Excel.Interfaces.ChartAxisTitleData;

Returns

Excel.Interfaces.ChartAxisTitleData