IElementsQuery

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

IElementsQuery interface

Service to query valid attribute elements for particular display form.

Signature:

export interface IElementsQuery extends ICancelable<IElementsQuery>

Extends: ICancelable<IElementsQuery>

Methods

MethodDescription
query()Starts the valid elements query.
withAttributeFilters(filters)Sets the attribute filters that will limit the available elements
withAvailableElementsOnly(validateBy)

Sets the catalog objects based on which the elements are validated, i.e., if set, only the elements that are available with these metrics, attributes, etc. are returned.

Note that this functionality is not supported by every backend.

withDateFilters(filters)Sets the date filters that will limit the available elements
withLimit(limit)Sets number of valid elements to return per page. Default limit is specific per backend
withMeasures(measures)Sets the measures that will limit the available elements - only elements for which the measures have data will be returned.
withOffset(offset)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
withOptions(options)Allows to specify advanced options for the elements query.
← IDateFilterConfigsQueryResultIElementsQueryAttributeFilter →