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.

Constructors

Section titled "Constructors"

RankConditionalFormat

new RankConditionalFormat(a: number): RankConditionalFormat

Returns RankConditionalFormat

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

isPercent

Section titled "isPercent" 
isPercent: boolean

priority

Section titled "priority"

Inherited from: ConditionalFormatBase 

priority: number

rank

Section titled "rank" 
rank: number

stopIfTrue

Section titled "stopIfTrue"

Inherited from: ConditionalFormatBase 

stopIfTrue: boolean

topBottom

Section titled "topBottom" 
topBottom: FormatConditionTopBottom

Accessors

Section titled "Accessors"

cellFormat

Section titled "cellFormat"

Inherited from: ConditionalFormatBase

Returns an [[IWorksheetCellFormat]] interface implementation which represents the format for cells which meet the criteria associated with this condition.

get cellFormat(): IWorksheetCellFormat

Returns IWorksheetCellFormat

conditionType

Section titled "conditionType"

Inherited from: ConditionalFormatBase

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

get conditionType(): FormatConditionType

Returns FormatConditionType

regions

Section titled "regions"

Inherited from: ConditionalFormatBase

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

get regions(): ReadOnlyCollection$1<WorksheetRegion>

Returns ReadOnlyCollection$1<WorksheetRegion>

workbook

Section titled "workbook"

Inherited from: ConditionalFormatBase

Returns a reference to the associated workbook.

get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Inherited from: ConditionalFormatBase

Returns a reference to the associated worksheet.

get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

setFirstPriority

Section titled "setFirstPriority"

Inherited from: ConditionalFormatBase

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.

setFirstPriority(): void

Returns void

setLastPriority

Section titled "setLastPriority"

Inherited from: ConditionalFormatBase

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

setLastPriority(): void

Returns void

setRegions

Section titled "setRegions"

Inherited from: ConditionalFormatBase

Replaces the existing regions with new ones

setRegions(regionAddress: string, cellReferenceMode: CellReferenceMode): void

Parameters

  • regionAddress: string

    A string with one or more comma separated region address
  • cellReferenceMode: CellReferenceMode

    An optional cell reference mode

Returns void

staticInit

Section titled "staticInit"

Inherited from: ConditionalFormatBase 

staticInit(): void

Returns void