/
excel.iconset.yml
167 lines (156 loc) · 6.96 KB
/
excel.iconset.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
### YamlMime:TSEnum
name: Excel.IconSet
uid: 'excel!Excel.IconSet:enum'
package: excel!
fullName: Excel.IconSet
summary: ''
remarks: >-
\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B8:E13");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.iconSet);
const iconSetCF = conditionalFormat.iconSet;
iconSetCF.style = Excel.IconSet.threeTriangles;
/*
The iconSetCF.criteria array is automatically prepopulated with
criterion elements whose properties have been given default settings.
You can't write to each property of a criterion directly. Instead,
replace the whole criteria object.
With a "three*" icon set style, such as "threeTriangles", the third
element in the criteria array (criteria[2]) defines the "top" icon;
e.g., a green triangle. The second (criteria[1]) defines the "middle"
icon. The first (criteria[0]) defines the "low" icon, but it
can often be left empty as the following object shows, because every
cell that does not match the other two criteria always gets the low
icon.
*/
iconSetCF.criteria = [
{} as any,
{
type: Excel.ConditionalFormatIconRuleType.number,
operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
formula: "=700"
},
{
type: Excel.ConditionalFormatIconRuleType.number,
operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
formula: "=1000",
}
];
await context.sync();
});
```
isPreview: false
isDeprecated: false
fields:
- name: fiveArrows
uid: 'excel!Excel.IconSet.fiveArrows:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FiveArrows"'
- name: fiveArrowsGray
uid: 'excel!Excel.IconSet.fiveArrowsGray:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FiveArrowsGray"'
- name: fiveBoxes
uid: 'excel!Excel.IconSet.fiveBoxes:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FiveBoxes"'
- name: fiveQuarters
uid: 'excel!Excel.IconSet.fiveQuarters:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FiveQuarters"'
- name: fiveRating
uid: 'excel!Excel.IconSet.fiveRating:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FiveRating"'
- name: fourArrows
uid: 'excel!Excel.IconSet.fourArrows:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FourArrows"'
- name: fourArrowsGray
uid: 'excel!Excel.IconSet.fourArrowsGray:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FourArrowsGray"'
- name: fourRating
uid: 'excel!Excel.IconSet.fourRating:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FourRating"'
- name: fourRedToBlack
uid: 'excel!Excel.IconSet.fourRedToBlack:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FourRedToBlack"'
- name: fourTrafficLights
uid: 'excel!Excel.IconSet.fourTrafficLights:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"FourTrafficLights"'
- name: invalid
uid: 'excel!Excel.IconSet.invalid:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Invalid"'
- name: threeArrows
uid: 'excel!Excel.IconSet.threeArrows:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeArrows"'
- name: threeArrowsGray
uid: 'excel!Excel.IconSet.threeArrowsGray:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeArrowsGray"'
- name: threeFlags
uid: 'excel!Excel.IconSet.threeFlags:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeFlags"'
- name: threeSigns
uid: 'excel!Excel.IconSet.threeSigns:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeSigns"'
- name: threeStars
uid: 'excel!Excel.IconSet.threeStars:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeStars"'
- name: threeSymbols
uid: 'excel!Excel.IconSet.threeSymbols:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeSymbols"'
- name: threeSymbols2
uid: 'excel!Excel.IconSet.threeSymbols2:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeSymbols2"'
- name: threeTrafficLights1
uid: 'excel!Excel.IconSet.threeTrafficLights1:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeTrafficLights1"'
- name: threeTrafficLights2
uid: 'excel!Excel.IconSet.threeTrafficLights2:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeTrafficLights2"'
- name: threeTriangles
uid: 'excel!Excel.IconSet.threeTriangles:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"ThreeTriangles"'