Class: ConditionalFormatDataBarRuleBuilder

Extends

ConditionalFormatRuleBaseBuilder

Constructors

new ConditionalFormatDataBarRuleBuilder()


new ConditionalFormatDataBarRuleBuilder(initRule?): ConditionalFormatDataBarRuleBuilder

Parameters

Parameter	Type
`initRule`?	`IConditionFormattingRule`

Returns

ConditionalFormatDataBarRuleBuilder

Inherited from


ConditionalFormatRuleBaseBuilder.constructor

Methods

build()


build(): IConditionFormattingRule<IConditionalFormattingRuleConfig>

Returns

IConditionFormattingRule<IConditionalFormattingRuleConfig>

Inherited from


ConditionalFormatRuleBaseBuilder.build

copy()


copy(): ConditionalFormatDataBarRuleBuilder

Deep clone a current builder.

Returns

ConditionalFormatDataBarRuleBuilder

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

setDataBar()


setDataBar(config): this

Data bar settings

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

this

Memberof

ConditionalFormatRuleBuilder

setRanges()


setRanges(ranges): this

Sets the scope for conditional formatting

Parameters

Parameter	Type	Description
`ranges`	`IRange`[]

Returns

this

Memberof

ConditionalFormatRuleBuilder

Inherited from


ConditionalFormatRuleBaseBuilder.setRanges