Excel.SlicerItem class

包:

excel

表示切片器中的切片器项。

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApi 1.10

使用方

• Excel.SlicerItemCollection： getItem， getItemAt， getItemOrNullObject， items

属性

context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
hasData	值为 true 切片器项是否包含数据。
isSelected	值为 true 是否选择了切片器项。 设置此值不会清除其他切片器项的所选状态。 默认情况下，如果切片器项是唯一选择的项，则取消选择时，将选择所有项。
key	表示代表切片器项的唯一值。
name	表示在 Excel UI 中显示的标题。

方法

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

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

hasData

值为 true 切片器项是否包含数据。

readonly hasData: boolean;

属性值

boolean

注解

API 集：ExcelApi 1.10

isSelected

值为 true 是否选择了切片器项。 设置此值不会清除其他切片器项的所选状态。 默认情况下，如果切片器项是唯一选择的项，则取消选择时，将选择所有项。

isSelected: boolean;

属性值

boolean

注解

API 集：ExcelApi 1.10

key

表示代表切片器项的唯一值。

readonly key: string;

属性值

string

注解

API 集：ExcelApi 1.10

name

表示在 Excel UI 中显示的标题。

readonly name: string;

属性值

string

注解

API 集：ExcelApi 1.10

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.SlicerItemLoadOptions): Excel.SlicerItem;

参数

options

Excel.Interfaces.SlicerItemLoadOptions

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

返回

Excel.SlicerItem

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.SlicerItem

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.SlicerItem

set(properties, options)

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

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

参数

properties

Excel.Interfaces.SlicerItemUpdateData

一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.SlicerItem): void;

参数

properties

Excel.SlicerItem

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.SlicerItemData;

返回

Excel.Interfaces.SlicerItemData