IElementsQueryOptions

IElementsQueryOptions.cacheIdproperty

Cache ID to use when requesting subsequent elements from the backend.

cacheId?: string;

Remarks

This is to prevent inconsistent results when the underlying datasource is volatile. If not specified, the backend will generate a value that the client should use in subsequent requests. Note that not all backend types support this.

IElementsQueryOptions.complementproperty

If true, the filter prop will behave negatively - i.e. it will not include items matching the filter value.

complement?: boolean;

IElementsQueryOptions.elementsproperty

Specify particular elements to load.

elements?: ElementsQueryOptionsElementsSpecification;

Remarks

This is commonly used to preload selected elements in the attribute filter.

IElementsQueryOptions.excludePrimaryLabelproperty

Decides whether result will include also the primary label elements or only requested label ones. It changes also the cardinality of result.

If true, returned label values are in cardinality of primary label, i.e., result could contain duplicated values.

If false, returned label values are unique values and smaller amount of label values can be returned than the number of primary label values.

excludePrimaryLabel?: boolean;

Remarks

This is used mainly in filters to not display duplicate values where each of them filter out the same records from an insight when text value attribute filters are used.

The value is applied only on backends without the supportsElementUris capability.

IElementsQueryOptions.filterproperty

Filter elements by text value

filter?: string;

IElementsQueryOptions.filterByPrimaryLabelproperty

Provided filter uses values from primary label.

filterByPrimaryLabel?: boolean;

Remarks

This is to allow getting elements of requested label corresponding to primary label values in filter.

IElementsQueryOptions.includeTotalCountWithoutFiltersproperty

Include the total count of all elements in the response (without filters applied)

includeTotalCountWithoutFilters?: boolean;

IElementsQueryOptions.orderproperty

Ordering of the elements

order?: SortDirection;