-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.filteron.yml
81 lines (77 loc) · 3.13 KB
/
excel.filteron.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
### YamlMime:TSEnum
name: Excel.FilterOn
uid: 'excel!Excel.FilterOn:enum'
package: excel!
fullName: Excel.FilterOn
summary: ''
remarks: |-
\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// This function adds a custom AutoFilter to the active worksheet
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
// Retrieve the active worksheet and the used range on that worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
const farmData = sheet.getUsedRange();
// Add a filter that will only show the rows with values that end with the letter "e" in column 1.
sheet.autoFilter.apply(farmData, 1, {
criterion1: "=*e",
filterOn: Excel.FilterOn.custom
});
await context.sync();
});
```
isPreview: false
isDeprecated: false
fields:
- name: bottomItems
uid: 'excel!Excel.FilterOn.bottomItems:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"BottomItems"'
- name: bottomPercent
uid: 'excel!Excel.FilterOn.bottomPercent:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"BottomPercent"'
- name: cellColor
uid: 'excel!Excel.FilterOn.cellColor:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"CellColor"'
- name: custom
uid: 'excel!Excel.FilterOn.custom:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Custom"'
- name: dynamic
uid: 'excel!Excel.FilterOn.dynamic:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Dynamic"'
- name: fontColor
uid: 'excel!Excel.FilterOn.fontColor:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FontColor"'
- name: icon
uid: 'excel!Excel.FilterOn.icon:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Icon"'
- name: topItems
uid: 'excel!Excel.FilterOn.topItems:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"TopItems"'
- name: topPercent
uid: 'excel!Excel.FilterOn.topPercent:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"TopPercent"'
- name: values
uid: 'excel!Excel.FilterOn.values:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Values"'