Excel.ChartTitle class
表示图表的图表标题对象。
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| format | 表示图表标题的格式，包括填充和字体格式。 |
| height | 返回图表标题的高度，以磅为单位。 如果图表标题不可见，则为 |
| horizontal |
指定图表标题的水平对齐方式。 |
| left | 指定从图表标题的左边缘到图表区域的左边缘的距离（以磅为单位）。 如果图表标题不可见，则为 |
| overlay | 指定图表标题是否要覆盖图表。 |
| position | 表示图表标题的位置。 有关详细信息，请参阅 |
| show |
表示用于确定图表标题是否有阴影的布尔值。 |
| text | 指定图表的标题文本。 |
| text |
指定图表标题时文本的方向角度。 该值应为 -90 到 90 之间的整数，对于垂直方向的文本，应为整数 180。 |
| top | 指定从图表标题的顶部边缘到图表区域顶部的距离（以磅为单位）。 如果图表标题不可见，则为 |
| vertical |
指定图表标题的垂直对齐方式。 有关详细信息，请参阅 |
| visible | 指定图表标题是否可见。 |
| width | 指定图表标题的宽度（以磅为单位）。 如果图表标题不可见，则为 |
方法
| get |
获取图表标题的子字符串。 换行符 '\n' 计算一个字符。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
设置一个字符串值，用于表示采用 A1 表示法的图表标题的公式。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
format
表示图表标题的格式，包括填充和字体格式。
readonly format: Excel.ChartTitleFormat;属性值
注解
height
horizontalAlignment
指定图表标题的水平对齐方式。
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";属性值
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
注解
left
overlay
position
表示图表标题的位置。 有关详细信息，请参阅 Excel.ChartTitlePosition。
position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";属性值
Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"
注解
showShadow
text
textOrientation
指定图表标题时文本的方向角度。 该值应为 -90 到 90 之间的整数，对于垂直方向的文本，应为整数 180。
textOrientation: number;属性值
number
注解
示例
// 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
verticalAlignment
指定图表标题的垂直对齐方式。 有关详细信息，请参阅 Excel.ChartTextVerticalAlignment。
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";属性值
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
注解
visible
width
方法详细信息
getSubstring(start, length)
获取图表标题的子字符串。 换行符 '\n' 计算一个字符。
getSubstring(start: number, length: number): Excel.ChartFormatString;参数
- start
-
number
要检索的子字符串的起始位置。 从零开始编制索引。
- length
-
number
要检索的子字符串的长度。
返回
注解
示例
// 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;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ChartTitle;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
示例
// 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 指定要加载的导航属性的逗号分隔字符串。
返回
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
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.ChartTitle 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.ChartTitleData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.ChartTitleData;