Interface ISort

ReadonlyisISort

apply

• apply(): void

  Reapplies the sort.

  Returns void

delete

• delete(): void

  Clears the sort criteria and removes from sort levels.

  Returns void

getCriteria

• getCriteria(): Readonly<Criteria> | null

  Gets the sort criteria.

  Returns Readonly<Criteria> | null

  The sort criteria or null if none is set.

getIndex

• getIndex(): number

  The field index within the sort range or table.

  Returns number

  Remarks

  • For row-major sorts, this is a column index.
  • For column-major sorts, this is a row index.
  • It is always relative to the sorted region, not the sheet.

getLevel

• getLevel(): number

  The level of the sort (0-based).

  Returns number

  Remarks

  This is based on the order of the sort fields. If the sort has no criteria the level will be -1.

getRange

• getRange(): ICellRange

  Gets the range being sorted.

  Returns ICellRange

setCriteria

• setCriteria(criteria: Criteria | null, append?: boolean): void

  Sets the sort criteria.

  Parameters

  • criteria: Criteria | null

    The sort criteria to set, or null to clear this field.

  • Optionalappend: boolean

    If true, keeps existing sort levels and adds/updates this field. If false or omitted, this field becomes the only sort field.

  Returns void

sort

• sort(reverse?: boolean): void

  Sorts this index using its current criteria.

  Parameters

  • Optionalreverse: boolean

    If provided, temporarily overrides the reverse flag for this sort.

  Returns void

  Remarks

  • This method mutates the owning table/range by reordering rows/columns.
  • If reverse is undefined, the effective direction is: criteria.reverse ?? rangeDefaults.reverse ?? false.