DataSorter

DataSorter class

Summary description for DataSorter.

class DataSorter;

Methods

Method	Description
getKeys()	Gets the key list of data sorter.
getHasHeaders()	Represents whether the range has headers.
setHasHeaders(boolean)	Represents whether the range has headers.
getKey1()	Represents first sorted column index(absolute position, column A is 0, B is 1, …).
setKey1(number)	Represents first sorted column index(absolute position, column A is 0, B is 1, …).
getOrder1()	Represents sort order of the first key.
setOrder1(SortOrder)	Represents sort order of the first key.
getKey2()	Represents second sorted column index(absolute position, column A is 0, B is 1, …).
setKey2(number)	Represents second sorted column index(absolute position, column A is 0, B is 1, …).
getOrder2()	Represents sort order of the second key.
setOrder2(SortOrder)	Represents sort order of the second key.
getKey3()	Represents third sorted column index(absolute position, column A is 0, B is 1, …).
setKey3(number)	Represents third sorted column index(absolute position, column A is 0, B is 1, …).
getOrder3()	Represents sort order of the third key.
setOrder3(SortOrder)	Represents sort order of the third key.
getSortLeftToRight()	True means that sorting orientation is from left to right. False means that sorting orientation is from top to bottom. The default value is false.
setSortLeftToRight(boolean)	True means that sorting orientation is from left to right. False means that sorting orientation is from top to bottom. The default value is false.
getCaseSensitive()	Gets and sets whether case sensitive when comparing string.
setCaseSensitive(boolean)	Gets and sets whether case sensitive when comparing string.
getSortAsNumber()	Indicates whether sorting anything that looks like a number.
setSortAsNumber(boolean)	Indicates whether sorting anything that looks like a number.
clear()	Clear all settings.
addKey(number, SortOrder)	Adds sorted column index and sort order.
addKey(number, SortOrder, string)	Adds sorted column index and sort order with custom sort list.
addKey(number, SortOrder, string[])	Adds sorted column index and sort order with custom sort list.
sort(Cells, number, number, number, number)	Sorts the data of the area.
sort(Cells, CellArea)	Sort the data of the area.
sort()	Sort the data in the range.

getKeys()

Gets the key list of data sorter.

getKeys() : DataSorterKeyCollection;

Returns

DataSorterKeyCollection

getHasHeaders()

Represents whether the range has headers.

getHasHeaders() : boolean;

setHasHeaders(boolean)

Represents whether the range has headers.

setHasHeaders(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getKey1()

Represents first sorted column index(absolute position, column A is 0, B is 1, …).

getKey1() : number;

setKey1(number)

Represents first sorted column index(absolute position, column A is 0, B is 1, …).

setKey1(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getOrder1()

Represents sort order of the first key.

getOrder1() : SortOrder;

Returns

SortOrder

setOrder1(SortOrder)

Represents sort order of the first key.

setOrder1(value: SortOrder) : void;

Parameters:

Parameter	Type	Description
value	SortOrder	The value to set.

getKey2()

Represents second sorted column index(absolute position, column A is 0, B is 1, …).

getKey2() : number;

setKey2(number)

Represents second sorted column index(absolute position, column A is 0, B is 1, …).

setKey2(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getOrder2()

Represents sort order of the second key.

getOrder2() : SortOrder;

Returns

SortOrder

setOrder2(SortOrder)

Represents sort order of the second key.

setOrder2(value: SortOrder) : void;

Parameters:

Parameter	Type	Description
value	SortOrder	The value to set.

getKey3()

Represents third sorted column index(absolute position, column A is 0, B is 1, …).

getKey3() : number;

setKey3(number)

Represents third sorted column index(absolute position, column A is 0, B is 1, …).

setKey3(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getOrder3()

Represents sort order of the third key.

getOrder3() : SortOrder;

Returns

SortOrder

setOrder3(SortOrder)

Represents sort order of the third key.

setOrder3(value: SortOrder) : void;

Parameters:

Parameter	Type	Description
value	SortOrder	The value to set.

getSortLeftToRight()

True means that sorting orientation is from left to right. False means that sorting orientation is from top to bottom. The default value is false.

getSortLeftToRight() : boolean;

setSortLeftToRight(boolean)

True means that sorting orientation is from left to right. False means that sorting orientation is from top to bottom. The default value is false.

setSortLeftToRight(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCaseSensitive()

Gets and sets whether case sensitive when comparing string.

getCaseSensitive() : boolean;

setCaseSensitive(boolean)

Gets and sets whether case sensitive when comparing string.

setCaseSensitive(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSortAsNumber()

Indicates whether sorting anything that looks like a number.

getSortAsNumber() : boolean;

setSortAsNumber(boolean)

Indicates whether sorting anything that looks like a number.

setSortAsNumber(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

clear()

Clear all settings.

clear() : void;

addKey(number, SortOrder)

Adds sorted column index and sort order.

addKey(key: number, order: SortOrder) : void;

Parameters:

Parameter	Type	Description
key	number	The sorted column index(absolute position, column A is 0, B is 1, …)
order	SortOrder	The sort order

addKey(number, SortOrder, string)

Adds sorted column index and sort order with custom sort list.

addKey(key: number, order: SortOrder, customList: string) : void;

Parameters:

Parameter	Type	Description
key	number	The sorted column index(absolute position, column A is 0, B is 1, …)
order	SortOrder	The sort order.
customList	string	The custom sort list.

addKey(number, SortOrder, string[])

Adds sorted column index and sort order with custom sort list.

addKey(key: number, order: SortOrder, customList: string[]) : void;

Parameters:

Parameter	Type	Description
key	number	The sorted column index(absolute position, column A is 0, B is 1, …)
order	SortOrder	The sort order.
customList	string[]	The custom sort list.

sort(Cells, number, number, number, number)

Sorts the data of the area.

sort(cells: Cells, startRow: number, startColumn: number, endRow: number, endColumn: number) : number[];

Parameters:

Parameter	Type	Description
cells	Cells	The cells contains the data area.
startRow	number	The start row of the area.
startColumn	number	The start column of the area.
endRow	number	The end row of the area.
endColumn	number	The end column of the area.

Returns

the original indices(absolute position, for example, column A is 0, B is 1, …) of the sorted rows/columns. If no rows/columns needs to be moved by this sorting operation, null will be returned.

sort(Cells, CellArea)

Sort the data of the area.

sort(cells: Cells, area: CellArea) : number[];

Parameters:

Parameter	Type	Description
cells	Cells	The cells contains the data area.
area	CellArea	The area needed to sort

Returns

the original indices(absolute position, for example, column A is 0, B is 1, …) of the sorted rows/columns. If no rows/columns needs to be moved by this sorting operation, null will be returned.

sort()

Sort the data in the range.

sort() : number[];

Returns

the original indices(absolute position, for example, column A is 0, B is 1, …) of the sorted rows/columns. If no rows/columns needs to be moved by this sorting operation, null will be returned.