Interface FilterPageSortArguments

This interface is used primarily in server side pagination, sorting, and filtering. It is used to pass the filter values, global filter value, pagination, sort info, and expansion info to the server. The server can use this information to return the data to the grid. Please see https://github.com/flexicious/euxdt-example/blob/main/src/app/examples/server-paging.tsx for an example.

Hierarchy

  • FilterPageSortArguments

Properties

expansion? filterValues? globalFilter? globalFilterTree? pagination? sorts?

Properties

Optional expansion

expansion?: Expansion

The expansion info. The expansion info contains the row unique identifier, the expansion state, and the expansion level.

Optional filterValues

filterValues?: ServerFilterValue[]

A list of filter values. The filter values contain the column unique identifier, the filter value, and the filter operation.

Optional globalFilter

globalFilter?: string

The global filter value. The global filter value is used to filter all the columns. Its only used when the global filter is enabled using the toolbarOptions property.

Optional globalFilterTree

globalFilterTree?: Filter

The global filter tree. The global filter is used to construct a complex logical query to filter the data. Its only used when the global filter tree is enabled using the toolbarOptions property.

Optional pagination

pagination?: PaginationRequest

The pagination info. The pagination info contains the page number, the page size, and the total number of records.

Optional sorts

sorts?: Map<string, SortInfo>

The sort info. The sort info contains the column unique identifier, the sort direction, and the sort priority. The sort priority is used to define the order in which the columns are sorted.

Settings

Member Visibility

Theme

Generated using TypeDoc