Excel.ChartLegendEntry class

包:

excel

表示 中的 legendEntryCollection图例条目。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.7 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
height	指定图表图例上图例条目的高度。
index	指定图表图例中图例项的索引。
left	指定图表图例条目的左侧值。
top	指定图表图例条目的顶部。
visible	表示图表图例条目的可见性。
width	表示图表图例上图例条目的宽度。

方法

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

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

height

指定图表图例上图例条目的高度。

readonly height: number;

属性值

number

注解

[ API 集：ExcelApi 1.8 ]

index

指定图表图例中图例项的索引。

readonly index: number;

属性值

number

注解

[ API 集：ExcelApi 1.8 ]

left

指定图表图例条目的左侧值。

readonly left: number;

属性值

number

注解

[ API 集：ExcelApi 1.8 ]

top

指定图表图例条目的顶部。

readonly top: number;

属性值

number

注解

[ API 集：ExcelApi 1.8 ]

visible

表示图表图例条目的可见性。

visible: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.7 ]

width

表示图表图例上图例条目的宽度。

readonly width: number;

属性值

number

注解

[ API 集：ExcelApi 1.8 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry;

参数

options

Excel.Interfaces.ChartLegendEntryLoadOptions

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

返回

Excel.ChartLegendEntry

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ChartLegendEntry

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ChartLegendEntry

set(properties, options)

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

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

参数

properties

Excel.Interfaces.ChartLegendEntryUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ChartLegendEntry): void;

参数

properties

Excel.ChartLegendEntry

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartLegendEntryData;

返回

Excel.Interfaces.ChartLegendEntryData