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

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

isPercent

Section titled "isPercent"

Returns or sets a boolean value indicating whether the [[rank]] is determined by a percentage value.

 
get isPercent(): boolean

Returns boolean 

set isPercent(a: boolean): void

Parameters

  • a: boolean

Returns void

priority

Section titled "priority"

Inherited from: ConditionalFormatBase

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

 
get priority(): number

Returns number 

set priority(a: number): void

Parameters

  • a: number

Returns void

rank

Section titled "rank"

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

 
get rank(): number

Returns number 

set rank(a: number): void

Parameters

  • a: number

Returns void

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>

stopIfTrue

Section titled "stopIfTrue"

Inherited from: ConditionalFormatBase

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.

 
get stopIfTrue(): boolean

Returns boolean 

set stopIfTrue(a: boolean): void

Parameters

  • a: boolean

Returns void

topBottom

Section titled "topBottom"

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

 
get topBottom(): FormatConditionTopBottom

Returns FormatConditionTopBottom 

set topBottom(a: FormatConditionTopBottom): void

Parameters

Returns void

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 | null): void

Parameters

  • regionAddress: string

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

    An optional cell reference mode

Returns void

staticInit

Section titled "staticInit"

Inherited from: ConditionalFormatBase 

staticInit(): void

Returns void