Excel.ChartFont class

包:

excel

此对象表示字体属性 (，例如图表对象的字体名称、字号和颜色) 。

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApi 1.1

使用方

• Excel.ChartAreaFormat： font
• Excel.ChartAxisFormat： font
• Excel.ChartAxisTitleFormat： font
• Excel.ChartDataLabelFormat： font
• Excel.ChartDataTableFormat： font
• Excel.ChartFormatString： font
• Excel.ChartLegendFormat： font
• Excel.ChartTitleFormat： font
• Excel.ChartTrendlineLabelFormat： font

示例

// 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	应用于字体的下划线类型。 有关详细信息，请参阅 Excel.ChartUnderlineStyle。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties)	基于现有加载的对象，同时在对象上设置多个属性。
toJSON()	覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.ChartFont 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.ChartFontData) ，其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

bold

表示字体的加粗状态。

bold: boolean;

属性值

boolean

注解

API 集：ExcelApi 1.1

示例

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let chart = sheet.charts.getItemAt(0);
    chart.legend.visible = true;

    // Format the legend font.
    const font: Excel.ChartFont = chart.legend.format.font;
    font.bold = true;
    font.color = "red";
    font.italic = true;
    font.size = 15;
    font.name = "Calibri";
    font.underline = "Single";

    await context.sync();
});

color

文本颜色 (的 HTML 颜色代码表示形式，例如，#FF0000 表示红色) 。

color: string;

属性值

string

注解

API 集：ExcelApi 1.1

context

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

context: RequestContext;

属性值

Excel.RequestContext

italic

表示字体的斜体状态。

italic: boolean;

属性值

boolean

注解

API 集：ExcelApi 1.1

name

字体名称 (，例如“Calibri”)

name: string;

属性值

string

注解

API 集：ExcelApi 1.1

size

字体 (的大小，例如 11)

size: number;

属性值

number

注解

API 集：ExcelApi 1.1

示例

// 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.format.font.size = 16;
    title.showShadow = true;

    await context.sync();
});

underline

应用于字体的下划线类型。 有关详细信息，请参阅 Excel.ChartUnderlineStyle。

underline: Excel.ChartUnderlineStyle | "None" | "Single";

属性值

Excel.ChartUnderlineStyle | "None" | "Single"

注解

API 集：ExcelApi 1.1

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont;

参数

options

Excel.Interfaces.ChartFontLoadOptions

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

返回

Excel.ChartFont

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ChartFont

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ChartFont

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;

返回

Excel.Interfaces.ChartFontData