Class: FConditionalFormattingBuilder

Methods

build()


build(): IConditionFormattingRule<IConditionalFormattingRuleConfig>

Returns

IConditionFormattingRule<IConditionalFormattingRuleConfig>

setAverage()


setAverage(operator): ConditionalFormatHighlightRuleBuilder

Set average rule

Parameters

Parameter	Type	Description
`operator`	`IAverageHighlightCell`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatHighlightRuleBuilder

setBackground()


setBackground(color?): ConditionalFormatHighlightRuleBuilder

Sets the background color

Parameters

Parameter	Type	Description
`color`?	`string`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setBold()


setBold(isBold): ConditionalFormatHighlightRuleBuilder

Set Bold

Parameters

Parameter	Type	Description
`isBold`	`boolean`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setColorScale()


setColorScale(config): ConditionalFormatColorScaleRuleBuilder

Set colorScale rule

Parameters

Parameter	Type	Description
`config`	`IColorScale`

Returns

ConditionalFormatColorScaleRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setDataBar()


setDataBar(config): ConditionalFormatDataBarRuleBuilder

Set dataBar rule

Parameters

Parameter	Type	Description
`config`	{ `isGradient`: `boolean`; `isShowValue`: `boolean`; `max`: `IValueConfig`; `min`: `IValueConfig`; `nativeColor`: `string`; `positiveColor`: `string`; }
`config.isGradient`?	`boolean`
`config.isShowValue`?	`boolean`
`config.max`	`IValueConfig`
`config.min`	`IValueConfig`
`config.nativeColor`	`string`
`config.positiveColor`	`string`

Returns

ConditionalFormatDataBarRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setDuplicateValues()


setDuplicateValues(): ConditionalFormatHighlightRuleBuilder

Set duplicateValues rule

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatHighlightRuleBuilder

setFontColor()


setFontColor(color?): ConditionalFormatHighlightRuleBuilder

Sets the font color

Parameters

Parameter	Type	Description
`color`?	`string`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setIconSet()


setIconSet(config): ConditionalFormatIconSetRuleBuilder

Set iconSet rule

Parameters

Parameter	Type	Description
`config`	{ `iconConfigs`: `IIconSet`; `isShowValue`: `boolean`; }
`config.iconConfigs`	`IIconSet`
`config.isShowValue`	`boolean`

Returns

ConditionalFormatIconSetRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setItalic()


setItalic(isItalic): ConditionalFormatHighlightRuleBuilder

Set the text to italic

Parameters

Parameter	Type	Description
`isItalic`	`boolean`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setRank()


setRank(config): ConditionalFormatHighlightRuleBuilder

Set rank rule

Parameters

Parameter	Type	Description
`config`	{ `isBottom`: `boolean`; `isPercent`: `boolean`; `value`: `number`; }
`config.isBottom`	`boolean`
`config.isPercent`	`boolean`
`config.value`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatHighlightRuleBuilder

setStrikethrough()


setStrikethrough(isStrikethrough): ConditionalFormatHighlightRuleBuilder

Set the strikethrough

Parameters

Parameter	Type	Description
`isStrikethrough`	`boolean`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setUnderline()


setUnderline(isUnderline): ConditionalFormatHighlightRuleBuilder

Set the underscore

Parameters

Parameter	Type	Description
`isUnderline`	`boolean`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

setUniqueValues()


setUniqueValues(): ConditionalFormatHighlightRuleBuilder

Set uniqueValues rule

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatHighlightRuleBuilder

whenCellEmpty()


whenCellEmpty(): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when the cell is empty.

Returns

ConditionalFormatHighlightRuleBuilder

whenCellNotEmpty()


whenCellNotEmpty(): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when the cell is not empty

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenDate()


whenDate(date): ConditionalFormatHighlightRuleBuilder

Highlight when the date is in a time period, custom time is not supported.

Parameters

Parameter	Type	Description
`date`	`CFTimePeriodOperator`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenFormulaSatisfied()


whenFormulaSatisfied(formulaString): ConditionalFormatHighlightRuleBuilder

Sets a conditional formatting rule to fire when a given formula evaluates to true.

Parameters

Parameter	Type	Description
`formulaString`	`string`	formulaString start with’ = ‘

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenNumberBetween()


whenNumberBetween(start, end): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when a number is between two specified values or equal to one of them.

Parameters

Parameter	Type	Description
`start`	`number`
`end`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenNumberEqualTo()


whenNumberEqualTo(value): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when the number equals the given value

Parameters

Parameter	Type	Description
`value`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenNumberGreaterThan()


whenNumberGreaterThan(value): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when the number is greater than the given value

Parameters

Parameter	Type	Description
`value`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenNumberGreaterThanOrEqualTo()


whenNumberGreaterThanOrEqualTo(value): ConditionalFormatHighlightRuleBuilder

Sets a conditional formatting rule to fire when a number is greater than or equal to a given value.

Parameters

Parameter	Type	Description
`value`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenNumberLessThan()


whenNumberLessThan(value): ConditionalFormatHighlightRuleBuilder

Sets a conditional formatting rule to fire when the number is less than the given value.

Parameters

Parameter	Type	Description
`value`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenNumberLessThanOrEqualTo()


whenNumberLessThanOrEqualTo(value): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when the value is less than or equal to the given value.

Parameters

Parameter	Type	Description
`value`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenNumberNotBetween()


whenNumberNotBetween(start, end): ConditionalFormatHighlightRuleBuilder

Sets a conditional formatting rule to fire when a number is not between two specified values and is not equal to them.

Parameters

Parameter	Type	Description
`start`	`number`
`end`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenNumberNotEqualTo()


whenNumberNotEqualTo(value): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when a number does not equal a given value.

Parameters

Parameter	Type	Description
`value`	`number`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenTextContains()


whenTextContains(text): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when the input contains the given value.

Parameters

Parameter	Type	Description
`text`	`string`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenTextDoesNotContain()


whenTextDoesNotContain(text): ConditionalFormatHighlightRuleBuilder

Sets a conditional formatting rule to fire when the input does not contain the given value.

Parameters

Parameter	Type	Description
`text`	`string`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenTextEndsWith()


whenTextEndsWith(text): ConditionalFormatHighlightRuleBuilder

Sets a conditional formatting rule to fire when input ends with a specified value.

Parameters

Parameter	Type	Description
`text`	`string`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenTextEqualTo()


whenTextEqualTo(text): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when the input equals the given value.

Parameters

Parameter	Type	Description
`text`	`string`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder

whenTextStartsWith()


whenTextStartsWith(text): ConditionalFormatHighlightRuleBuilder

Sets the conditional formatting rule to fire when the input value begins with the given value.

Parameters

Parameter	Type	Description
`text`	`string`

Returns

ConditionalFormatHighlightRuleBuilder

Memberof

ConditionalFormatRuleBuilder