Class: ConditionalFormatIconSetRuleBuilder
Extends
ConditionalFormatRuleBaseBuilder
Constructors
new ConditionalFormatIconSetRuleBuilder()
new ConditionalFormatIconSetRuleBuilder(initRule?): ConditionalFormatIconSetRuleBuilderParameters
| Parameter | Type |
|---|---|
initRule? | IConditionFormattingRule |
Returns
ConditionalFormatIconSetRuleBuilder
Inherited from
ConditionalFormatRuleBaseBuilder.constructorMethods
build()
build(): IConditionFormattingRule<IConditionalFormattingRuleConfig>Returns
IConditionFormattingRule<IConditionalFormattingRuleConfig>
Inherited from
ConditionalFormatRuleBaseBuilder.buildcopy()
copy(): ConditionalFormatIconSetRuleBuilderDeep clone a current builder.
Returns
ConditionalFormatIconSetRuleBuilder
Memberof
ConditionalFormatRuleBuilder
Overrides
ConditionalFormatRuleBaseBuilder.copycreateCfId()
createCfId(): stringCreate a conditional format ID.
Returns
string
Memberof
ConditionalFormatRuleBuilder
Inherited from
ConditionalFormatRuleBaseBuilder.createCfIdgetIconMap()
getIconMap(): Record<string, ...[]>Get the icon set mapping dictionary
Returns
Record<string, …[]>
Inherited from
ConditionalFormatRuleBaseBuilder.getIconMapgetRanges()
getRanges(): IRange[]Gets the scope of the current conditional format
Returns
IRange[]
Memberof
ConditionalFormatRuleBuilder
Inherited from
ConditionalFormatRuleBaseBuilder.getRangessetIconSet()
setIconSet(config): thisIcon Set
Parameters
| Parameter | Type | Description |
|---|---|---|
config | { iconConfigs: IIconSet; isShowValue: boolean; } | |
config.iconConfigs | IIconSet | |
config.isShowValue | boolean |
Returns
this
Memberof
ConditionalFormatRuleBuilder
setRanges()
setRanges(ranges): thisSets the scope for conditional formatting
Parameters
| Parameter | Type | Description |
|---|---|---|
ranges | IRange[] |
Returns
this
Memberof
ConditionalFormatRuleBuilder
Inherited from
ConditionalFormatRuleBaseBuilder.setRanges