Excel.ChartAxisTitle class
表示图表坐标轴的标题。
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| format | 指定图表坐标轴标题的格式。 |
| text | 指定轴标题。 |
| text |
指定图表轴标题时文本的方向角度。 该值应为 -90 到 90 之间的整数，对于垂直方向的文本，应为整数 180。 |
| visible | 指定轴标题是否可见。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
该字符串值表示采用 A1 表示法的图表轴标题的公式。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
format
指定图表坐标轴标题的格式。
readonly format: Excel.ChartAxisTitleFormat;属性值
注解
text
textOrientation
指定图表轴标题时文本的方向角度。 该值应为 -90 到 90 之间的整数，对于垂直方向的文本，应为整数 180。
textOrientation: number;属性值
number
注解
示例
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
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ChartAxisTitle;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
示例
// 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)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartAxisTitle;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.ChartAxisTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.ChartAxisTitleUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Excel.ChartAxisTitle): void;参数
- properties
- Excel.ChartAxisTitle
返回
void
setFormula(formula)
该字符串值表示采用 A1 表示法的图表轴标题的公式。
setFormula(formula: string): void;参数
- formula
-
string
表示要设置的公式的字符串。
返回
void
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.ChartAxisTitle 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.ChartAxisTitleData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.ChartAxisTitleData;