Excel.ChartFont class
此对象表示 (字体属性,例如图表对象的字体名称、字号和颜色) 。
注解
示例
// Set the chart title font to Calibri, size 10, bold, and the color red.
await Excel.run(async (context) => {
const title = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title;
title.format.font.name = "Calibri";
title.format.font.size = 12;
title.format.font.color = "#FF0000";
title.format.font.italic = false;
title.format.font.bold = true;
title.format.font.underline = "None";
await context.sync();
});
属性
| bold | 表示字体的加粗状态。 |
| color | 文本颜色 (的 HTML 颜色代码表示形式,例如,#FF0000 表示红色) 。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| italic | 表示字体的斜体状态。 |
| name | 字体名称 (例如“Calibri”) |
| size | 字体大小 (,例如 11) |
| underline | 应用于字体的下划线类型。 有关详细信息,请参阅 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象,同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
bold
color
context
italic
name
size
underline
应用于字体的下划线类型。 有关详细信息,请参阅 Excel.ChartUnderlineStyle。
underline: Excel.ChartUnderlineStyle | "None" | "Single";
属性值
Excel.ChartUnderlineStyle | "None" | "Single"
注解
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont;
参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ChartFont;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartFont;
参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.ChartFontUpdateData, options?: OfficeExtension.UpdateOptions): void;
参数
- properties
- Excel.Interfaces.ChartFontUpdateData
一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
基于现有的已加载对象,同时对对象设置多个属性。
set(properties: Excel.ChartFont): void;
参数
- properties
- Excel.ChartFont
返回
void
toJSON()
重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.ChartFont对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.ChartFontData) ,其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.ChartFontData;