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.

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 [[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 [[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 [[topBottom]] property to 'Bottom'.

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

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get cellFormat(): IWorksheetCellFormat
  • Returns an [[IWorksheetCellFormat]] interface implementation which represents the format for cells which meet the criteria associated with this condition.

    The IWorksheetCellFormat implementation defines the visual attributes which are applied to cells whose value meets the associated condition.

    Returns IWorksheetCellFormat

  • get conditionType(): FormatConditionType
  • Returns a [[FormatConditionType]] value which identifies the type of condition for this instance.

    Returns FormatConditionType

  • get isPercent(): boolean
  • Returns or sets a boolean value indicating whether the [[rank]] is determined by a percentage value.

    By default, this condition evaluates cell values against the value of the [[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.

    Returns boolean

  • set isPercent(a): void
  • Parameters

    • a: boolean

    Returns void

  • get priority(): number
  • Returns or sets a value which determines the order of evaluation when multiple conditional formatting rules exist.

    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.

    Returns number

  • set priority(a): void
  • Parameters

    • a: number

    Returns void

  • get rank(): number
  • Returns or sets a value which specifies either the number or percentage of the rank value for the associated condition.

    The default value of this property is 10, and the default value for the [[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 [[isPercent]] property.

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

    See

    [[isPercent]]

    Returns number

  • set rank(a): void
  • Parameters

    • a: number

    Returns void

  • get regions(): ReadOnlyCollection$1<WorksheetRegion>
  • Returns the [[WorksheetRegion]] which identifies the cell range with which this condition is associated.

    Returns ReadOnlyCollection$1<WorksheetRegion>

  • get stopIfTrue(): boolean
  • Returns or 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.

    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 [[priority]] property.

    Returns boolean

  • set stopIfTrue(a): void
  • Parameters

    • a: boolean

    Returns void

  • get topBottom(): FormatConditionTopBottom
  • Returns or sets a value indicating whether a cell value must fall within the top or bottom of the ranking across the associated range.

    Returns FormatConditionTopBottom

  • set topBottom(a): void
  • Parameters

    Returns void

  • get workbook(): Workbook
  • Returns a reference to the associated workbook.

    Returns Workbook

  • get worksheet(): Worksheet
  • Returns a reference to the associated worksheet.

    Returns Worksheet

Methods

  • Parameters

    • other: any

    Returns boolean

  • Sets the [[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.

    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 [[setLastPriority]] method.

    See

    • [[priority]]
    • [[setLastPriority]]

    Returns void

  • Sets the [[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]].

    Just as the [[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

    • [[priority]]
    • [[setLastPriority]]
    • [[stopIfTrue]]

    Returns void

  • Replaces the existing regions with new ones

    Throws

    [[ArgumentException]] If regionAddress is invalid or contains a region from another worksheet

    Parameters

    • regionAddress: string

      A string with one or more comma separated region address

    • cellReferenceMode: CellReferenceMode

      An optional cell reference mode

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Returns void