Skip to content

@sheetkit/node / JsConditionalFormatRule

Interface: JsConditionalFormatRule ​

Defined in: packages/sheetkit/binding.d.ts:578

Conditional formatting rule configuration.

Properties ​

above? ​

optional above?: boolean

Defined in: packages/sheetkit/binding.d.ts:600

Whether rule is above average (for aboveAverage rules).


barColor? ​

optional barColor?: string

Defined in: packages/sheetkit/binding.d.ts:622

Data bar color (ARGB hex).


equalAverage? ​

optional equalAverage?: boolean

Defined in: packages/sheetkit/binding.d.ts:602

Whether equal values count as matching (for aboveAverage rules).


format? ​

optional format?: JsConditionalStyle

Defined in: packages/sheetkit/binding.d.ts:626

Differential style to apply.


formula? ​

optional formula?: string

Defined in: packages/sheetkit/binding.d.ts:590

First formula/value.


formula2? ​

optional formula2?: string

Defined in: packages/sheetkit/binding.d.ts:592

Second formula/value (for between/notBetween).


maxColor? ​

optional maxColor?: string

Defined in: packages/sheetkit/binding.d.ts:620

Color scale maximum color (ARGB hex).


maxType? ​

optional maxType?: string

Defined in: packages/sheetkit/binding.d.ts:616

Color scale maximum value type.


maxValue? ​

optional maxValue?: string

Defined in: packages/sheetkit/binding.d.ts:618

Color scale maximum value.


midColor? ​

optional midColor?: string

Defined in: packages/sheetkit/binding.d.ts:614

Color scale middle color (ARGB hex).


midType? ​

optional midType?: string

Defined in: packages/sheetkit/binding.d.ts:610

Color scale middle value type.


midValue? ​

optional midValue?: string

Defined in: packages/sheetkit/binding.d.ts:612

Color scale middle value.


minColor? ​

optional minColor?: string

Defined in: packages/sheetkit/binding.d.ts:608

Color scale minimum color (ARGB hex).


minType? ​

optional minType?: string

Defined in: packages/sheetkit/binding.d.ts:604

Color scale minimum value type.


minValue? ​

optional minValue?: string

Defined in: packages/sheetkit/binding.d.ts:606

Color scale minimum value.


operator? ​

optional operator?: string

Defined in: packages/sheetkit/binding.d.ts:588

Comparison operator for cellIs rules.


percent? ​

optional percent?: boolean

Defined in: packages/sheetkit/binding.d.ts:598

Whether rank is a percentage.


priority? ​

optional priority?: number

Defined in: packages/sheetkit/binding.d.ts:628

Rule priority (lower = higher precedence).


rank? ​

optional rank?: number

Defined in: packages/sheetkit/binding.d.ts:596

Rank for top10/bottom10 rules.


ruleType ​

ruleType: string

Defined in: packages/sheetkit/binding.d.ts:586

Rule type: "cellIs", "expression", "colorScale", "dataBar", "duplicateValues", "uniqueValues", "top10", "bottom10", "aboveAverage", "containsBlanks", "notContainsBlanks", "containsErrors", "notContainsErrors", "containsText", "notContainsText", "beginsWith", "endsWith".


showValue? ​

optional showValue?: boolean

Defined in: packages/sheetkit/binding.d.ts:624

Whether to show the cell value alongside the data bar.


stopIfTrue? ​

optional stopIfTrue?: boolean

Defined in: packages/sheetkit/binding.d.ts:630

If true, no lower-priority rules apply when this matches.


text? ​

optional text?: string

Defined in: packages/sheetkit/binding.d.ts:594

Text for text-based rules.

Released under the MIT / Apache-2.0 License.