Represents a sort condition which will sort cells based on their background fill.

This sort condition specifies a single [[CellFill]]. Cells of this color will be moved to the beginning of the data range for the ascending sort direction and moved to the end of the data range for the descending sort direction. All matching cells will be kept in their same relative order to each other. In addition, all non-matching cells will be kept in their same relative order to each other.

See

  • [[SortSettings`1.sortConditions]]
  • [[SortCondition.sortDirection]]

Hierarchy

Hierarchy (view full)

Implements

  • IColorSortCondition

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get fill(): CellFill
  • Gets the [[CellFill]] by which the cells should be sorted.

    Cells with this fill will be moved to the beginning of the data range for the ascending sort direction and moved to the end of the data range for the descending sort direction. All matching cells will be kept in their same relative order to each other. In addition, all non-matching cells will be kept in their same relative order to each other.

    The CellFill by which the cells should be sorted.

    See

    • [[SortCondition.sortDirection]]
    • [[WorksheetCell.cellFormat]]
    • [[IWorksheetCellFormat.fill]]

    Returns CellFill

  • get sortDirection(): SortDirection
  • Gets the value which indicates the sort direction represented by the sort condition. Either SortDirection.Ascending or SortDirection.Descending.

    Returns SortDirection

Methods

  • Determines whether the [[FillSortCondition]] is equal to the specified object.

    Parameters

    • obj: any

      The object to test for equality.

    Returns boolean

  • Gets the hash code for the [[FillSortCondition]].

    Returns number

  • Returns Base

  • 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

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean