Exposes properties which control the coloring of a [[WorksheetCell]] based on the cell's value as relative to minimum, midpoint, and maximum threshold values.

Constructors

Section titled "Constructors"

ColorScaleConditionalFormat

new ColorScaleConditionalFormat(a: number): ColorScaleConditionalFormat

Returns ColorScaleConditionalFormat

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

priority

Section titled "priority"

Inherited from: ThresholdConditionBase 

priority: number

stopIfTrue

Section titled "stopIfTrue"

Inherited from: ThresholdConditionBase 

stopIfTrue: boolean

Accessors

Section titled "Accessors"

colorScaleType

Section titled "colorScaleType"

Returns a [[ColorScaleType]] value which identifies this instance as a 2-color or 3-color scale.

get colorScaleType(): ColorScaleType

Returns ColorScaleType

conditionType

Section titled "conditionType"

Inherited from: ThresholdConditionBase

Returns a [[FormatConditionType]] value which identifies the type of condition for this instance.

get conditionType(): FormatConditionType

Returns FormatConditionType

formula

Section titled "formula"

Inherited from: ThresholdConditionBase

Returns the formula which determines the values to which this condition applies. Note: the formula should return a boolean result. When the formula is applied to cells in the region if the formula returns false then those cells will not be included in the formatting.

get formula(): Formula

Returns Formula

maximumThreshold

Section titled "maximumThreshold"

Returns a [[ColorScaleCriterion]] object which defines the properties of the maximum threshold for this instance.

get maximumThreshold(): ColorScaleCriterion

Returns ColorScaleCriterion

midpointThreshold

Section titled "midpointThreshold"

Returns a [[ColorScaleCriterion]] object which defines the properties of the midpoint threshold for this instance.

get midpointThreshold(): ColorScaleCriterion

Returns ColorScaleCriterion

minimumThreshold

Section titled "minimumThreshold"

Returns a [[ColorScaleCriterion]] object which defines the properties of the minimum threshold for this instance.

get minimumThreshold(): ColorScaleCriterion

Returns ColorScaleCriterion

regions

Section titled "regions"

Inherited from: ThresholdConditionBase

Returns the [[WorksheetRegion]] which identifies the cell range with which this condition is associated.

get regions(): ReadOnlyCollection$1<WorksheetRegion>

Returns ReadOnlyCollection$1<WorksheetRegion>

workbook

Section titled "workbook"

Inherited from: ThresholdConditionBase

Returns a reference to the associated workbook.

get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Inherited from: ThresholdConditionBase

Returns a reference to the associated worksheet.

get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

setFirstPriority

Section titled "setFirstPriority"

Inherited from: ThresholdConditionBase

Sets the [[priority]] value for this rule such that it is the first condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated collection.

setFirstPriority(): void

Returns void

setFormula

Section titled "setFormula"

Inherited from: ThresholdConditionBase

Assigns a new [[Formula]] to the [[formula]] property. Note: the formula should return a boolean result. When the formula is applied to cells in the region if the formula returns false then those cells will not be included in the formatting.

setFormula(formula: string, cellReferenceMode: CellReferenceMode): void

Parameters

  • formula: string

    The string representation of the formula.
  • cellReferenceMode: CellReferenceMode

    A [[CellReferenceMode]] value which specifies whether the 'formula' parameter should be interpreted as an A1 or R1C1 expression. This parameter is optional and defaults to null, in which case the [[Workbook.cellReferenceMode]] property is used.

Returns void

setLastPriority

Section titled "setLastPriority"

Inherited from: ThresholdConditionBase

Sets the [[priority]] value for this rule such that it is the last condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated [[ConditionalFormatCollection]].

setLastPriority(): void

Returns void

setRegions

Section titled "setRegions"

Inherited from: ThresholdConditionBase

Replaces the existing regions with new ones

setRegions(regionAddress: string, cellReferenceMode: CellReferenceMode): void

Parameters

  • regionAddress: string

    A string with one or more comma separated region address
  • cellReferenceMode: CellReferenceMode

    An optional cell reference mode

Returns void

staticInit

Section titled "staticInit"

Inherited from: ThresholdConditionBase 

staticInit(): void

Returns void