Excel.ChartTitle class

参考

包:: excel

表示图表的图表标题对象。

扩展: OfficeExtension.ClientObject

注解

属性

context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
format	表示图表标题的格式，包括填充和字体格式。
height	返回图表标题的高度，以磅为单位。 `null`如果图表标题不可见，则值为。
horizontalAlignment	指定图表标题的水平对齐方式。
left	指定从图表标题的左边缘到图表区左边缘的距离（以磅为单位）。 `null`如果图表标题不可见，则值为。
overlay	指定图表标题是否将覆盖图表。
position	表示图表标题的位置。有关详细信息，请参阅 `Excel.ChartTitlePosition`。
showShadow	表示一个布尔值，用于确定图表标题是否具有阴影。
text	指定图表的标题文本。
textOrientation	为图表标题指定文本的方向。对于垂直方向文本，该值应为 -90 到 90 的整数或整数 180。
top	指定从图表标题的上边缘到图表区顶部的距离（以磅为单位）。 `null`如果图表标题不可见，则值为。
verticalAlignment	指定图表标题的垂直对齐方式。有关详细信息，请参阅 `Excel.ChartTextVerticalAlignment`。
visible	指定图表标题是否可见。
width	指定图表标题的宽度（以磅为单位）。 `null`如果图表标题不可见，则值为。

方法

getSubstring(start, length)	获取图表标题的子字符串。换行符“n”\计数为一个字符。
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.ChartTitle`对象是 API 对象，`toJSON`该方法返回一个纯 JavaScript 对象， (类型为 `Excel.Interfaces.ChartTitleData`) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

format

表示图表标题的格式，包括填充和字体格式。

readonly format: Excel.ChartTitleFormat;

属性值

Excel.ChartTitleFormat

注解

[ API 集：ExcelApi 1.1 ]

height

返回图表标题的高度，以磅为单位。 null如果图表标题不可见，则值为。

readonly height: number;

属性值

number

注解

[ API 集：ExcelApi 1.7 ]

horizontalAlignment

指定图表标题的水平对齐方式。

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

属性值

注解

[ API 集：ExcelApi 1.7 ]

left

指定从图表标题的左边缘到图表区左边缘的距离（以磅为单位）。 null如果图表标题不可见，则值为。

left: number;

属性值

number

注解

[ API 集：ExcelApi 1.7 ]

overlay

指定图表标题是否将覆盖图表。

overlay: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

position

表示图表标题的位置。有关详细信息，请参阅 Excel.ChartTitlePosition。

position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";

属性值

注解

[ API 集：ExcelApi 1.7 ]

showShadow

表示一个布尔值，用于确定图表标题是否具有阴影。

showShadow: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.7 ]

text

指定图表的标题文本。

text: string;

属性值

string

注解

[ API 集：ExcelApi 1.1 ]

textOrientation

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

textOrientation: number;

属性值

number

注解

[ API 集：ExcelApi 1.7 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const title = sheet.charts.getItemAt(0).title;
    title.textOrientation = -45;

    await context.sync();
});

top

指定从图表标题的上边缘到图表区顶部的距离（以磅为单位）。 null如果图表标题不可见，则值为。

top: number;

属性值

number

注解

[ API 集：ExcelApi 1.7 ]

verticalAlignment

指定图表标题的垂直对齐方式。有关详细信息，请参阅 Excel.ChartTextVerticalAlignment。

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

属性值

注解

[ API 集：ExcelApi 1.7 ]

visible

指定图表标题是否可见。

visible: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

width

指定图表标题的宽度（以磅为单位）。 null如果图表标题不可见，则值为。

readonly width: number;

属性值

number

注解

[ API 集：ExcelApi 1.7 ]

方法详细信息

getSubstring(start, length)

获取图表标题的子字符串。换行符“n”\计数为一个字符。

getSubstring(start: number, length: number): Excel.ChartFormatString;

参数

start: number

要检索的子字符串的起始位置。从零开始编制索引。

length: number

要检索的子字符串的长度。

Excel.ChartFormatString

注解

[ API 集：ExcelApi 1.7 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let chart = sheet.charts.getItemAt(0);

    // Get first seven characters of the title and color them green.
    chart.title.getSubstring(0, 7).font.color = "Yellow";
    await context.sync();
});

load(options)

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

load(options?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle;

参数

options: Excel.Interfaces.ChartTitleLoadOptions

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

Excel.ChartTitle

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

Excel.ChartTitle

示例

// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    
    chart.title.text= "My Chart"; 
    chart.title.visible=true;
    chart.title.overlay=true;
    
    await context.sync();
    console.log("Char Title Changed");
});

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartTitle;

参数

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

Excel.ChartTitle

set(properties, options)

同时设置对象的多个属性。可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.ChartTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties: Excel.Interfaces.ChartTitleUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options: OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.ChartTitle): void;

参数

properties: Excel.ChartTitle

void

setFormula(formula)

设置一个字符串值，用于表示采用 A1 表示法的图表标题的公式。

setFormula(formula: string): void;

参数

formula: string

表示要设置的公式的字符串。

void

注解

[ API 集：ExcelApi 1.7 ]

toJSON()

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

toJSON(): Excel.Interfaces.ChartTitleData;

Excel.Interfaces.ChartTitleData

通过

Excel.ChartTitle class

注解

属性

方法

属性详细信息

context

属性值

format

属性值

注解

height

属性值

注解

horizontalAlignment

属性值

注解

left

属性值

注解

overlay

属性值

注解

position

属性值

注解

showShadow

属性值

注解

text

属性值

注解

textOrientation

属性值

注解

示例

top

属性值

注解

verticalAlignment

属性值

注解

visible

属性值

注解

width

属性值

注解

方法详细信息

getSubstring(start, length)

参数

返回

注解

示例

load(options)

参数

返回

load(propertyNames)

参数

返回

示例

load(propertyNamesAndPaths)

参数

返回

set(properties, options)

参数

返回

set(properties)

参数

返回

setFormula(formula)

参数

返回

注解

toJSON()

返回

其他资源