Excel.ChartAxisTitle class
Represents the title of a chart axis.
- Extends
Remarks
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. |
| text |
Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. |
| 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 |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| 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. |
| set |
A string value that represents the formula of chart axis title using A1-style notation. |
| toJSON() | Overrides the JavaScript |
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
Specifies the formatting of the chart axis title.
readonly format: Excel.ChartAxisTitleFormat;Property Value
Remarks
text
textOrientation
Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
textOrientation: number;Property Value
number
Remarks
Examples
await Excel.run(async (context) => {
// Get a chart named "Sales Chart" from the "Sample" worksheet.
const sheet = context.workbook.worksheets.getItem("Sample");
let chart = sheet.charts.getItem("Sales Chart");
// Set the value axis title to "Profits".
chart.axes.valueAxis.title.text = "Profits";
/* Set the value axis text orientation to 0.
For charts with a y-axis, this makes the label on the y-axis horizontal,
instead of the default look of rotated-vertically.
*/
chart.axes.valueAxis.title.textOrientation = 0;
await context.sync();
});
visible
Specifies if the axis title is visible.
visible: boolean;Property Value
boolean
Remarks
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
Provides options for which properties of the object to load.
Returns
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
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
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
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
Office Add-ins