-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.interfaces.slicerdata.yml
168 lines (168 loc) · 6.38 KB
/
excel.interfaces.slicerdata.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
### YamlMime:TSType
name: Excel.Interfaces.SlicerData
uid: 'excel!Excel.Interfaces.SlicerData:interface'
package: excel!
fullName: Excel.Interfaces.SlicerData
summary: An interface describing the data returned by calling `slicer.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: caption
uid: 'excel!Excel.Interfaces.SlicerData#caption:member'
package: excel!
fullName: caption
summary: Represents the caption of the slicer.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'caption?: string;'
return:
type: string
- name: height
uid: 'excel!Excel.Interfaces.SlicerData#height:member'
package: excel!
fullName: height
summary: >-
Represents the height, in points, of the slicer. Throws an `InvalidArgument` exception when set with a negative
value or zero as an input.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'height?: number;'
return:
type: number
- name: id
uid: 'excel!Excel.Interfaces.SlicerData#id:member'
package: excel!
fullName: id
summary: Represents the unique ID of the slicer.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'id?: string;'
return:
type: string
- name: isFilterCleared
uid: 'excel!Excel.Interfaces.SlicerData#isFilterCleared:member'
package: excel!
fullName: isFilterCleared
summary: Value is `true` if all filters currently applied on the slicer are cleared.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'isFilterCleared?: boolean;'
return:
type: boolean
- name: left
uid: 'excel!Excel.Interfaces.SlicerData#left:member'
package: excel!
fullName: left
summary: >-
Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an
`InvalidArgument` error when set with a negative value as an input.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'left?: number;'
return:
type: number
- name: name
uid: 'excel!Excel.Interfaces.SlicerData#name:member'
package: excel!
fullName: name
summary: Represents the name of the slicer.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name?: string;'
return:
type: string
- name: slicerItems
uid: 'excel!Excel.Interfaces.SlicerData#slicerItems:member'
package: excel!
fullName: slicerItems
summary: Represents the collection of slicer items that are part of the slicer.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'slicerItems?: Excel.Interfaces.SlicerItemData[];'
return:
type: '<xref uid="excel!Excel.Interfaces.SlicerItemData:interface" />[]'
- name: sortBy
uid: 'excel!Excel.Interfaces.SlicerData#sortBy:member'
package: excel!
fullName: sortBy
summary: >-
Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending",
"Descending".
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";'
return:
type: '<xref uid="excel!Excel.SlicerSortType:enum" /> | "DataSourceOrder" | "Ascending" | "Descending"'
- name: style
uid: 'excel!Excel.Interfaces.SlicerData#style:member'
package: excel!
fullName: style
summary: >-
Constant value that represents the slicer style. Possible values are: "SlicerStyleLight1" through
"SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6".
A custom user-defined style present in the workbook can also be specified.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'style?: string;'
return:
type: string
- name: top
uid: 'excel!Excel.Interfaces.SlicerData#top:member'
package: excel!
fullName: top
summary: >-
Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an
`InvalidArgument` error when set with a negative value as an input.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'top?: number;'
return:
type: number
- name: width
uid: 'excel!Excel.Interfaces.SlicerData#width:member'
package: excel!
fullName: width
summary: >-
Represents the width, in points, of the slicer. Throws an `InvalidArgument` error when set with a negative value
or zero as an input.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'width?: number;'
return:
type: number
- name: worksheet
uid: 'excel!Excel.Interfaces.SlicerData#worksheet:member'
package: excel!
fullName: worksheet
summary: Represents the worksheet containing the slicer.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'worksheet?: Excel.Interfaces.WorksheetData;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorksheetData:interface" />'