Excel.Slicer class

表示工作簿中的对象 Slicer 。

扩展

属性

caption

表示切片器的描述文字。

context

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

height

指定切片器的高度(以磅为单位)。 使用负值或零作为输入时引发 InvalidArgument 异常。

id

表示切片器的唯一 ID。

isFilterCleared

值为 true 清除切片器上当前应用的所有筛选器。

left

表示从切片器左侧到工作表左侧的距离(以磅为单位)。 以负值作为输入时引发 InvalidArgument 错误。

name

表示切片器的名称。

slicerItems

表示属于切片器的切片器项的集合。

sortBy

指定切片器中项目的排序顺序。 可能的值为:“DataSourceOrder”、“Ascending”、“Descending”。

style

表示切片器样式的常量值。 可能的值为:“SlicerStyleLight1”到“SlicerStyleLight6”、“TableStyleOther1”到“TableStyleOther2”、“SlicerStyleDark1”到“SlicerStyleDark6”。 还可以指定工作簿中显示的用户定义的自定义样式。

top

表示从切片器上边缘到工作表顶部的距离(以磅为单位)。 以负值作为输入时引发 InvalidArgument 错误。

width

表示切片器的宽度(以磅为单位)。 以负值或零作为输入时引发 InvalidArgument 错误。

worksheet

表示包含切片器的工作表。

方法

clearFilters()

清除当前切片器上应用的所有筛选器。

delete()

删除切片器。

getSelectedItems()

返回所选项目密钥的数组。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

selectItems(items)

根据切片器项的键选择切片器项。 前面的选择将被清除。 如果数组为空,则默认情况下将选择所有项。

set(properties, options)

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

set(properties)

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

toJSON()

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

属性详细信息

caption

表示切片器的描述文字。

caption: string;

属性值

string

注解

API 集:ExcelApi 1.10

context

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

context: RequestContext;

属性值

height

指定切片器的高度(以磅为单位)。 使用负值或零作为输入时引发 InvalidArgument 异常。

height: number;

属性值

number

注解

API 集:ExcelApi 1.10

id

表示切片器的唯一 ID。

readonly id: string;

属性值

string

注解

API 集:ExcelApi 1.10

isFilterCleared

值为 true 清除切片器上当前应用的所有筛选器。

readonly isFilterCleared: boolean;

属性值

boolean

注解

API 集:ExcelApi 1.10

left

表示从切片器左侧到工作表左侧的距离(以磅为单位)。 以负值作为输入时引发 InvalidArgument 错误。

left: number;

属性值

number

注解

API 集:ExcelApi 1.10

name

表示切片器的名称。

name: string;

属性值

string

注解

API 集:ExcelApi 1.10

slicerItems

表示属于切片器的切片器项的集合。

readonly slicerItems: Excel.SlicerItemCollection;

属性值

注解

API 集:ExcelApi 1.10

sortBy

指定切片器中项目的排序顺序。 可能的值为:“DataSourceOrder”、“Ascending”、“Descending”。

sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";

属性值

Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"

注解

API 集:ExcelApi 1.10

style

表示切片器样式的常量值。 可能的值为:“SlicerStyleLight1”到“SlicerStyleLight6”、“TableStyleOther1”到“TableStyleOther2”、“SlicerStyleDark1”到“SlicerStyleDark6”。 还可以指定工作簿中显示的用户定义的自定义样式。

style: string;

属性值

string

注解

API 集:ExcelApi 1.10

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.style = "SlicerStyleLight6";
    await context.sync();
});

top

表示从切片器上边缘到工作表顶部的距离(以磅为单位)。 以负值作为输入时引发 InvalidArgument 错误。

top: number;

属性值

number

注解

API 集:ExcelApi 1.10

width

表示切片器的宽度(以磅为单位)。 以负值或零作为输入时引发 InvalidArgument 错误。

width: number;

属性值

number

注解

API 集:ExcelApi 1.10

worksheet

表示包含切片器的工作表。

readonly worksheet: Excel.Worksheet;

属性值

注解

API 集:ExcelApi 1.10

方法详细信息

clearFilters()

清除当前切片器上应用的所有筛选器。

clearFilters(): void;

返回

void

注解

API 集:ExcelApi 1.10

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.clearFilters();
    await context.sync();
});

delete()

删除切片器。

delete(): void;

返回

void

注解

API 集:ExcelApi 1.10

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.slicers.getItemAt(0).delete();
    await context.sync();
});

getSelectedItems()

返回所选项目密钥的数组。

getSelectedItems(): OfficeExtension.ClientResult<string[]>;

返回

注解

API 集:ExcelApi 1.10

load(options)

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

load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer;

参数

options
Excel.Interfaces.SlicerLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

selectItems(items)

根据切片器项的键选择切片器项。 前面的选择将被清除。 如果数组为空,则默认情况下将选择所有项。

selectItems(items?: string[]): void;

参数

items

string[]

可选。 要选择的指定切片器项名称。

返回

void

注解

API 集:ExcelApi 1.10

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const slicer = context.workbook.slicers.getItem("Fruit Slicer");
    slicer.selectItems(["Lemon", "Lime", "Orange"]);
    await context.sync();
});

set(properties, options)

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

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

参数

properties
Excel.Interfaces.SlicerUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.Slicer): void;

参数

properties
Excel.Slicer

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.SlicerData;

返回