ASP.NET MVC Controls | ComponentOne
In This Topic
    SortManager Class
    In This Topic
    File
    wijmo.grid.sheet.js
    Module
    wijmo.grid.sheet

    Maintains sorting of the selected Sheet of the FlexSheet.

    Constructor

    constructor

    constructor(owner: FlexSheet): SortManager
    

    Initializes a new instance of the SortManager class.

    Parameters
    Returns
    SortManager

    Properties

    sortDescriptions

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

    Type
    CollectionView

    Methods

    addSortLevel

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

    Adds a blank sorting level to the sort descriptions.

    Parameters
    • columnIndex: number Optional

      The index of the column in the FlexSheet control.

    • ascending: boolean Optional

      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): number
    

    Check whether the sort item of specific column exists or not

    Parameters
    • columnIndex:

      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
    • undoable: boolean Optional

      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
    • columnIndex: number Optional

      The index of the column in the FlexSheet control.

    Returns
    void

    editSortLevel

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

    Updates the current sort level.

    Parameters
    • columnIndex: number Optional

      The column index for the sort level.

    • ascending: boolean Optional

      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