Excel.SlicerItemCollection class

表示切片器中所有切片器项对象的集合。

扩展

属性

context

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

items

获取此集合中已加载的子项。

方法

getCount()

返回切片器中的切片器项的数量。

getItem(key)

使用其键或名称获取切片器项对象。

getItemAt(index)

根据其在集合中的位置获取切片器项。

getItemOrNullObject(key)

使用其键或名称获取切片器项。 如果切片器项不存在,则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.SlicerItemCollection 对象是 API 对象,但该 toJSON 方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.SlicerItemCollectionData) ,其中包含一个“items”数组,其中包含从集合的 items 中加载的任何属性的浅层副本。

属性详细信息

context

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

context: RequestContext;

属性值

items

获取此集合中已加载的子项。

readonly items: Excel.SlicerItem[];

属性值

方法详细信息

getCount()

返回切片器中的切片器项的数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

注解

API 集:ExcelApi 1.10

getItem(key)

使用其键或名称获取切片器项对象。

getItem(key: string): Excel.SlicerItem;

参数

key

string

切片器项的键或名称。

返回

注解

API 集:ExcelApi 1.10

getItemAt(index)

根据其在集合中的位置获取切片器项。

getItemAt(index: number): Excel.SlicerItem;

参数

index

number

要检索的对象的索引值。 从零开始编制索引。

返回

注解

API 集:ExcelApi 1.10

getItemOrNullObject(key)

使用其键或名称获取切片器项。 如果切片器项不存在,则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

getItemOrNullObject(key: string): Excel.SlicerItem;

参数

key

string

要检索的切片器的键或名称。

返回

注解

API 集:ExcelApi 1.10

load(options)

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

load(options?: Excel.Interfaces.SlicerItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerItemCollection;

参数

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerItemCollection;

参数

propertyNamesAndPaths
OfficeExtension.LoadOption

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

返回

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.SlicerItemCollection 对象是 API 对象,但该 toJSON 方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.SlicerItemCollectionData) ,其中包含一个“items”数组,其中包含从集合的 items 中加载的任何属性的浅层副本。

toJSON(): Excel.Interfaces.SlicerItemCollectionData;

返回