Excel.ChartLegendFormat class

包:

excel

封装图表图例的格式属性。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

border	表示边框格式，包括颜色、线条样式和粗细。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
fill	表示对象的填充格式，包括背景格式信息。
font	表示字体属性，例如图表图例的字体名称、字号和颜色。

方法

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.ChartLegendFormat 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象 (类型为 Excel.Interfaces.ChartLegendFormatData) ，该对象包含原始对象中加载的任何子属性的浅表副本。

属性详细信息

border

表示边框格式，包括颜色、线条样式和粗细。

readonly border: Excel.ChartBorder;

属性值

Excel.ChartBorder

注解

[ API 集：ExcelApi 1.8 ]

context

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

context: RequestContext;

属性值

Excel.RequestContext

fill

表示对象的填充格式，包括背景格式信息。

readonly fill: Excel.ChartFill;

属性值

Excel.ChartFill

注解

[ API 集：ExcelApi 1.1 ]

font

表示字体属性，例如图表图例的字体名称、字号和颜色。

readonly font: Excel.ChartFont;

属性值

Excel.ChartFont

注解

[ 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.
    let font = 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();
});

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ChartLegendFormatLoadOptions): Excel.ChartLegendFormat;

参数

options

Excel.Interfaces.ChartLegendFormatLoadOptions

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

返回

Excel.ChartLegendFormat

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ChartLegendFormat

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ChartLegendFormat

set(properties, options)

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

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

参数

properties

Excel.Interfaces.ChartLegendFormatUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ChartLegendFormat): void;

参数

properties

Excel.ChartLegendFormat

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartLegendFormatData;

返回

Excel.Interfaces.ChartLegendFormatData