Skip to Content
ClassesConditionalFormatColorScaleRuleBuilder

Class: ConditionalFormatColorScaleRuleBuilder

Extends

  • ConditionalFormatRuleBaseBuilder

Constructors

new ConditionalFormatColorScaleRuleBuilder()

new ConditionalFormatColorScaleRuleBuilder(initRule?): ConditionalFormatColorScaleRuleBuilder

Parameters

ParameterType
initRule?IConditionFormattingRule

Returns

ConditionalFormatColorScaleRuleBuilder

Inherited from

ConditionalFormatRuleBaseBuilder.constructor

Methods

build()

build(): IConditionFormattingRule<IConditionalFormattingRuleConfig>

Returns

IConditionFormattingRule<IConditionalFormattingRuleConfig>

Inherited from

ConditionalFormatRuleBaseBuilder.build

copy()

copy(): ConditionalFormatColorScaleRuleBuilder

Deep clone a current builder.

Returns

ConditionalFormatColorScaleRuleBuilder

Memberof

ConditionalFormatRuleBuilder

Overrides

ConditionalFormatRuleBaseBuilder.copy

createCfId()

createCfId(): string

Create a conditional format ID.

Returns

string

Memberof

ConditionalFormatRuleBuilder

Inherited from

ConditionalFormatRuleBaseBuilder.createCfId

getIconMap()

getIconMap(): Record<string, ...[]>

Get the icon set mapping dictionary

Returns

Record<string, …[]>

Inherited from

ConditionalFormatRuleBaseBuilder.getIconMap

getRanges()

getRanges(): IRange[]

Gets the scope of the current conditional format

Returns

IRange[]

Memberof

ConditionalFormatRuleBuilder

Inherited from

ConditionalFormatRuleBaseBuilder.getRanges

setColorScale()

setColorScale(config): this

Color scale set

Parameters

ParameterTypeDescription
configIColorScale

Returns

this

Memberof

ConditionalFormatRuleBuilder


setRanges()

setRanges(ranges): this

Sets the scope for conditional formatting

Parameters

ParameterTypeDescription
rangesIRange[]

Returns

this

Memberof

ConditionalFormatRuleBuilder

Inherited from

ConditionalFormatRuleBaseBuilder.setRanges