DataSorterKey
DataSorterKey class
Represents the key of the data sorter.
class DataSorterKey;
Properties
| Property | Type | Description |
|---|---|---|
| order | SortOrder | Readonly. Indicates the order of sorting. |
| index | number | Readonly. Gets the sorted column index(absolute position, column A is 0, B is 1, …). |
| type | SortOnType | Readonly. Represents the type of sorting. |
| iconSetType | IconSetType | Readonly. Represents the icon set type. |
| iconId | number | Readonly. Represents the id of the icon set type. |
| color | Color | Readonly. Gets the sorted color. |
Methods
| Method | Description |
|---|---|
| getOrder() | @deprecated. Please use the ‘order’ property instead. Indicates the order of sorting. |
| getIndex() | @deprecated. Please use the ‘index’ property instead. Gets the sorted column index(absolute position, column A is 0, B is 1, …). |
| getType() | @deprecated. Please use the ’type’ property instead. Represents the type of sorting. |
| getIconSetType() | @deprecated. Please use the ‘iconSetType’ property instead. Represents the icon set type. |
| getIconId() | @deprecated. Please use the ‘iconId’ property instead. Represents the id of the icon set type. |
| getColor() | @deprecated. Please use the ‘color’ property instead. Gets the sorted color. |
| isNull() | Checks whether the implementation object is null. |
order
Readonly. Indicates the order of sorting.
order : SortOrder;
index
Readonly. Gets the sorted column index(absolute position, column A is 0, B is 1, …).
index : number;
type
Readonly. Represents the type of sorting.
type : SortOnType;
iconSetType
Readonly. Represents the icon set type.
iconSetType : IconSetType;
Remarks
Only takes effect when Type is SortOnType.Icon.
iconId
Readonly. Represents the id of the icon set type.
iconId : number;
Remarks
Only takes effect when Type is SortOnType.Icon.
color
Readonly. Gets the sorted color.
color : Color;
Remarks
Only takes effect when Type is SortOnType.CellColor or SortOnType.FontColor.
getOrder()
@deprecated. Please use the ‘order’ property instead. Indicates the order of sorting.
getOrder() : SortOrder;
Returns
getIndex()
@deprecated. Please use the ‘index’ property instead. Gets the sorted column index(absolute position, column A is 0, B is 1, …).
getIndex() : number;
getType()
@deprecated. Please use the ’type’ property instead. Represents the type of sorting.
getType() : SortOnType;
Returns
getIconSetType()
@deprecated. Please use the ‘iconSetType’ property instead. Represents the icon set type.
getIconSetType() : IconSetType;
Returns
Remarks
Only takes effect when Type is SortOnType.Icon.
getIconId()
@deprecated. Please use the ‘iconId’ property instead. Represents the id of the icon set type.
getIconId() : number;
Remarks
Only takes effect when Type is SortOnType.Icon.
getColor()
@deprecated. Please use the ‘color’ property instead. Gets the sorted color.
getColor() : Color;
Returns
Remarks
Only takes effect when Type is SortOnType.CellColor or SortOnType.FontColor.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;