ig.excel.IconSetConditionalFormat

Exposes properties which displays icons in a WorksheetCell based on the cell's value as relative to threshold values.

Remarks

This class provides the ability to display an icon inside a cell when that cell's value meets the criteria defined by the relevant IconCriterion.

Each icon set contains between three and five individual icons. The number of icons defines the number of thresholds; for example, a 3-icon set implies 3 thresholds, with each threshold representing approximately 33% of the associated range. A 4-icon set provides 4 thresholds, each representing 25% of the range; a 5-icon set contains 5 thresholds with each representing 20% of the range.

Threshold ranges are pre-defined based on the number of icons in the associated set, although this can be customized using the Value property of the IconCriterion associated with that threshold.

By default thresholds are expressed as percentages; use the Value property to customize this to support a percentile rating or a specific value. How the Value property is interpreted is dependent on the ValueType property.

While the number of thresholds is always fixed at 3, 4, or 5, the icon which is displayed for a given threshold can be customized using the IconCriterion.icon property.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.

  • iconCriteria

    .iconCriteria( );

    Returns a collection which defines the criteria for this condition.

  • iconCriteria

    .iconCriteria( index:number );
    Return Type:
    ig.excel.IconCriterion
    Return Type Description:
    The corresponding IconCriterion object

    Returns the IconCriterion object corresponding to the specified index.

    • index
    • Type:number
    • A zero-based index.

  • iconSet

    .iconSet( );

    Returns a FormatConditionIconSet value which identifies the set of icons used to express this condition.

  • iconSet

    .iconSet( value:ig.excel.FormatConditionIconSet );

    Sets a FormatConditionIconSet value which identifies the set of icons used to express this condition.

    • value
    • Type:ig.excel.FormatConditionIconSet

  • isCustom

    .isCustom( );

    Returns true if the Icon property of one or more criterion returns a value which is from a different icon set as the one returned from the IconSetConditionalFormat.iconSet property.

  • isReverseOrder

    .isReverseOrder( );

    Returns a boolean value indicating whether the order in which icons appear is reversed.

  • isReverseOrder

    .isReverseOrder( value:boolean );

    Sets a boolean value indicating whether the order in which icons appear is reversed.

    • value
    • Type:boolean

  • showValue

    .showValue( );

    Returns a boolean value indicating whether the cell value is shown along with the icon.

    Remarks

    By default, the cell value is displayed along with the icon; use this property to prevent the cell value from appearing.

  • showValue

    .showValue( value:boolean );

    Sets a boolean value indicating whether the cell value is shown along with the icon.

    • value
    • Type:boolean

    Remarks

    By default, the cell value is displayed along with the icon; use this property to prevent the cell value from appearing.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.