ChartAxisTitle Object (JavaScript API for Excel)
Represents the title of a chart axis.
Properties
| Property | Type | Description | Req. Set |
|---|---|---|---|
| text | string | Represents the axis title. | 1.1 |
| visible | bool | A boolean that specifies the visibility of an axis title. | 1.1 |
See property access examples.
Relationships
| Relationship | Type | Description | Req. Set |
|---|---|---|---|
| format | ChartAxisTitleFormat | Represents the formatting of chart axis title. Read-only. | 1.1 |
Methods
None
Method Details
Property access examples
Get the text of Chart Axis Title from the value axis of Chart1.
Excel.run(function (ctx) {
var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
var title = chart.axes.valueAxis.title;
title.load('text');
return ctx.sync().then(function() {
console.log(title.text);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
Add "Values" as the title for the value Axis
Excel.run(function (ctx) {
var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.axes.valueAxis.title.text = "Values";
return ctx.sync().then(function() {
console.log("Axis Title Added ");
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});