Class SortingsService

Provides sorting functionality.

note: This type is configured to use with FiltersService.

Hierarchy

SortingsService

Index

Properties

Accessors

defaultSortings

Methods

Properties

Protected defaultSortingsInternal

defaultSortingsInternal: SortParameter[] = new Array<SortParameter>()

Internal implementation of defaultSortings.

sortings

sortings: SortParameter[] = new Array<SortParameter>()

Sortings that were selected by the user and must be applied on next request of data.

note: This property is ready to use with FiltersService since it has filter annotation.

Accessors

defaultSortings

get defaultSortings(): SortParameter[]
set defaultSortings(value: SortParameter[]): void

- Defined in sortings-service.ts:43
Default sortings that will be used by service.

Returns SortParameter[]
- Defined in sortings-service.ts:49
If called when sortings is empty then applied value will be copied to sortings immediately.

Parameters
- value: SortParameter[]
Returns void

Methods

Protected cloneDefaultSortings

cloneDefaultSortings(): SortParameter[]

- Defined in sortings-service.ts:111
Internal method for default sortings cloning. This method is used as FilterConfig.defaultValue as well as for copying to sortings when defaultSortings setter is used and sortings is empty.

Returns SortParameter[]

destroy

destroy(): void

- Defined in sortings-service.ts:103
Performs service destroy.

Returns void

removeAllSortings

removeAllSortings(): void

- Defined in sortings-service.ts:97
Removes all sortings from sortings array.

Returns void

removeSort

removeSort(fieldName: string): void

- Defined in sortings-service.ts:87
Removes sort with specified field name from sortings array.

Parameters
- fieldName: string
  
  name of the sort to remove.
Returns void

setSort

setSort(fieldName: string, savePrevious: boolean): void

- Defined in sortings-service.ts:63
Sets sortings according to specified parameters.

Parameters
- fieldName: string
  
  name of the field by which sorting must be executed on server. This value will be used as SortParameter.fieldName.
  
  In case when sorting with the same field name is already specified, direction of this sorting will be toggled to reversed value and this sorting will be pushed to the end of sortings array. So it will be applied last.
- savePrevious: boolean
  
  true to keep previously applied sortings in sortings array.
Returns void

Generated using TypeDoc