@sheetkit/node / JsConditionalFormatRule

Interface: JsConditionalFormatRule

Defined in: binding.d.ts:533

Conditional formatting rule configuration.

Properties

above?

optional above: boolean

Defined in: binding.d.ts:555

Whether rule is above average (for aboveAverage rules).

---

barColor?

optional barColor: string

Defined in: binding.d.ts:577

Data bar color (ARGB hex).

---

equalAverage?

optional equalAverage: boolean

Defined in: binding.d.ts:557

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

---

format?

optional format: JsConditionalStyle

Defined in: binding.d.ts:581

Differential style to apply.

---

formula?

optional formula: string

Defined in: binding.d.ts:545

First formula/value.

---

formula2?

optional formula2: string

Defined in: binding.d.ts:547

Second formula/value (for between/notBetween).

---

maxColor?

optional maxColor: string

Defined in: binding.d.ts:575

Color scale maximum color (ARGB hex).

---

maxType?

optional maxType: string

Defined in: binding.d.ts:571

Color scale maximum value type.

---

maxValue?

optional maxValue: string

Defined in: binding.d.ts:573

Color scale maximum value.

---

midColor?

optional midColor: string

Defined in: binding.d.ts:569

Color scale middle color (ARGB hex).

---

midType?

optional midType: string

Defined in: binding.d.ts:565

Color scale middle value type.

---

midValue?

optional midValue: string

Defined in: binding.d.ts:567

Color scale middle value.

---

minColor?

optional minColor: string

Defined in: binding.d.ts:563

Color scale minimum color (ARGB hex).

---

minType?

optional minType: string

Defined in: binding.d.ts:559

Color scale minimum value type.

---

minValue?

optional minValue: string

Defined in: binding.d.ts:561

Color scale minimum value.

---

operator?

optional operator: string

Defined in: binding.d.ts:543

Comparison operator for cellIs rules.

---

percent?

optional percent: boolean

Defined in: binding.d.ts:553

Whether rank is a percentage.

---

priority?

optional priority: number

Defined in: binding.d.ts:583

Rule priority (lower = higher precedence).

---

rank?

optional rank: number

Defined in: binding.d.ts:551

Rank for top10/bottom10 rules.

---

ruleType

ruleType: string

Defined in: binding.d.ts:541

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:579

Whether to show the cell value alongside the data bar.

---

stopIfTrue?

optional stopIfTrue: boolean

Defined in: binding.d.ts:585

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

---

text?

optional text: string

Defined in: binding.d.ts:549

Text for text-based rules.