IFilterElementsQuery
Service to query valid filter elements for particular filter.
export interface IFilterElementsQuery
Methods
Method | Description |
|---|---|
Starts the valid elements query. | |
Sets number of valid elements to return per page. Default limit is specific per backend | |
Sets starting point for the query. Backend WILL return no data if the offset is greater than total number of valid elements. Default offset: 0 |
Method details
IFilterElementsQuery.query()method
Starts the valid elements query.
query(): Promise<IElementsQueryResult>;
Returns
Promise<IElementsQueryResult>
promise of first page of the results
IFilterElementsQuery.withLimit()method
Sets number of valid elements to return per page. Default limit is specific per backend
withLimit(limit: number): IFilterElementsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
limit | number | desired max number of valid elements per page; must be a positive number |
Returns
element query
IFilterElementsQuery.withOffset()method
Sets starting point for the query. Backend WILL return no data if the offset is greater than total number of valid elements. Default offset: 0
withOffset(offset: number): IFilterElementsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
offset | number | zero indexed, must be non-negative |
Returns
element query