Defines the criterion for an [[IconSetConditionalFormat]] threshold.

Constructors

Section titled "Constructors"

IconCriterion 

new IconCriterion(a: number, b: IconSetCriterionCollection, c: number): IconCriterion

Returns IconCriterion

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

comparison

Section titled "comparison"

Returns or sets a [[comparison]] value which determines whether a "greater than" or "greater than or equal to" comparison is made when comparing cell values to the value of this instance.

 
get comparison(): ThresholdComparison

Returns ThresholdComparison 

set comparison(a: ThresholdComparison): void

Parameters

Returns void

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

icon

Section titled "icon"

Returns or sets a [[FormatConditionIcon]] value which identifies the icon displayed for this threshold as defined by the [[IconSetConditionalFormat.iconSet]] and [[index]] properties.

 
get icon(): FormatConditionIcon

Returns FormatConditionIcon 

set icon(a: FormatConditionIcon): void

Parameters

Returns void

iconSet

Section titled "iconSet"

Returns a [[FormatConditionIconSet]] value which identifies the icon set that includes this icon (read-only).

 
get iconSet(): FormatConditionIconSet

Returns FormatConditionIconSet

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