-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.rangefill.yml
275 lines (270 loc) · 10.7 KB
/
excel.rangefill.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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
### YamlMime:TSType
name: Excel.RangeFill
uid: 'excel!Excel.RangeFill:class'
package: excel!
fullName: Excel.RangeFill
summary: Represents the background of a range object.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: color
uid: 'excel!Excel.RangeFill#color:member'
package: excel!
fullName: color
summary: >-
HTML color code representing the color of the background, in the form \#RRGGBB (e.g., "FFA500"), or as a named
HTML color (e.g., "orange")
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'color: string;'
return:
type: string
- name: context
uid: 'excel!Excel.RangeFill#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
- name: pattern
uid: 'excel!Excel.RangeFill#pattern:member'
package: excel!
fullName: pattern
summary: >-
The pattern of a range. See `Excel.FillPattern` for details. LinearGradient and RectangularGradient are not
supported. A `null` value indicates that the entire range doesn't have a uniform pattern setting.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" |
"Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" |
"Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";
return:
type: >-
<xref uid="excel!Excel.FillPattern:enum" /> | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal"
| "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" |
"LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"
- name: patternColor
uid: 'excel!Excel.RangeFill#patternColor:member'
package: excel!
fullName: patternColor
summary: >-
The HTML color code representing the color of the range pattern, in the form \#RRGGBB (e.g., "FFA500"), or as a
named HTML color (e.g., "orange").
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'patternColor: string;'
return:
type: string
- name: patternTintAndShade
uid: 'excel!Excel.RangeFill#patternTintAndShade:member'
package: excel!
fullName: patternTintAndShade
summary: >-
Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest)
and 1 (brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
`patternTintAndShade` settings.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'patternTintAndShade: number;'
return:
type: number
- name: tintAndShade
uid: 'excel!Excel.RangeFill#tintAndShade:member'
package: excel!
fullName: tintAndShade
summary: >-
Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1
(brightest), with 0 for the original color. A `null` value indicates that the range doesn't have uniform
`tintAndShade` settings.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tintAndShade: number;'
return:
type: number
methods:
- name: clear()
uid: 'excel!Excel.RangeFill#clear:member(1)'
package: excel!
fullName: clear()
summary: Resets the range background.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const rangeFill = range.format.fill;
rangeFill.clear();
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'clear(): void;'
return:
type: void
description: ''
- name: load(options)
uid: 'excel!Excel.RangeFill#load:member(1)'
package: excel!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.RangeFillLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.RangeFill:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.RangeFill#load:member(2)'
package: excel!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Excel.RangeFill;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="excel!Excel.RangeFill:class" />'
description: |-
#### Examples
```TypeScript
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const rangeFill = range.format.fill;
rangeFill.load('color');
await context.sync();
console.log(rangeFill.color);
});
```
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.RangeFill#load:member(3)'
package: excel!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeFill;
parameters:
- id: propertyNamesAndPaths
description: >-
`propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
`propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="excel!Excel.RangeFill:class" />'
description: ''
- name: 'set(properties, options)'
uid: 'excel!Excel.RangeFill#set:member(1)'
package: excel!
fullName: 'set(properties, options)'
summary: >-
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
properties, or another API object of the same type.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Interfaces.RangeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;'
parameters:
- id: properties
description: >-
A JavaScript object with properties that are structured isomorphically to the properties of the object on
which the method is called.
type: '<xref uid="excel!Excel.Interfaces.RangeFillUpdateData:interface" />'
- id: options
description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
return:
type: void
description: ''
- name: set(properties)
uid: 'excel!Excel.RangeFill#set:member(2)'
package: excel!
fullName: set(properties)
summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Excel.RangeFill): void;'
parameters:
- id: properties
description: ''
type: '<xref uid="excel!Excel.RangeFill:class" />'
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.RangeFill#toJSON:member(1)'
package: excel!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original Excel.RangeFill object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.RangeFillData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.RangeFillData;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeFillData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'