ig.excel.ColorScaleConditionalFormat

Exposes properties which control the coloring of a WorksheetCell based on the cell's value as relative to minimum, midpoint, and maximum threshold values.

Remarks

This class support either a 2-color or 3-color scale, as determined by the value of the colorScaleType parameter of the constructor.

For 2-color scales, cells in the associated range are colored based on how their value relates to the minimum and maximum thresholds.

For 3-color scales, cells in the associated range are colored based on how their value relates to the minimum, midpoint, and maximum thresholds.

This class supports a maximum of three separate and distinct color thresholds.

Specifying only one threshold is not supported and may result in unexpected behavior.

If this instance is created as a 2-color scale, the ColorScaleConditionalFormat.midpointThreshold property is not applicable. Attempting to set a property on the object returned from the MidpointThreshold property in this case will cause an exception to be thrown.

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.

  • colorScaleType

    .colorScaleType( );
    Return Type:
    ig.excel.ColorScaleType
    Return Type Description:
    Returns a ColorScaleType.

    Returns a ColorScaleType value which identifies this instance as a 2-color or 3-color scale.

    Remarks

    A ColorScaleConditionalFormat instance which is created with the 'TwoColor' value does not support the ColorScaleConditionalFormat.midpointThreshold; attempting to set a property on the object retuned from the MidpointThreshold property will cause an exception to be thrown.

    See Also

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

    See Also

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

    See Also

  • maximumThreshold

    .maximumThreshold( );
    Return Type:
    ig.excel.ColorScaleCriterion
    Return Type Description:
    Returns a ColorScaleCriterion.

    Returns a ColorScaleCriterion object which defines the properties of the maximum threshold for this instance.

    Remarks

    The following value types are not valid for the maximum threshold, and will cause an exception to be thrown:

    • LowestValue
    • AutomaticMinimum
    • AutomaticMaximum

    See Also

  • midpointThreshold

    .midpointThreshold( );
    Return Type:
    ig.excel.ColorScaleCriterion
    Return Type Description:
    Returns a ColorScaleCriterion.

    Returns a ColorScaleCriterion object which defines the properties of the midpoint threshold for this instance.

    Remarks

    The midpoint threshold is only supported for a ColorScaleConditionalFormat instance with a value of 'ThreeColor' specified for the colorScaleType parameter.

    Attempting to set a property on the instance returned from this property will cause an exception to be thrown if this instance was created as a 2-color scale.

    The following value types are not valid for the midpoint threshold, and will cause an exception to be thrown:

    • LowestValue
    • HighestValue
    • AutomaticMinimum
    • AutomaticMaximum

    See Also

  • minimumThreshold

    .minimumThreshold( );
    Return Type:
    ig.excel.ColorScaleCriterion
    Return Type Description:
    Returns a ColorScaleCriterion.

    Returns a ColorScaleCriterion object which defines the properties of the minimum threshold for this instance.

    Remarks

    The minimum threshold defines the criteria for the lowest or minimum value across the associated range.

    For a 2-color scale, the ColorScaleConditionalFormat.maximumThreshold defines the next "stop"; for a 3-color scale, the ColorScaleConditionalFormat.midpointThreshold property defines the next stop.

    The following value types are not valid for the minimum threshold, and will cause an exception to be thrown:

    • HighestValue
    • AutomaticMinimum
    • AutomaticMaximum

    See Also

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

    See Also

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

    See Also

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

    See Also

  • 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

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

    See Also

  • worksheet
    Inherited

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

    Returns a reference to the associated worksheet.

    See Also

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