Class Sort

Describes a Sort present on the table. No visible constructor, created through the use of Column.sort(), will be tied to that particular column data. Sort instances are immutable, and use a builder pattern to make modifications. All methods return a new Sort instance.

Hierarchy

Sort

Index

Constructors

Properties

ASCENDING DESCENDING REVERSE

Accessors

column direction isAbs

Methods

abs asc desc toString

Constructors

`Protected` constructor

new Sort(): Sort
Returns Sort

Properties

`Static` `Readonly` ASCENDING

ASCENDING: string

`Static` `Readonly` DESCENDING

DESCENDING: string

`Static` `Readonly` REVERSE

REVERSE: string

Accessors

column

get column(): Column
The column which is sorted.

Returns Column
Column

direction

get direction(): string
The direction of this sort, either ASC, DESC, or REVERSE.

Returns string
String

isAbs

get isAbs(): boolean
True if the absolute value of the column should be used when sorting; defaults to false.

Returns boolean
boolean

Methods

abs

abs(): Sort
Builds a Sort instance which takes the absolute value before applying order.

Returns Sort
Sort

asc

asc(): Sort
Builds a Sort instance to sort values in ascending order.

Returns Sort
Sort

desc

desc(): Sort
Builds a Sort instance to sort values in descending order.

Returns Sort
Sort

toString

toString(): string
Returns string