ig.excel.RankConditionalFormat

Exposes properties which control the visual attributes of a WorksheetCell based on whether a cell's value is within the top or bottom rank of values across the associated range.

Remarks

A rank condition evaluates to true if a cell value is within the range defined by the top or bottom n values across the associated range, where n represents the RankConditionalFormat.rank.

A popular example of a rank condition is "top ten ", where cell values which are within the range of the ten highest values across the range meet the condition. The RankConditionalFormat.rank property, however, can be set to any arbitrary number or percentage, and is not limited to only the top or bottom ten values.

By default, this condition evaluates to true if a cell's value is at or above the specified rank; to change this to the bottom of the ranking, set the RankConditionalFormat.topBottom property to 'Bottom'.

The numeric criteria can be changed to a percentage using the RankConditionalFormat.isPercent property. In this case, the Rank property is interepreted as a percentage.

Dependencies

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

    .isPercent( );

    Returns a boolean value indicating whether the RankConditionalFormat.rank is determined by a percentage value.

    Remarks

    By default, this condition evaluates cell values against the value of the RankConditionalFormat.rank property, with the rank representing an explicit numeric value. Set this property to true to identify the rank as a percentage.

    If the IsPercent property is set to true, this property supports only values between 1 and 100, inclusively.

  • isPercent

    .isPercent( value:boolean );

    Sets a boolean value indicating whether the RankConditionalFormat.rank is determined by a percentage value.

    • value
    • Type:boolean

    Remarks

    By default, this condition evaluates cell values against the value of the RankConditionalFormat.rank property, with the rank representing an explicit numeric value. Set this property to true to identify the rank as a percentage.

    If the IsPercent property is set to true, this property supports only values between 1 and 100, inclusively.

  • rank

    .rank( );

    Returns a value which specifies either the number or percentage of the rank value for the associated condition.

    Remarks

    The default value of this property is 10, and the default value for the RankConditionalFormat.topBottom property is 'Top', so that creating an instance of this class without specifying non-default property values results in a "top ten" condition.

    The value of this property is interepreted as either a number or a percentage, depending on the value of the RankConditionalFormat.isPercent property.

    If the IsPercent property is set to true, this property supports only values between 1 and 100, inclusively.

  • rank

    .rank( value:number );

    Sets a value which specifies either the number or percentage of the rank value for the associated condition.

    • value
    • Type:number

    Remarks

    The default value of this property is 10, and the default value for the RankConditionalFormat.topBottom property is 'Top', so that creating an instance of this class without specifying non-default property values results in a "top ten" condition.

    The value of this property is interepreted as either a number or a percentage, depending on the value of the RankConditionalFormat.isPercent property.

    If the IsPercent property is set to true, this property supports only values between 1 and 100, inclusively.

  • topBottom

    .topBottom( );
    Return Type:
    ig.excel.FormatConditionTopBottom
    Return Type Description:
    Returns a FormatConditionTopBottom.

    Returns a value indicating whether a cell value must fall within the top or bottom of the ranking across the associated range.

  • topBottom

    .topBottom( value:ig.excel.FormatConditionTopBottom );
    Return Type:
    ig.excel.FormatConditionTopBottom
    Return Type Description:
    Returns a FormatConditionTopBottom.

    Sets a value indicating whether a cell value must fall within the top or bottom of the ranking across the associated range.

    • value
    • Type:ig.excel.FormatConditionTopBottom

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