-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.pivotvaluefilter.yml
118 lines (118 loc) · 4.81 KB
/
excel.pivotvaluefilter.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
### YamlMime:TSType
name: Excel.PivotValueFilter
uid: 'excel!Excel.PivotValueFilter:interface'
package: excel!
fullName: Excel.PivotValueFilter
summary: >-
Configurable template for a value filter to apply to a PivotField. The `condition` defines what criteria need to be
set in order for the filter to operate.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: comparator
uid: 'excel!Excel.PivotValueFilter#comparator:member'
package: excel!
fullName: comparator
summary: >-
The comparator is the static value to which other values are compared. The type of comparison is defined by the
condition. For example, if comparator is "50" and condition is "greaterThan", all item values that are not greater
than 50 will be removed by the filter.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'comparator?: number;'
return:
type: number
- name: condition
uid: 'excel!Excel.PivotValueFilter#condition:member'
package: excel!
fullName: condition
summary: 'Specifies the condition for the filter, which defines the necessary filtering criteria.'
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" |
"LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN";
return:
type: >-
<xref uid="excel!Excel.ValueFilterCondition:enum" /> | "Unknown" | "Equals" | "GreaterThan" |
"GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"
- name: exclusive
uid: 'excel!Excel.PivotValueFilter#exclusive:member'
package: excel!
fullName: exclusive
summary: >-
If `true`<!-- -->, filter *excludes* items that meet criteria. The default is `false` (filter to include items
that meet criteria).
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'exclusive?: boolean;'
return:
type: boolean
- name: lowerBound
uid: 'excel!Excel.PivotValueFilter#lowerBound:member'
package: excel!
fullName: lowerBound
summary: The lower-bound of the range for the `between` filter condition.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'lowerBound?: number;'
return:
type: number
- name: selectionType
uid: 'excel!Excel.PivotValueFilter#selectionType:member'
package: excel!
fullName: selectionType
summary: 'Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum.'
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum";'
return:
type: '<xref uid="excel!Excel.TopBottomSelectionType:enum" /> | "Items" | "Percent" | "Sum"'
- name: threshold
uid: 'excel!Excel.PivotValueFilter#threshold:member'
package: excel!
fullName: threshold
summary: 'The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition.'
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'threshold?: number;'
return:
type: number
- name: upperBound
uid: 'excel!Excel.PivotValueFilter#upperBound:member'
package: excel!
fullName: upperBound
summary: The upper-bound of the range for the `between` filter condition.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'upperBound?: number;'
return:
type: number
- name: value
uid: 'excel!Excel.PivotValueFilter#value:member'
package: excel!
fullName: value
summary: Name of the chosen "value" in the field by which to filter.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'value: string;'
return:
type: string