Wijmo
Grid
Sheet
5.20231.904
wijmo.grid.sheet Class SortManager Wijmo API Class

SortManager Class

Maintains sorting of the selected Sheet of the FlexSheet.

Heirarchy

  • SortManager

Constructors

Properties

Methods

Constructors

constructor

Properties

sortDescriptions

sortDescriptions: CollectionView

Gets or sets the collection of the sort descriptions represented by the ColumnSortDescription objects.

Methods

addSortLevel

  • addSortLevel(columnIndex?: number, ascending?: boolean): void

  • Adds a blank sorting level to the sort descriptions.

    Parameters

    • Optional columnIndex: number

      The index of the column in the FlexSheet control.

    • Optional ascending: boolean

      The sort order for the sort level.

    Returns void

cancelSort

  • cancelSort(): void

  • Cancel the current sort descriptions to the FlexSheet control.

    Returns void

checkSortItemExists

  • checkSortItemExists(columnIndex: any): number

  • Check whether the sort item of specific column exists or not

    Parameters

    • columnIndex: any

      The index of the column in the FlexSheet control.

    Returns number

clearSort

  • clearSort(): void

  • Clear the sort descriptions.

    Returns void

commitSort

  • commitSort(undoable?: boolean): void

  • Commits the current sort descriptions to the FlexSheet control.

    Parameters

    • Optional undoable: boolean

      The boolean value indicating whether the commit sort action is undoable.

    Returns void

copySortLevel

  • copySortLevel(): void

  • Adds a copy of the current sorting level to the sort descriptions.

    Returns void

deleteSortLevel

  • deleteSortLevel(columnIndex?: number): void

  • Removes the current sorting level from the sort descriptions.

    Parameters

    • Optional columnIndex: number

      The index of the column in the FlexSheet control.

    Returns void

editSortLevel

  • editSortLevel(columnIndex?: number, ascending?: boolean): void

  • Updates the current sort level.

    Parameters

    • Optional columnIndex: number

      The column index for the sort level.

    • Optional ascending: boolean

      The sort order for the sort level.

    Returns void

moveSortLevel

  • moveSortLevel(offset: number): void

  • Moves the current sorting level to a new position.

    Parameters

    • offset: number

      The offset to move the current level by.

    Returns void