Defines the criterion for a [[ColorScaleConditionalFormat]] threshold.

Constructors

Section titled "Constructors"

ColorScaleCriterion

new ColorScaleCriterion(a: ColorScaleConditionalFormat, b: ColorScaleCriterionThreshold): ColorScaleCriterion

Returns ColorScaleCriterion

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

formatColor

Section titled "formatColor" 
formatColor: WorkbookColorInfo

Accessors

Section titled "Accessors"

formula

Section titled "formula"

Inherited from: CriterionBase

Returns the formula which determines whether cell values meet the criteria defined by the associated condition.

get formula(): Formula

Returns Formula

value

Section titled "value"

Inherited from: CriterionBase

Returns the numeric value for this instance.

get value(): number

Returns number

valueType

Section titled "valueType"

Inherited from: CriterionBase

Returns a [[FormatConditionValueType]] value which specifies the manner in which the threshold values for this instance are determined.

get valueType(): FormatConditionValueType

Returns FormatConditionValueType

Methods

Section titled "Methods"

setFormula

Section titled "setFormula"

Inherited from: CriterionBase

Assigns the specified formula to the [[formula]] property, and assigns a value of Formula to the [[valueType]] property.

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

Parameters

  • formula: string

    The string representation of the [[formula]] to be assigned to the [[value]] property.
  • 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.
  • valueType: FormatConditionValueType

    A [[FormatConditionValueType]] value which specifies the manner in which the value returned from the formula is interpreted. This parameter is optional and defaults to 'Formula'.

Returns void

setValue

Section titled "setValue"

Inherited from: CriterionBase

Sets the [[valueType]] property to the specified [[FormatConditionValueType]] value.

setValue(valueType: FormatConditionValueType): void

Parameters

Returns void

toString

Section titled "toString"

Returns the string representation of this instance.

toString(): string

Returns string