@sheetkit/node / JsConditionalFormatRule

Interface: JsConditionalFormatRule

Defined in: binding.d.ts:475

Conditional formatting rule configuration.

Properties

above?

optional above: boolean

Defined in: binding.d.ts:497

Whether rule is above average (for aboveAverage rules).

---

barColor?

optional barColor: string

Defined in: binding.d.ts:519

Data bar color (ARGB hex).

---

equalAverage?

optional equalAverage: boolean

Defined in: binding.d.ts:499

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

---

format?

optional format: JsConditionalStyle

Defined in: binding.d.ts:523

Differential style to apply.

---

formula?

optional formula: string

Defined in: binding.d.ts:487

First formula/value.

---

formula2?

optional formula2: string

Defined in: binding.d.ts:489

Second formula/value (for between/notBetween).

---

maxColor?

optional maxColor: string

Defined in: binding.d.ts:517

Color scale maximum color (ARGB hex).

---

maxType?

optional maxType: string

Defined in: binding.d.ts:513

Color scale maximum value type.

---

maxValue?

optional maxValue: string

Defined in: binding.d.ts:515

Color scale maximum value.

---

midColor?

optional midColor: string

Defined in: binding.d.ts:511

Color scale middle color (ARGB hex).

---

midType?

optional midType: string

Defined in: binding.d.ts:507

Color scale middle value type.

---

midValue?

optional midValue: string

Defined in: binding.d.ts:509

Color scale middle value.

---

minColor?

optional minColor: string

Defined in: binding.d.ts:505

Color scale minimum color (ARGB hex).

---

minType?

optional minType: string

Defined in: binding.d.ts:501

Color scale minimum value type.

---

minValue?

optional minValue: string

Defined in: binding.d.ts:503

Color scale minimum value.

---

operator?

optional operator: string

Defined in: binding.d.ts:485

Comparison operator for cellIs rules.

---

percent?

optional percent: boolean

Defined in: binding.d.ts:495

Whether rank is a percentage.

---

priority?

optional priority: number

Defined in: binding.d.ts:525

Rule priority (lower = higher precedence).

---

rank?

optional rank: number

Defined in: binding.d.ts:493

Rank for top10/bottom10 rules.

---

ruleType

ruleType: string

Defined in: binding.d.ts:483

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: binding.d.ts:521

Whether to show the cell value alongside the data bar.

---

stopIfTrue?

optional stopIfTrue: boolean

Defined in: binding.d.ts:527

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

---

text?

optional text: string

Defined in: binding.d.ts:491

Text for text-based rules.