ComponentOne ASP.NET MVC Controls
SortManager Class
File
wijmo.grid.sheet.js
Module
wijmo.grid.sheet

Maintains sorting of the selected Sheet of the FlexSheet.

Constructor

Properties

Methods

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
Optional

The index of the column in the FlexSheet control.

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
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

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
Returns
void

editSortLevel

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

Updates the current sort level.

Parameters
Returns
void

moveSortLevel

moveSortLevel(offset: number): void

Moves the current sorting level to a new position.

Parameters
Returns
void