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.
  • conditionType
    Inherited

    .conditionType( );
    Return Type:
    ig.excel.FormatConditionType
    Return Type Description:
    Returns a FormatConditionType.

    Returns a FormatConditionType value which identifies the type of condition for this instance.

  • formula
    Inherited

    .formula( );
    Return Type:
    ig.excel.Formula
    Return Type Description:
    Returns a Formula.

    Returns the formula which determines the values to which this condition applies.

    Remarks

    Note: the formula should return a boolean result. When the formula is applied to cells in the region if the formula returns false then those cells will not be included in the formatting.
  • iconCriteria

    .iconCriteria( );
    Return Type:
    ig.excel.IconSetCriterionCollection
    Return Type Description:
    Returns a IconSetCriterionCollection.

    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( );
    Return Type:
    ig.excel.FormatConditionIconSet
    Return Type Description:
    Returns a FormatConditionIconSet.

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

  • iconSet

    .iconSet( value:ig.excel.FormatConditionIconSet );
    Return Type:
    ig.excel.FormatConditionIconSet
    Return Type Description:
    Returns a 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
  • priority
    Inherited

    .priority( );

    Returns a value which determines the order of evaluation when multiple conditional formatting rules exist.

    Remarks

    By default, conditions are evaluated in the order in which they appear within the containing collection.

    This property makes it possible to weight one condition over another, essentially overriding the condition's ordinal position within the collection.

    A lower number means a higher priority; for example, a condition with a priority of 1 is evaluated before one with a priority of 2.

    If a cell value meets more than one condition, the format defined by the first condition to be evaluated takes precedence.

    Setting the priority on one condition may cause the value of other conditions in the collection to be changed to ensure that each condition has a unique value.

  • priority
    Inherited

    .priority( value:number );

    Sets a value which determines the order of evaluation when multiple conditional formatting rules exist.

    • value
    • Type:number

    Remarks

    By default, conditions are evaluated in the order in which they appear within the containing collection.

    This property makes it possible to weight one condition over another, essentially overriding the condition's ordinal position within the collection.

    A lower number means a higher priority; for example, a condition with a priority of 1 is evaluated before one with a priority of 2.

    If a cell value meets more than one condition, the format defined by the first condition to be evaluated takes precedence.

    Setting the priority on one condition may cause the value of other conditions in the collection to be changed to ensure that each condition has a unique value.

  • regions
    Inherited

    .regions( );

    Returns the WorksheetRegion which identifies the cell range with which this condition is associated.

  • setFirstPriority
    Inherited

    .setFirstPriority( );

    Sets the ConditionBase.priority value for this rule such that it is the first condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated collection.

    Remarks

    When multiple conditions exist in the same collection, the order in which they are evaluated has bearing on which format is applied to cells which meet those conditions.

    This method ensures that the associated condition is the first one to be evaluated.

    To make a condition the last one to be evaluated, use the ConditionBase.setLastPriority method.

  • setFormula
    Inherited

    .setFormula( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode] );

    Assigns a new Formula to the ThresholdConditionBase.formula property.

    • formula
    • Type:string
    • The string representation of the formula.
    • 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.

    Remarks

    Note: the formula should return a boolean result. When the formula is applied to cells in the region if the formula returns false then those cells will not be included in the formatting.
  • setLastPriority
    Inherited

    .setLastPriority( );

    Sets the ConditionBase.priority value for this rule such that it is the last condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated ConditionalFormatCollection.

    Remarks

    Just as the ConditionBase.setFirstPriority method ensures that the associated condition is evalulated first, the SetLastPriority method ensures that the associated condition is evaluated last.

    Calling this method on more than one condition essentially replaces the previously designated condition as the last one to be evaluated with this one.

  • setRegions
    Inherited

    .setRegions( regionAddress:string, cellReferenceMode:ig.excel.CellReferenceMode );

    Replaces the existing regions with new ones

    • regionAddress
    • Type:string
    • A string with one or more comma separated region address
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • An optional cell reference mode

    Exceptions

    Exception Description
    ig.ArgumentException If regionAddress is invalid or contains a region from another worksheet
  • 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.

  • stopIfTrue
    Inherited

    .stopIfTrue( );

    Returns a boolean indicating whether additional formatting rules are evaluated if this rule evaluates to true. Applicable only in the case where the containing collection contains more than one element.

    Remarks

    If a cell value meets more than one condition, the format defined by the first condition takes precedence. Individual format properties are "merged" during the resolution process; for example, if one format has red borders and another has a red foreground color, a cell value which meets both conditions may be formatted with both red borders and a red foreground color.

    This property makes it possible to short-circuit the resolution process, so that no other conditional formats are applied after the first condition evaluates to true.

    Using the above example, assume StopIfTrue is set to a value of true on the conditional format with red borders, a second conditional format exists with a red foreground color, and a cell value meets both conditions. Because the StopIfTrue setting prevents additional formats from being evaluated, the cell will not show a red foreground color, whereas with StopIfTrue being set to false, it would show both red borders and a red foreground color.

    In addition to preventing subsequent conditions from being evaluated, the order in which conditions are evaluated can be controlled using the ConditionBase.priority property.

  • stopIfTrue
    Inherited

    .stopIfTrue( value:boolean );

    Sets a boolean indicating whether additional formatting rules are evaluated if this rule evaluates to true. Applicable only in the case where the containing collection contains more than one element.

    • value
    • Type:boolean

    Remarks

    If a cell value meets more than one condition, the format defined by the first condition takes precedence. Individual format properties are "merged" during the resolution process; for example, if one format has red borders and another has a red foreground color, a cell value which meets both conditions may be formatted with both red borders and a red foreground color.

    This property makes it possible to short-circuit the resolution process, so that no other conditional formats are applied after the first condition evaluates to true.

    Using the above example, assume StopIfTrue is set to a value of true on the conditional format with red borders, a second conditional format exists with a red foreground color, and a cell value meets both conditions. Because the StopIfTrue setting prevents additional formats from being evaluated, the cell will not show a red foreground color, whereas with StopIfTrue being set to false, it would show both red borders and a red foreground color.

    In addition to preventing subsequent conditions from being evaluated, the order in which conditions are evaluated can be controlled using the ConditionBase.priority property.

  • workbook
    Inherited

    .workbook( );
    Return Type:
    ig.excel.Workbook
    Return Type Description:
    Returns a Workbook.

    Returns a reference to the associated workbook.

  • worksheet
    Inherited

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    Returns a Worksheet.

    Returns a reference to the associated worksheet.

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