IElementsQueryOptions

Home > @gooddata/sdk-backend-spi > IElementsQueryOptions

IElementsQueryOptions interface

Configuration options for querying attribute elements

Signature:

export interface IElementsQueryOptions

Properties

PropertyModifiersTypeDescription
cacheId?string(Optional) Cache ID to use when requesting subsequent elements from the backend.
complement?boolean(Optional) If true, the filter prop will behave negatively - i.e. it will not include items matching the filter value.
elements?ElementsQueryOptionsElementsSpecification(Optional) Specify particular elements to load.
excludePrimaryLabel?boolean

(Optional) 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.

filter?string(Optional) Filter elements by text value
filterByPrimaryLabel?boolean(Optional) Provided filter uses values from primary label.
includeTotalCountWithoutFilters?boolean(Optional) Include the total count of all elements in the response (without filters applied)
order?SortDirection(Optional) Ordering of the elements
← IElementsQueryFactoryIElementsQueryOptionsElementsByPrimaryDisplayFormValue →