Excel.Slicer class
表示 Slicer
工作簿中的 对象。
- 扩展
注解
属性
caption | 表示切片器的标题。 |
context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
height | 表示切片器的高度(以磅为单位)。
|
id | 表示切片器的唯一 ID。 |
is |
|
left | 表示从切片器左侧到工作表左侧的距离(以磅为单位)。
|
name | 表示切片器的名称。 |
slicer |
表示属于切片器的切片器项的集合。 |
sort |
表示切片器中的项目的排序顺序。 可能的值为:“DataSourceOrder”、“Ascending”、“Descending”。 |
style | 表示切片器样式的常量值。 可能的值为:“SlicerStyleLight1”到“SlicerStyleLight6”、“TableStyleOther1”到“TableStyleOther2”、“SlicerStyleDark1”到“SlicerStyleDark6”。 还可以指定工作簿中显示的用户定义的自定义样式。 |
top | 表示从切片器上边缘到工作表顶部的距离(以磅为单位)。
|
width | 表示切片器的宽度(以磅为单位)。
|
worksheet | 表示包含切片器的工作表。 |
方法
clear |
清除当前切片器上应用的所有筛选器。 |
delete() | 删除切片器。 |
get |
返回所选项目密钥的数组。 |
load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
select |
根据切片器项的键选择切片器项。 清除前面的选择。 如果数组为空,则默认选择所有项。 |
set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。 |
set(properties) | 基于现有的已加载对象,同时对对象设置多个属性。 |
toJSON() | 重写 JavaScript |
属性详细信息
caption
context
height
表示切片器的高度(以磅为单位)。
InvalidArgument
使用负值或零作为输入进行设置时引发异常。
height: number;
属性值
number
注解
id
isFilterCleared
true
如果清除了切片器上当前应用的所有筛选器,则值为值。
readonly isFilterCleared: boolean;
属性值
boolean
注解
left
表示从切片器左侧到工作表左侧的距离(以磅为单位)。
InvalidArgument
将负值设置为输入时引发错误。
left: number;
属性值
number
注解
name
slicerItems
表示属于切片器的切片器项的集合。
readonly slicerItems: Excel.SlicerItemCollection;
属性值
注解
sortBy
表示切片器中的项目的排序顺序。 可能的值为:“DataSourceOrder”、“Ascending”、“Descending”。
sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";
属性值
Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"
注解
style
表示切片器样式的常量值。 可能的值为:“SlicerStyleLight1”到“SlicerStyleLight6”、“TableStyleOther1”到“TableStyleOther2”、“SlicerStyleDark1”到“SlicerStyleDark6”。 还可以指定工作簿中显示的用户定义的自定义样式。
style: string;
属性值
string
注解
示例
// 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
注解
width
表示切片器的宽度(以磅为单位)。
InvalidArgument
使用负值或零作为输入进行设置时引发错误。
width: number;
属性值
number
注解
worksheet
方法详细信息
clearFilters()
清除当前切片器上应用的所有筛选器。
clearFilters(): void;
返回
void
注解
示例
// 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
注解
示例
// 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[]>;
返回
OfficeExtension.ClientResult<string[]>
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer;
参数
提供要加载对象的属性的选项。
返回
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
注解
示例
// 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)
toJSON()
重写 JavaScript toJSON()
方法,以便在将 API 对象传递给 JSON.stringify()
时提供更有用的输出。
JSON.stringify
(,反过来又调用toJSON
传递给它的 对象的 方法。) 而原始 Excel.Slicer 对象是 API 对象,toJSON
该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.SlicerData
) ,该对象包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.SlicerData;