ig.excel.IconCriterion
Remarks
This class provides the ability to override the default behavior of the associated condition for the threshold defined by this instance.
For example, the icon displayed for cell values which fall within this threshold is determined by the value of the IconSetConditionalFormat.iconSet, but can be overridden using the IconCriterion.icon property.
Similarly, the default unit for this criterion's value is percentage, but this can be overridden using the ConditionValue.valueType property. For example, to define the unit for the value as a specific number, assign a value of Number to the ValueType property.
The value for this threshold is defined by the parent condition, based on the total number of thresholds. For IconSetConditionalFormat.iconSet values which yield three thresholds, for example, the effective value is dependent on the threshold, so that each threshold represents approximately 33% of the associated range. This can be overridden using the CriterionBase.value property; for example, setting the ValueType property to Number and the Value property to a specific number overrides the behavior as defined by the parent condition, and forces the threshold boundary to the specific numeric value.
For this reason, the IconCriterion.icon, ConditionValue.value, and ConditionValue.valueType properties support null values, and are in fact set to null by default; this is interpreted by the parent condition as "not set", resulting in the threshold criterion being determined solely by the parent condition.
Dependencies
-
comparison
- .comparison( );
- Return Type:
- ig.excel.ThresholdComparison
- Return Type Description:
- Returns a ThresholdComparison.
Returns a IconCriterion.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.
See Also
-
comparison
- .comparison( value:ig.excel.ThresholdComparison );
- Return Type:
- ig.excel.ThresholdComparison
- Return Type Description:
- Returns a ThresholdComparison.
Sets a IconCriterion.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.
- value
- Type:ig.excel.ThresholdComparison
See Also
-
formula
Inherited- .formula( );
- Return Type:
- ig.excel.Formula
- Return Type Description:
- Returns a Formula.
Returns the formula which determines whether cell values meet the criteria defined by the associated condition.
Remarks
This property is only applicable when the CriterionBase.valueType property is set to Formula.
To assign a formula, use the CriterionBase.setFormula method.
-
icon
- .icon( );
- Return Type:
- ig.excel.FormatConditionIcon
- Return Type Description:
- Returns a FormatConditionIcon.
Returns a FormatConditionIcon value which identifies the icon displayed for this threshold as defined by the IconSetConditionalFormat.iconSet and IconCriterion.index properties.
Remarks
By default, the icon displayed for this threshold is defined by the parent condition, via the value of the IconSetConditionalFormat.iconSet property.
This property provides a way to override the default icon as defined by the parent condition.
This property defaults to the appropriate value given the IconSet as defined by the parent condition and this instance's Threshold.
-
icon
- .icon( value:ig.excel.FormatConditionIcon );
- Return Type:
- ig.excel.FormatConditionIcon
- Return Type Description:
- Returns a FormatConditionIcon.
Sets a FormatConditionIcon value which identifies the icon displayed for this threshold as defined by the IconSetConditionalFormat.iconSet and IconCriterion.index properties.
- value
- Type:ig.excel.FormatConditionIcon
Remarks
By default, the icon displayed for this threshold is defined by the parent condition, via the value of the IconSetConditionalFormat.iconSet property.
This property provides a way to override the default icon as defined by the parent condition.
This property defaults to the appropriate value given the IconSet as defined by the parent condition and this instance's Threshold.
-
iconSet
- .iconSet( );
- Return Type:
- ig.excel.FormatConditionIconSet
- Return Type Description:
- Returns a FormatConditionIconSet.
Returns a FormatConditionIconSet value which identifies the icon set that includes this icon (read-only).
-
setFormula
Inherited- .setFormula( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode], [valueType:ig.excel.FormatConditionValueType] );
Assigns the specified formula to the CriterionBase.formula property, and assigns a value of Formula to the CriterionBase.valueType property.
- formula
- Type:string
- The string representation of the CriterionBase.formula to be assigned to the CriterionBase.value property.
- cellReferenceMode
- Type:ig.excel.CellReferenceMode
- Optional
- 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
- Type:ig.excel.FormatConditionValueType
- Optional
- 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'.
-
setValue
Inherited- .setValue( valueType:ig.excel.FormatConditionValueType );
Sets the CriterionBase.valueType property to the specified FormatConditionValueType value.
- valueType
- Type:ig.excel.FormatConditionValueType
- The new value for the CriterionBase.valueType property.
Remarks
The valueType parameter must be set to one of the following values or an exception is thrown:
- AutomaticLowest
- AutomaticHighest
- LowestValue
- HighestValue
To set the CriterionBase.value property to a numeric value, use the CriterionBase.setValue method.
To set the CriterionBase.valueType property to Formula, use the CriterionBase.setFormula method.
See Also
-
setValue
Inherited- .setValue( value:number, valueType:ig.excel.FormatConditionValueType );
Sets the CriterionBase.value and CriterionBase.valueType properties to the specified values.
- value
- Type:number
- The new value for the CriterionBase.value property.
- valueType
- Type:ig.excel.FormatConditionValueType
- The new value for the CriterionBase.valueType property. Must be set to either Number, Percentage, or Percentile or an exception is thrown.
Remarks
To set the CriterionBase.valueType property to Formula, use the CriterionBase.setFormula method.
To set the CriterionBase.valueType property to a FormatConditionValueType value for which the CriterionBase.value is not applicable, use the CriterionBase.setValue method.
See Also
-
value
Inherited- .value( );
Returns the numeric value for this instance.
Remarks
This property is read-only; to assign a value type, use the CriterionBase.setValue or CriterionBase.setValue methods.
Note that the unit of measure for this value is determined by the CriterionBase.valueType property; for example, when ValueType is set to Number, the value is interpreted as a numeric value, but when set to Percentage, it is interpreted as a percentage.
-
valueType
Inherited- .valueType( );
- Return Type:
- ig.excel.FormatConditionValueType
- Return Type Description:
- Returns a FormatConditionValueType.
Returns a FormatConditionValueType value which specifies the manner in which the threshold values for this instance are determined.
Remarks
This property is read-only; to assign one of the following value types, use the CriterionBase.setValue method:
- AutomaticLowest
- AutomaticHighest
- LowestValue
- HighestValue
To assign a value type of Number, Percentage, or Percentileuse the CriterionBase.setValue method.
To assign a CriterionBase.formula, use the CriterionBase.setFormula method.