/
excel.interfaces.iconsetconditionalformatdata.yml
72 lines (72 loc) · 3.37 KB
/
excel.interfaces.iconsetconditionalformatdata.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
### YamlMime:TSType
name: Excel.Interfaces.IconSetConditionalFormatData
uid: 'excel!Excel.Interfaces.IconSetConditionalFormatData:interface'
package: excel!
fullName: Excel.Interfaces.IconSetConditionalFormatData
summary: An interface describing the data returned by calling `iconSetConditionalFormat.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: criteria
uid: 'excel!Excel.Interfaces.IconSetConditionalFormatData#criteria:member'
package: excel!
fullName: criteria
summary: >-
An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for
the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when
set.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'criteria?: Excel.ConditionalIconCriterion[];'
return:
type: '<xref uid="excel!Excel.ConditionalIconCriterion:interface" />[]'
- name: reverseIconOrder
uid: 'excel!Excel.Interfaces.IconSetConditionalFormatData#reverseIconOrder:member'
package: excel!
fullName: reverseIconOrder
summary: >-
If `true`<!-- -->, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are
used.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'reverseIconOrder?: boolean;'
return:
type: boolean
- name: showIconOnly
uid: 'excel!Excel.Interfaces.IconSetConditionalFormatData#showIconOnly:member'
package: excel!
fullName: showIconOnly
summary: 'If `true`<!-- -->, hides the values and only shows icons.'
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showIconOnly?: boolean;'
return:
type: boolean
- name: style
uid: 'excel!Excel.Interfaces.IconSetConditionalFormatData#style:member'
package: excel!
fullName: style
summary: 'If set, displays the icon set option for the conditional format.'
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" |
"ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" |
"FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" |
"FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes";
return:
type: >-
<xref uid="excel!Excel.IconSet:enum" /> | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" |
"ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows"
| "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" |
"FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"