@univerjs/sheets-conditional-formatting 0.6.1 → 0.6.2-nightly.202503031606

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE DELETED
@@ -1,176 +0,0 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction,
10
- and distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by
13
- the copyright owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all
16
- other entities that control, are controlled by, or are under common
17
- control with that entity. For the purposes of this definition,
18
- "control" means (i) the power, direct or indirect, to cause the
19
- direction or management of such entity, whether by contract or
20
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
- outstanding shares, or (iii) beneficial ownership of such entity.
22
-
23
- "You" (or "Your") shall mean an individual or Legal Entity
24
- exercising permissions granted by this License.
25
-
26
- "Source" form shall mean the preferred form for making modifications,
27
- including but not limited to software source code, documentation
28
- source, and configuration files.
29
-
30
- "Object" form shall mean any form resulting from mechanical
31
- transformation or translation of a Source form, including but
32
- not limited to compiled object code, generated documentation,
33
- and conversions to other media types.
34
-
35
- "Work" shall mean the work of authorship, whether in Source or
36
- Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work
38
- (an example is provided in the Appendix below).
39
-
40
- "Derivative Works" shall mean any work, whether in Source or Object
41
- form, that is based on (or derived from) the Work and for which the
42
- editorial revisions, annotations, elaborations, or other modifications
43
- represent, as a whole, an original work of authorship. For the purposes
44
- of this License, Derivative Works shall not include works that remain
45
- separable from, or merely link (or bind by name) to the interfaces of,
46
- the Work and Derivative Works thereof.
47
-
48
- "Contribution" shall mean any work of authorship, including
49
- the original version of the Work and any modifications or additions
50
- to that Work or Derivative Works thereof, that is intentionally
51
- submitted to Licensor for inclusion in the Work by the copyright owner
52
- or by an individual or Legal Entity authorized to submit on behalf of
53
- the copyright owner. For the purposes of this definition, "submitted"
54
- means any form of electronic, verbal, or written communication sent
55
- to the Licensor or its representatives, including but not limited to
56
- communication on electronic mailing lists, source code control systems,
57
- and issue tracking systems that are managed by, or on behalf of, the
58
- Licensor for the purpose of discussing and improving the Work, but
59
- excluding communication that is conspicuously marked or otherwise
60
- designated in writing by the copyright owner as "Not a Contribution."
61
-
62
- "Contributor" shall mean Licensor and any individual or Legal Entity
63
- on behalf of whom a Contribution has been received by Licensor and
64
- subsequently incorporated within the Work.
65
-
66
- 2. Grant of Copyright License. Subject to the terms and conditions of
67
- this License, each Contributor hereby grants to You a perpetual,
68
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
- copyright license to reproduce, prepare Derivative Works of,
70
- publicly display, publicly perform, sublicense, and distribute the
71
- Work and such Derivative Works in Source or Object form.
72
-
73
- 3. Grant of Patent License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- (except as stated in this section) patent license to make, have made,
77
- use, offer to sell, sell, import, and otherwise transfer the Work,
78
- where such license applies only to those patent claims licensable
79
- by such Contributor that are necessarily infringed by their
80
- Contribution(s) alone or by combination of their Contribution(s)
81
- with the Work to which such Contribution(s) was submitted. If You
82
- institute patent litigation against any entity (including a
83
- cross-claim or counterclaim in a lawsuit) alleging that the Work
84
- or a Contribution incorporated within the Work constitutes direct
85
- or contributory patent infringement, then any patent licenses
86
- granted to You under this License for that Work shall terminate
87
- as of the date such litigation is filed.
88
-
89
- 4. Redistribution. You may reproduce and distribute copies of the
90
- Work or Derivative Works thereof in any medium, with or without
91
- modifications, and in Source or Object form, provided that You
92
- meet the following conditions:
93
-
94
- (a) You must give any other recipients of the Work or
95
- Derivative Works a copy of this License; and
96
-
97
- (b) You must cause any modified files to carry prominent notices
98
- stating that You changed the files; and
99
-
100
- (c) You must retain, in the Source form of any Derivative Works
101
- that You distribute, all copyright, patent, trademark, and
102
- attribution notices from the Source form of the Work,
103
- excluding those notices that do not pertain to any part of
104
- the Derivative Works; and
105
-
106
- (d) If the Work includes a "NOTICE" text file as part of its
107
- distribution, then any Derivative Works that You distribute must
108
- include a readable copy of the attribution notices contained
109
- within such NOTICE file, excluding those notices that do not
110
- pertain to any part of the Derivative Works, in at least one
111
- of the following places: within a NOTICE text file distributed
112
- as part of the Derivative Works; within the Source form or
113
- documentation, if provided along with the Derivative Works; or,
114
- within a display generated by the Derivative Works, if and
115
- wherever such third-party notices normally appear. The contents
116
- of the NOTICE file are for informational purposes only and
117
- do not modify the License. You may add Your own attribution
118
- notices within Derivative Works that You distribute, alongside
119
- or as an addendum to the NOTICE text from the Work, provided
120
- that such additional attribution notices cannot be construed
121
- as modifying the License.
122
-
123
- You may add Your own copyright statement to Your modifications and
124
- may provide additional or different license terms and conditions
125
- for use, reproduction, or distribution of Your modifications, or
126
- for any such Derivative Works as a whole, provided Your use,
127
- reproduction, and distribution of the Work otherwise complies with
128
- the conditions stated in this License.
129
-
130
- 5. Submission of Contributions. Unless You explicitly state otherwise,
131
- any Contribution intentionally submitted for inclusion in the Work
132
- by You to the Licensor shall be under the terms and conditions of
133
- this License, without any additional terms or conditions.
134
- Notwithstanding the above, nothing herein shall supersede or modify
135
- the terms of any separate license agreement you may have executed
136
- with Licensor regarding such Contributions.
137
-
138
- 6. Trademarks. This License does not grant permission to use the trade
139
- names, trademarks, service marks, or product names of the Licensor,
140
- except as required for reasonable and customary use in describing the
141
- origin of the Work and reproducing the content of the NOTICE file.
142
-
143
- 7. Disclaimer of Warranty. Unless required by applicable law or
144
- agreed to in writing, Licensor provides the Work (and each
145
- Contributor provides its Contributions) on an "AS IS" BASIS,
146
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
- implied, including, without limitation, any warranties or conditions
148
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
- PARTICULAR PURPOSE. You are solely responsible for determining the
150
- appropriateness of using or redistributing the Work and assume any
151
- risks associated with Your exercise of permissions under this License.
152
-
153
- 8. Limitation of Liability. In no event and under no legal theory,
154
- whether in tort (including negligence), contract, or otherwise,
155
- unless required by applicable law (such as deliberate and grossly
156
- negligent acts) or agreed to in writing, shall any Contributor be
157
- liable to You for damages, including any direct, indirect, special,
158
- incidental, or consequential damages of any character arising as a
159
- result of this License or out of the use or inability to use the
160
- Work (including but not limited to damages for loss of goodwill,
161
- work stoppage, computer failure or malfunction, or any and all
162
- other commercial damages or losses), even if such Contributor
163
- has been advised of the possibility of such damages.
164
-
165
- 9. Accepting Warranty or Additional Liability. While redistributing
166
- the Work or Derivative Works thereof, You may choose to offer,
167
- and charge a fee for, acceptance of support, warranty, indemnity,
168
- or other liability obligations and/or rights consistent with this
169
- License. However, in accepting such obligations, You may act only
170
- on Your own behalf and on Your sole responsibility, not on behalf
171
- of any other Contributor, and only if You agree to indemnify,
172
- defend, and hold each Contributor harmless for any liability
173
- incurred by, or claims asserted against, such Contributor by reason
174
- of your accepting any such warranty or additional liability.
175
-
176
- END OF TERMS AND CONDITIONS
@@ -1,506 +0,0 @@
1
- import { IRange } from '@univerjs/core';
2
- import { CFTimePeriodOperator, IAverageHighlightCell, IColorScale, IConditionalFormattingRuleConfig, IConditionFormattingRule, IIconSet, IValueConfig, CFRuleType } from '@univerjs/sheets-conditional-formatting';
3
- /**
4
- * @ignore
5
- * @hideconstructor
6
- */
7
- declare class ConditionalFormatRuleBaseBuilder {
8
- protected _rule: Partial<IConditionFormattingRule>;
9
- protected get _ruleConfig(): IConditionalFormattingRuleConfig | null;
10
- protected _getDefaultConfig(type?: CFRuleType): IConditionalFormattingRuleConfig;
11
- constructor(initRule?: Partial<IConditionFormattingRule>);
12
- protected _ensureAttr(obj: Record<string, any>, keys: string[]): Record<string, any>;
13
- build(): IConditionFormattingRule<IConditionalFormattingRuleConfig>;
14
- /**
15
- * Deep clone a current builder.
16
- * @returns {*}
17
- * @memberof ConditionalFormatRuleBuilder
18
- */
19
- copy(): ConditionalFormatRuleBaseBuilder;
20
- /**
21
- * Gets the scope of the current conditional format
22
- * @returns {*}
23
- * @memberof ConditionalFormatRuleBuilder
24
- */
25
- getRanges(): IRange[];
26
- /**
27
- * Get the icon set mapping dictionary
28
- */
29
- getIconMap(): Record<string, string[]>;
30
- /**
31
- * Create a conditional format ID.
32
- * @returns {*}
33
- * @memberof ConditionalFormatRuleBuilder
34
- */
35
- createCfId(): string;
36
- /**
37
- * Sets the scope for conditional formatting
38
- * @param {IRange[]} ranges
39
- * @returns {*}
40
- * @memberof ConditionalFormatRuleBuilder
41
- */
42
- setRanges(ranges: IRange[]): this;
43
- }
44
- /**
45
- * @hideconstructor
46
- */
47
- declare class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBuilder {
48
- constructor(initConfig?: Partial<IConditionFormattingRule>);
49
- copy(): ConditionalFormatHighlightRuleBuilder;
50
- /**
51
- * Set average rule
52
- * @param {IAverageHighlightCell['operator']} operator
53
- * @memberof ConditionalFormatHighlightRuleBuilder
54
- */
55
- setAverage(operator: IAverageHighlightCell['operator']): this;
56
- /**
57
- * Set uniqueValues rule
58
- * @memberof ConditionalFormatHighlightRuleBuilder
59
- */
60
- setUniqueValues(): this;
61
- /**
62
- * Set duplicateValues rule
63
- * @memberof ConditionalFormatHighlightRuleBuilder
64
- */
65
- setDuplicateValues(): this;
66
- /**
67
- * Set rank rule
68
- * @param {{ isBottom: boolean, isPercent: boolean, value: number }} config
69
- * @param config.isBottom
70
- * @param config.isPercent
71
- * @param config.value
72
- * @memberof ConditionalFormatHighlightRuleBuilder
73
- */
74
- setRank(config: {
75
- isBottom: boolean;
76
- isPercent: boolean;
77
- value: number;
78
- }): this;
79
- /**
80
- * Sets the background color
81
- * @param {string} [color]
82
- * @returns {*}
83
- * @memberof ConditionalFormatRuleBuilder
84
- */
85
- setBackground(color?: string): this;
86
- /**
87
- * Set Bold
88
- * @param {boolean} isBold
89
- * @returns {*}
90
- * @memberof ConditionalFormatRuleBuilder
91
- */
92
- setBold(isBold: boolean): this;
93
- /**
94
- * Sets the font color
95
- * @param {string} [color]
96
- * @returns {*}
97
- * @memberof ConditionalFormatRuleBuilder
98
- */
99
- setFontColor(color?: string): this;
100
- /**
101
- * Set the text to italic
102
- * @param {boolean} isItalic
103
- * @returns {*}
104
- * @memberof ConditionalFormatRuleBuilder
105
- */
106
- setItalic(isItalic: boolean): this;
107
- /**
108
- * Set the strikethrough
109
- * @param {boolean} isStrikethrough
110
- * @returns {*}
111
- * @memberof ConditionalFormatRuleBuilder
112
- */
113
- setStrikethrough(isStrikethrough: boolean): this;
114
- /**
115
- * Set the underscore
116
- * @param {boolean} isUnderline
117
- * @returns {*}
118
- * @memberof ConditionalFormatRuleBuilder
119
- */
120
- setUnderline(isUnderline: boolean): this;
121
- /**
122
- * Sets the conditional formatting rule to fire when the cell is empty.
123
- */
124
- whenCellEmpty(): this;
125
- /**
126
- * Sets the conditional formatting rule to fire when the cell is not empty
127
- * @returns {*}
128
- * @memberof ConditionalFormatRuleBuilder
129
- */
130
- whenCellNotEmpty(): this;
131
- /**
132
- * Highlight when the date is in a time period, custom time is not supported.
133
- * @param {CFTimePeriodOperator} date
134
- * @returns {*}
135
- * @memberof ConditionalFormatRuleBuilder
136
- */
137
- whenDate(date: CFTimePeriodOperator): this;
138
- /**
139
- * Sets a conditional formatting rule to fire when a given formula evaluates to true.
140
- * @param {string} formulaString formulaString start with' = '
141
- * @memberof ConditionalFormatRuleBuilder
142
- */
143
- whenFormulaSatisfied(formulaString: string): this;
144
- /**
145
- * Sets the conditional formatting rule to fire when a number is between two specified values or equal to one of them.
146
- * @param {number} start
147
- * @param {number} end
148
- * @memberof ConditionalFormatRuleBuilder
149
- */
150
- whenNumberBetween(start: number, end: number): this;
151
- /**
152
- * Sets the conditional formatting rule to fire when the number equals the given value
153
- * @param {number} value
154
- * @memberof ConditionalFormatRuleBuilder
155
- */
156
- whenNumberEqualTo(value: number): this;
157
- /**
158
- * Sets the conditional formatting rule to fire when the number is greater than the given value
159
- * @param {number} value
160
- * @memberof ConditionalFormatRuleBuilder
161
- */
162
- whenNumberGreaterThan(value: number): this;
163
- /**
164
- * Sets a conditional formatting rule to fire when a number is greater than or equal to a given value.
165
- * @param {number} value
166
- * @memberof ConditionalFormatRuleBuilder
167
- */
168
- whenNumberGreaterThanOrEqualTo(value: number): this;
169
- /**
170
- * Sets a conditional formatting rule to fire when the number is less than the given value.
171
- * @param {number} value
172
- * @memberof ConditionalFormatRuleBuilder
173
- */
174
- whenNumberLessThan(value: number): this;
175
- /**
176
- * Sets the conditional formatting rule to fire when the value is less than or equal to the given value.
177
- * @param {number} value
178
- * @memberof ConditionalFormatRuleBuilder
179
- */
180
- whenNumberLessThanOrEqualTo(value: number): this;
181
- /**
182
- * Sets a conditional formatting rule to fire when a number is not between two specified values and is not equal to them.
183
- * @param {number} start
184
- * @param {number} end
185
- * @memberof ConditionalFormatRuleBuilder
186
- */
187
- whenNumberNotBetween(start: number, end: number): this;
188
- /**
189
- * Sets the conditional formatting rule to fire when a number does not equal a given value.
190
- * @param value
191
- * @memberof ConditionalFormatRuleBuilder
192
- */
193
- whenNumberNotEqualTo(value: number): this;
194
- /**
195
- * Sets the conditional formatting rule to fire when the input contains the given value.
196
- * @param {string} text
197
- * @memberof ConditionalFormatRuleBuilder
198
- */
199
- whenTextContains(text: string): this;
200
- /**
201
- * Sets a conditional formatting rule to fire when the input does not contain the given value.
202
- * @param {string} text
203
- * @memberof ConditionalFormatRuleBuilder
204
- */
205
- whenTextDoesNotContain(text: string): this;
206
- /**
207
- * Sets a conditional formatting rule to fire when input ends with a specified value.
208
- * @param {string} text
209
- * @memberof ConditionalFormatRuleBuilder
210
- */
211
- whenTextEndsWith(text: string): this;
212
- /**
213
- * Sets the conditional formatting rule to fire when the input equals the given value.
214
- * @param {string} text
215
- * @memberof ConditionalFormatRuleBuilder
216
- */
217
- whenTextEqualTo(text: string): this;
218
- /**
219
- * Sets the conditional formatting rule to fire when the input value begins with the given value.
220
- * @param {string} text
221
- * @memberof ConditionalFormatRuleBuilder
222
- */
223
- whenTextStartsWith(text: string): this;
224
- }
225
- declare class ConditionalFormatDataBarRuleBuilder extends ConditionalFormatRuleBaseBuilder {
226
- copy(): ConditionalFormatDataBarRuleBuilder;
227
- /**
228
- * Data bar settings
229
- * @param {{
230
- * min: IValueConfig;
231
- * max: IValueConfig;
232
- * isGradient?: boolean;
233
- * positiveColor: string;
234
- * nativeColor: string;
235
- * isShowValue?: boolean;
236
- * }} config
237
- * @param config.min
238
- * @param config.max
239
- * @param config.isGradient
240
- * @param config.positiveColor
241
- * @param config.nativeColor
242
- * @param config.isShowValue
243
- * @memberof ConditionalFormatRuleBuilder
244
- */
245
- setDataBar(config: {
246
- min: IValueConfig;
247
- max: IValueConfig;
248
- isGradient?: boolean;
249
- positiveColor: string;
250
- nativeColor: string;
251
- isShowValue?: boolean;
252
- }): this;
253
- }
254
- declare class ConditionalFormatColorScaleRuleBuilder extends ConditionalFormatRuleBaseBuilder {
255
- copy(): ConditionalFormatColorScaleRuleBuilder;
256
- /**
257
- * Color scale set
258
- * @param {{ index: number; color: string; value: IValueConfig }[]} config
259
- * @memberof ConditionalFormatRuleBuilder
260
- */
261
- setColorScale(config: IColorScale['config']): this;
262
- }
263
- declare class ConditionalFormatIconSetRuleBuilder extends ConditionalFormatRuleBaseBuilder {
264
- copy(): ConditionalFormatIconSetRuleBuilder;
265
- /**
266
- *
267
- * Icon Set
268
- * @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config
269
- * @param config.iconConfigs
270
- * @param config.isShowValue
271
- * @memberof ConditionalFormatRuleBuilder
272
- */
273
- setIconSet(config: {
274
- iconConfigs: IIconSet['config'];
275
- isShowValue: boolean;
276
- }): this;
277
- }
278
- /**
279
- * @hideconstructor
280
- */
281
- export declare class FConditionalFormattingBuilder {
282
- private _initConfig;
283
- constructor(_initConfig?: {
284
- ranges?: IRange[];
285
- });
286
- build(): IConditionFormattingRule<IConditionalFormattingRuleConfig>;
287
- /**
288
- * Set average rule
289
- * @param {IAverageHighlightCell['operator']} operator
290
- * @memberof ConditionalFormatHighlightRuleBuilder
291
- */
292
- setAverage(operator: IAverageHighlightCell['operator']): ConditionalFormatHighlightRuleBuilder;
293
- /**
294
- * Set uniqueValues rule
295
- * @memberof ConditionalFormatHighlightRuleBuilder
296
- */
297
- setUniqueValues(): ConditionalFormatHighlightRuleBuilder;
298
- /**
299
- * Set duplicateValues rule
300
- * @memberof ConditionalFormatHighlightRuleBuilder
301
- */
302
- setDuplicateValues(): ConditionalFormatHighlightRuleBuilder;
303
- /**
304
- * Set rank rule
305
- * @param {{ isBottom: boolean, isPercent: boolean, value: number }} config
306
- * @param config.isBottom
307
- * @param config.isPercent
308
- * @param config.value
309
- * @memberof ConditionalFormatHighlightRuleBuilder
310
- */
311
- setRank(config: {
312
- isBottom: boolean;
313
- isPercent: boolean;
314
- value: number;
315
- }): ConditionalFormatHighlightRuleBuilder;
316
- /**
317
- *
318
- * Set iconSet rule
319
- * @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config
320
- * @param config.iconConfigs
321
- * @param config.isShowValue
322
- * @memberof ConditionalFormatRuleBuilder
323
- */
324
- setIconSet(config: {
325
- iconConfigs: IIconSet['config'];
326
- isShowValue: boolean;
327
- }): ConditionalFormatIconSetRuleBuilder;
328
- /**
329
- * Set colorScale rule
330
- * @param {{ index: number; color: string; value: IValueConfig }[]} config
331
- * @memberof ConditionalFormatRuleBuilder
332
- */
333
- setColorScale(config: IColorScale['config']): ConditionalFormatColorScaleRuleBuilder;
334
- /**
335
- * Set dataBar rule
336
- * @param {{
337
- * min: IValueConfig;
338
- * max: IValueConfig;
339
- * isGradient?: boolean;
340
- * positiveColor: string;
341
- * nativeColor: string;
342
- * isShowValue?: boolean;
343
- * }} config
344
- * @param config.min
345
- * @param config.max
346
- * @param config.isGradient
347
- * @param config.positiveColor
348
- * @param config.nativeColor
349
- * @param config.isShowValue
350
- * @memberof ConditionalFormatRuleBuilder
351
- */
352
- setDataBar(config: {
353
- min: IValueConfig;
354
- max: IValueConfig;
355
- isGradient?: boolean;
356
- positiveColor: string;
357
- nativeColor: string;
358
- isShowValue?: boolean;
359
- }): ConditionalFormatDataBarRuleBuilder;
360
- /**
361
- * Sets the background color
362
- * @param {string} [color]
363
- * @returns {*}
364
- * @memberof ConditionalFormatRuleBuilder
365
- */
366
- setBackground(color?: string): ConditionalFormatHighlightRuleBuilder;
367
- /**
368
- * Set Bold
369
- * @param {boolean} isBold
370
- * @returns {*}
371
- * @memberof ConditionalFormatRuleBuilder
372
- */
373
- setBold(isBold: boolean): ConditionalFormatHighlightRuleBuilder;
374
- /**
375
- * Sets the font color
376
- * @param {string} [color]
377
- * @returns {*}
378
- * @memberof ConditionalFormatRuleBuilder
379
- */
380
- setFontColor(color?: string): ConditionalFormatHighlightRuleBuilder;
381
- /**
382
- * Set the text to italic
383
- * @param {boolean} isItalic
384
- * @returns {*}
385
- * @memberof ConditionalFormatRuleBuilder
386
- */
387
- setItalic(isItalic: boolean): ConditionalFormatHighlightRuleBuilder;
388
- /**
389
- * Set the strikethrough
390
- * @param {boolean} isStrikethrough
391
- * @returns {*}
392
- * @memberof ConditionalFormatRuleBuilder
393
- */
394
- setStrikethrough(isStrikethrough: boolean): ConditionalFormatHighlightRuleBuilder;
395
- /**
396
- * Set the underscore
397
- * @param {boolean} isUnderline
398
- * @returns {*}
399
- * @memberof ConditionalFormatRuleBuilder
400
- */
401
- setUnderline(isUnderline: boolean): ConditionalFormatHighlightRuleBuilder;
402
- /**
403
- * Sets the conditional formatting rule to fire when the cell is empty.
404
- */
405
- whenCellEmpty(): ConditionalFormatHighlightRuleBuilder;
406
- /**
407
- * Sets the conditional formatting rule to fire when the cell is not empty
408
- * @returns {*}
409
- * @memberof ConditionalFormatRuleBuilder
410
- */
411
- whenCellNotEmpty(): ConditionalFormatHighlightRuleBuilder;
412
- /**
413
- * Highlight when the date is in a time period, custom time is not supported.
414
- * @param {CFTimePeriodOperator} date
415
- * @returns {*}
416
- * @memberof ConditionalFormatRuleBuilder
417
- */
418
- whenDate(date: CFTimePeriodOperator): ConditionalFormatHighlightRuleBuilder;
419
- /**
420
- * Sets a conditional formatting rule to fire when a given formula evaluates to true.
421
- * @param {string} formulaString formulaString start with' = '
422
- * @memberof ConditionalFormatRuleBuilder
423
- */
424
- whenFormulaSatisfied(formulaString: string): ConditionalFormatHighlightRuleBuilder;
425
- /**
426
- * Sets the conditional formatting rule to fire when a number is between two specified values or equal to one of them.
427
- * @param {number} start
428
- * @param {number} end
429
- * @memberof ConditionalFormatRuleBuilder
430
- */
431
- whenNumberBetween(start: number, end: number): ConditionalFormatHighlightRuleBuilder;
432
- /**
433
- * Sets the conditional formatting rule to fire when the number equals the given value
434
- * @param {number} value
435
- * @memberof ConditionalFormatRuleBuilder
436
- */
437
- whenNumberEqualTo(value: number): ConditionalFormatHighlightRuleBuilder;
438
- /**
439
- * Sets the conditional formatting rule to fire when the number is greater than the given value
440
- * @param {number} value
441
- * @memberof ConditionalFormatRuleBuilder
442
- */
443
- whenNumberGreaterThan(value: number): ConditionalFormatHighlightRuleBuilder;
444
- /**
445
- * Sets a conditional formatting rule to fire when a number is greater than or equal to a given value.
446
- * @param {number} value
447
- * @memberof ConditionalFormatRuleBuilder
448
- */
449
- whenNumberGreaterThanOrEqualTo(value: number): ConditionalFormatHighlightRuleBuilder;
450
- /**
451
- * Sets a conditional formatting rule to fire when the number is less than the given value.
452
- * @param {number} value
453
- * @memberof ConditionalFormatRuleBuilder
454
- */
455
- whenNumberLessThan(value: number): ConditionalFormatHighlightRuleBuilder;
456
- /**
457
- * Sets the conditional formatting rule to fire when the value is less than or equal to the given value.
458
- * @param {number} value
459
- * @memberof ConditionalFormatRuleBuilder
460
- */
461
- whenNumberLessThanOrEqualTo(value: number): ConditionalFormatHighlightRuleBuilder;
462
- /**
463
- * Sets a conditional formatting rule to fire when a number is not between two specified values and is not equal to them.
464
- * @param {number} start
465
- * @param {number} end
466
- * @memberof ConditionalFormatRuleBuilder
467
- */
468
- whenNumberNotBetween(start: number, end: number): ConditionalFormatHighlightRuleBuilder;
469
- /**
470
- * Sets the conditional formatting rule to fire when a number does not equal a given value.
471
- * @param value
472
- * @memberof ConditionalFormatRuleBuilder
473
- */
474
- whenNumberNotEqualTo(value: number): ConditionalFormatHighlightRuleBuilder;
475
- /**
476
- * Sets the conditional formatting rule to fire when the input contains the given value.
477
- * @param {string} text
478
- * @memberof ConditionalFormatRuleBuilder
479
- */
480
- whenTextContains(text: string): ConditionalFormatHighlightRuleBuilder;
481
- /**
482
- * Sets a conditional formatting rule to fire when the input does not contain the given value.
483
- * @param {string} text
484
- * @memberof ConditionalFormatRuleBuilder
485
- */
486
- whenTextDoesNotContain(text: string): ConditionalFormatHighlightRuleBuilder;
487
- /**
488
- * Sets a conditional formatting rule to fire when input ends with a specified value.
489
- * @param {string} text
490
- * @memberof ConditionalFormatRuleBuilder
491
- */
492
- whenTextEndsWith(text: string): ConditionalFormatHighlightRuleBuilder;
493
- /**
494
- * Sets the conditional formatting rule to fire when the input equals the given value.
495
- * @param {string} text
496
- * @memberof ConditionalFormatRuleBuilder
497
- */
498
- whenTextEqualTo(text: string): ConditionalFormatHighlightRuleBuilder;
499
- /**
500
- * Sets the conditional formatting rule to fire when the input value begins with the given value.
501
- * @param {string} text
502
- * @memberof ConditionalFormatRuleBuilder
503
- */
504
- whenTextStartsWith(text: string): ConditionalFormatHighlightRuleBuilder;
505
- }
506
- export {};