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( );
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.
-
comparison
- .comparison( value:ig.excel.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
-
icon
- .icon( );
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 );
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( );
Returns a FormatConditionIconSet value which identifies the icon set that includes this icon (read-only).