---
url: /typescript-api/interfaces/JsConditionalFormatRule.md
---
[@sheetkit/node](../globals.md) / JsConditionalFormatRule

# Interface: JsConditionalFormatRule

Defined in: [packages/sheetkit/binding.d.ts:578](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L578)

Conditional formatting rule configuration.

## Properties

### above?

> `optional` **above?**: `boolean`

Defined in: [packages/sheetkit/binding.d.ts:600](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L600)

Whether rule is above average (for aboveAverage rules).

***

### barColor?

> `optional` **barColor?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:622](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L622)

Data bar color (ARGB hex).

***

### equalAverage?

> `optional` **equalAverage?**: `boolean`

Defined in: [packages/sheetkit/binding.d.ts:602](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L602)

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

***

### format?

> `optional` **format?**: [`JsConditionalStyle`](JsConditionalStyle.md)

Defined in: [packages/sheetkit/binding.d.ts:626](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L626)

Differential style to apply.

***

### formula?

> `optional` **formula?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:590](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L590)

First formula/value.

***

### formula2?

> `optional` **formula2?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:592](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L592)

Second formula/value (for between/notBetween).

***

### maxColor?

> `optional` **maxColor?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:620](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L620)

Color scale maximum color (ARGB hex).

***

### maxType?

> `optional` **maxType?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:616](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L616)

Color scale maximum value type.

***

### maxValue?

> `optional` **maxValue?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:618](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L618)

Color scale maximum value.

***

### midColor?

> `optional` **midColor?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:614](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L614)

Color scale middle color (ARGB hex).

***

### midType?

> `optional` **midType?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:610](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L610)

Color scale middle value type.

***

### midValue?

> `optional` **midValue?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:612](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L612)

Color scale middle value.

***

### minColor?

> `optional` **minColor?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:608](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L608)

Color scale minimum color (ARGB hex).

***

### minType?

> `optional` **minType?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:604](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L604)

Color scale minimum value type.

***

### minValue?

> `optional` **minValue?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:606](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L606)

Color scale minimum value.

***

### operator?

> `optional` **operator?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:588](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L588)

Comparison operator for cellIs rules.

***

### percent?

> `optional` **percent?**: `boolean`

Defined in: [packages/sheetkit/binding.d.ts:598](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L598)

Whether rank is a percentage.

***

### priority?

> `optional` **priority?**: `number`

Defined in: [packages/sheetkit/binding.d.ts:628](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L628)

Rule priority (lower = higher precedence).

***

### rank?

> `optional` **rank?**: `number`

Defined in: [packages/sheetkit/binding.d.ts:596](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L596)

Rank for top10/bottom10 rules.

***

### ruleType

> **ruleType**: `string`

Defined in: [packages/sheetkit/binding.d.ts:586](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L586)

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](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L624)

Whether to show the cell value alongside the data bar.

***

### stopIfTrue?

> `optional` **stopIfTrue?**: `boolean`

Defined in: [packages/sheetkit/binding.d.ts:630](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L630)

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

***

### text?

> `optional` **text?**: `string`

Defined in: [packages/sheetkit/binding.d.ts:594](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/binding.d.ts#L594)

Text for text-based rules.
