-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.conditionalformatcolorcriteriontype.yml
73 lines (64 loc) · 3.08 KB
/
excel.conditionalformatcolorcriteriontype.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
### YamlMime:TSEnum
name: Excel.ConditionalFormatColorCriterionType
uid: 'excel!Excel.ConditionalFormatColorCriterionType:enum'
package: excel!
fullName: Excel.ConditionalFormatColorCriterionType
summary: Represents the types of color criterion for conditional formatting.
remarks: >-
\[ [API set: ExcelApi 1.6](/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("B2:M5");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.colorScale);
const criteria = {
minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
};
conditionalFormat.colorScale.criteria = criteria;
await context.sync();
});
```
isPreview: false
isDeprecated: false
fields:
- name: formula
uid: 'excel!Excel.ConditionalFormatColorCriterionType.formula:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Formula"'
- name: highestValue
uid: 'excel!Excel.ConditionalFormatColorCriterionType.highestValue:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"HighestValue"'
- name: invalid
uid: 'excel!Excel.ConditionalFormatColorCriterionType.invalid:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Invalid"'
- name: lowestValue
uid: 'excel!Excel.ConditionalFormatColorCriterionType.lowestValue:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"LowestValue"'
- name: number
uid: 'excel!Excel.ConditionalFormatColorCriterionType.number:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Number"'
- name: percent
uid: 'excel!Excel.ConditionalFormatColorCriterionType.percent:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Percent"'
- name: percentile
uid: 'excel!Excel.ConditionalFormatColorCriterionType.percentile:member'
package: excel!
summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
value: '"Percentile"'