Excel.ChartAxisTitle class

包:

excel

表示图表坐标轴的标题。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
format	指定图表轴标题的格式。
text	指定轴标题。
textOrientation	为图表轴标题指定文本所指向的角度。 对于垂直方向文本，该值应为 -90 到 90 的整数或整数 180。
visible	指定轴标题是否可见。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
setFormula(formula)	该字符串值表示采用 A1 表示法的图表轴标题的公式。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Excel.ChartAxisTitle 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartAxisTitleData) ，该对象包含原始对象中加载的任何子属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

format

指定图表轴标题的格式。

readonly format: Excel.ChartAxisTitleFormat;

属性值

Excel.ChartAxisTitleFormat

注解

[ API 集：ExcelApi 1.1 ]

text

指定轴标题。

text: string;

属性值

string

注解

[ API 集：ExcelApi 1.1 ]

textOrientation

为图表轴标题指定文本所指向的角度。 对于垂直方向文本，该值应为 -90 到 90 的整数或整数 180。

textOrientation: number;

属性值

number

注解

[ API 集：ExcelApi 1.12 ]

示例

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

指定轴标题是否可见。

visible: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

方法详细信息

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle;

参数

options

Excel.Interfaces.ChartAxisTitleLoadOptions

提供要加载对象的属性的选项。

返回

Excel.ChartAxisTitle

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.ChartAxisTitle;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.ChartAxisTitle

示例

// 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 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.ChartAxisTitle

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

注解

[ API 集：ExcelApi 1.8 ]

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Excel.ChartAxisTitle 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartAxisTitleData) ，该对象包含原始对象中加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.ChartAxisTitleData;

返回

Excel.Interfaces.ChartAxisTitleData