Class SortState

Represents information relevant to the sorting of data items.

Index

Constructors

Accessors

Methods

[iterator] append at compare delete get getIcon has indexOf prepend satisfies set toJSON toSql toString of parse

Constructors

constructor

new SortState(properties?: SortedProperty[]): SortState
Creates new sort.
Parameters
- properties: SortedProperty[] = []
  The list of properties to be sorted.
Returns SortState
- Defined in src/Web/SortState.ts:41

Accessors

length

get length(): number
The number of properties.

Returns number
- Defined in src/Web/SortState.ts:48

Methods

[iterator]

"[iterator]"(): IterableIterator<SortedProperty>
Returns a new iterator that allows iterating the entries of this sort.

Returns IterableIterator<SortedProperty>
An iterator over the sorted properties.
- Defined in src/Web/SortState.ts:78

append

append(property: string, direction: SortDirection): this
Appends the specified property to this sort.
Parameters
- property: string
  The property name.
- direction: SortDirection
  The sort direction.
Returns this
This instance.
- Defined in src/Web/SortState.ts:88

at

at(index: number): null | SortedProperty
Gets the sorted property at the specified index.
Parameters
- index: number
  The position in this sort.
Returns null | SortedProperty
The sorted property at the specified index, or null if it doesn't exist.
- Defined in src/Web/SortState.ts:99

compare

compare(x: object, y: object): number
Compares the specified objects, according to the current sort properties.
Parameters
- x: object
  The first object to compare.
- y: object
  The second object to compare.
Returns number
A value indicating the relationship between the two objects.
- Defined in src/Web/SortState.ts:109

delete

delete(property: string): void
Removes the specified property from this sort.
Parameters
- property: string
  The property name.
Returns void
- Defined in src/Web/SortState.ts:124

get

get(property: string): null | SortDirection
Gets the direction associated with the specified property.
Parameters
- property: string
  The property name.
Returns null | SortDirection
The direction associated with the specified property, or null if the property doesn't exist.
- Defined in src/Web/SortState.ts:133

getIcon

getIcon(property: string): string
Gets the icon corresponding to the specified property.
Parameters
- property: string
  The property name.
Returns string
The icon corresponding to the specified property.
- Defined in src/Web/SortState.ts:143

has

has(property: string): boolean
Returns a value indicating whether the specified property exists in this sort.
Parameters
- property: string
  The property name.
Returns boolean
true if the specified property exists in this sort, otherwise false.
- Defined in src/Web/SortState.ts:156

indexOf

indexOf(property: string): number
Gets the index of the specified property in the underlying list.
Parameters
- property: string
  The property name.
Returns number
The index of the specified property, or -1 if the property is not found.
- Defined in src/Web/SortState.ts:165

prepend

prepend(property: string, direction: SortDirection): this
Prepends the specified property to this sort.
Parameters
- property: string
  The property name.
- direction: SortDirection
  The sort direction.
Returns this
This instance.
- Defined in src/Web/SortState.ts:176

satisfies

satisfies(
conditions?: Partial<{ max: number; min: number; properties: string[] }>,
): boolean
Returns a value indicating whether the current sort satisfies the specified conditions.
Parameters
- conditions: Partial<{ max: number; min: number; properties: string[] }> = {}
  The conditions to satisfy.
Returns boolean
true if the current sort satisfies the specified conditions, otherwise false.
- Defined in src/Web/SortState.ts:187

set

set(property: string, direction: SortDirection): this
Sets the direction of the specified property.
Parameters
- property: string
  The property name.
- direction: SortDirection
  The sort direction.
Returns this
This instance.
- Defined in src/Web/SortState.ts:204

toJSON

toJSON(): string
Returns a JSON representation of this object.

Returns string
The JSON representation of this object.
- Defined in src/Web/SortState.ts:217

toSql

toSql(escape?: (identifier: string) => string): string
Converts this sort to an SQL clause.
Parameters
- escape: (identifier: string) => string = ...
  A function used to escape the SQL identifiers.
Returns string
The SQL clause corresponding to this object.
- Defined in src/Web/SortState.ts:226

toString

toString(): string
Returns a string representation of this object.

Returns string
The string representation of this object.
- Defined in src/Web/SortState.ts:234

`Static`of

of(property: string, direction?: SortDirection): SortState
Creates a new sort from the specified property and direction.
Parameters
- property: string
  The property name.
- direction: SortDirection = SortDirection.Ascending
  The sort direction.
Returns SortState
The sort corresponding to the property and direction.
- Defined in src/Web/SortState.ts:58

`Static`parse

parse(value: string): SortState
Creates a new sort from the specified string.
Parameters
- value: string
  A string representing a sort.
Returns SortState
The sort corresponding to the specified string.
- Defined in src/Web/SortState.ts:67