/
excel.filter.yml
385 lines (385 loc) · 15.8 KB
/
excel.filter.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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
### YamlMime:TSType
name: Excel.Filter
uid: 'excel!Excel.Filter:class'
package: excel!
fullName: Excel.Filter
summary: Manages the filtering of a table's column.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.Filter#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
- name: criteria
uid: 'excel!Excel.Filter#criteria:member'
package: excel!
fullName: criteria
summary: The currently applied filter on the given column.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly criteria: Excel.FilterCriteria;'
return:
type: '<xref uid="excel!Excel.FilterCriteria:interface" />'
methods:
- name: apply(criteria)
uid: 'excel!Excel.Filter#apply:member(1)'
package: excel!
fullName: apply(criteria)
summary: Apply the given filter criteria on the given column.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'apply(criteria: Excel.FilterCriteria): void;'
parameters:
- id: criteria
description: The criteria to apply.
type: '<xref uid="excel!Excel.FilterCriteria:interface" />'
return:
type: void
description: ''
- name: applyBottomItemsFilter(count)
uid: 'excel!Excel.Filter#applyBottomItemsFilter:member(1)'
package: excel!
fullName: applyBottomItemsFilter(count)
summary: Apply a "Bottom Item" filter to the column for the given number of elements.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyBottomItemsFilter(count: number): void;'
parameters:
- id: count
description: The number of elements from the bottom to show.
type: number
return:
type: void
description: ''
- name: applyBottomPercentFilter(percent)
uid: 'excel!Excel.Filter#applyBottomPercentFilter:member(1)'
package: excel!
fullName: applyBottomPercentFilter(percent)
summary: Apply a "Bottom Percent" filter to the column for the given percentage of elements.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyBottomPercentFilter(percent: number): void;'
parameters:
- id: percent
description: The percentage of elements from the bottom to show.
type: number
return:
type: void
description: ''
- name: applyCellColorFilter(color)
uid: 'excel!Excel.Filter#applyCellColorFilter:member(1)'
package: excel!
fullName: applyCellColorFilter(color)
summary: Apply a "Cell Color" filter to the column for the given color.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyCellColorFilter(color: string): void;'
parameters:
- id: color
description: The background color of the cells to show.
type: string
return:
type: void
description: ''
- name: 'applyCustomFilter(criteria1, criteria2, oper)'
uid: 'excel!Excel.Filter#applyCustomFilter:member(1)'
package: excel!
fullName: 'applyCustomFilter(criteria1, criteria2, oper)'
summary: Apply an "Icon" filter to the column for the given criteria strings.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator): void;'
parameters:
- id: criteria1
description: The first criteria string.
type: string
- id: criteria2
description: Optional. The second criteria string.
type: string
- id: oper
description: Optional. The operator that describes how the two criteria are joined.
type: '<xref uid="excel!Excel.FilterOperator:enum" />'
return:
type: void
description: ''
- name: 'applyCustomFilter(criteria1, criteria2, operString)'
uid: 'excel!Excel.Filter#applyCustomFilter:member(2)'
package: excel!
fullName: 'applyCustomFilter(criteria1, criteria2, operString)'
summary: Apply an "Icon" filter to the column for the given criteria strings.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;'
parameters:
- id: criteria1
description: The first criteria string.
type: string
- id: criteria2
description: Optional. The second criteria string.
type: string
- id: operString
description: Optional. The operator that describes how the two criteria are joined.
type: '"And" | "Or"'
return:
type: void
description: ''
- name: applyDynamicFilter(criteria)
uid: 'excel!Excel.Filter#applyDynamicFilter:member(1)'
package: excel!
fullName: applyDynamicFilter(criteria)
summary: Apply a "Dynamic" filter to the column.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;'
parameters:
- id: criteria
description: The dynamic criteria to apply.
type: '<xref uid="excel!Excel.DynamicFilterCriteria:enum" />'
return:
type: void
description: ''
- name: applyDynamicFilter(criteriaString)
uid: 'excel!Excel.Filter#applyDynamicFilter:member(2)'
package: excel!
fullName: applyDynamicFilter(criteriaString)
summary: Apply a "Dynamic" filter to the column.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
applyDynamicFilter(criteriaString: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" |
"AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" |
"AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" |
"AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2"
| "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" |
"LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" |
"ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"):
void;
parameters:
- id: criteriaString
description: The dynamic criteria to apply.
type: >-
"Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember"
| "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" |
"AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" |
"AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" |
"AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" |
"LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" |
"ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"
return:
type: void
description: ''
- name: applyFontColorFilter(color)
uid: 'excel!Excel.Filter#applyFontColorFilter:member(1)'
package: excel!
fullName: applyFontColorFilter(color)
summary: Apply a "Font Color" filter to the column for the given color.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyFontColorFilter(color: string): void;'
parameters:
- id: color
description: The font color of the cells to show.
type: string
return:
type: void
description: ''
- name: applyIconFilter(icon)
uid: 'excel!Excel.Filter#applyIconFilter:member(1)'
package: excel!
fullName: applyIconFilter(icon)
summary: Apply an "Icon" filter to the column for the given icon.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyIconFilter(icon: Excel.Icon): void;'
parameters:
- id: icon
description: The icons of the cells to show.
type: '<xref uid="excel!Excel.Icon:interface" />'
return:
type: void
description: ''
- name: applyTopItemsFilter(count)
uid: 'excel!Excel.Filter#applyTopItemsFilter:member(1)'
package: excel!
fullName: applyTopItemsFilter(count)
summary: Apply a "Top Item" filter to the column for the given number of elements.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyTopItemsFilter(count: number): void;'
parameters:
- id: count
description: The number of elements from the top to show.
type: number
return:
type: void
description: ''
- name: applyTopPercentFilter(percent)
uid: 'excel!Excel.Filter#applyTopPercentFilter:member(1)'
package: excel!
fullName: applyTopPercentFilter(percent)
summary: Apply a "Top Percent" filter to the column for the given percentage of elements.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyTopPercentFilter(percent: number): void;'
parameters:
- id: percent
description: The percentage of elements from the top to show.
type: number
return:
type: void
description: ''
- name: applyValuesFilter(values)
uid: 'excel!Excel.Filter#applyValuesFilter:member(1)'
package: excel!
fullName: applyValuesFilter(values)
summary: Apply a "Values" filter to the column for the given values.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'applyValuesFilter(values: Array<string | FilterDatetime>): void;'
parameters:
- id: values
description: The list of values to show. This must be an array of strings or an array of `Excel.FilterDateTime` objects.
type: 'Array<string | <xref uid="excel!Excel.FilterDatetime:interface" />>'
return:
type: void
description: ''
- name: clear()
uid: 'excel!Excel.Filter#clear:member(1)'
package: excel!
fullName: clear()
summary: Clear the filter on the given column.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'clear(): void;'
return:
type: void
description: ''
- name: load(options)
uid: 'excel!Excel.Filter#load:member(1)'
package: excel!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.FilterLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.Filter:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.Filter#load:member(2)'
package: excel!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Excel.Filter;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="excel!Excel.Filter:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.Filter#load:member(3)'
package: excel!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Filter;
parameters:
- id: propertyNamesAndPaths
description: >-
`propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
`propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="excel!Excel.Filter:class" />'
description: ''
- name: toJSON()
uid: 'excel!Excel.Filter#toJSON:member(1)'
package: excel!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original Excel.Filter object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.FilterData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.FilterData;'
return:
type: '<xref uid="excel!Excel.Interfaces.FilterData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'