IAttributeElementLoader

Home > @gooddata/sdk-ui-filters > IAttributeElementLoader

IAttributeElementLoader interface

Handles the loading of the attribute elements.

Signature:

export interface IAttributeElementLoader 

Properties

Property	Modifiers	Type	Description
onInitTotalCountCancel		CallbackRegistration<OnInitTotalCountCancelCallbackPayload>	Registers a callback that will be fired when the initialization of total count was canceled. Returns unsubscribe function, that will unregister it.
onInitTotalCountError		CallbackRegistration<OnInitTotalCountErrorCallbackPayload>	Registers a callback that will be fired when error is thrown during the total count initialization. Returns unsubscribe function, that will unregister it.
onInitTotalCountStart		CallbackRegistration<OnInitTotalCountStartCallbackPayload>	Registers a callback that will be fired when the initialization of total count starts. Returns unsubscribe function, that will unregister it, once called.
onInitTotalCountSuccess		CallbackRegistration<OnInitTotalCountSuccessCallbackPayload>	Registers a callback that will be fired when the initialization of total count is successfully completed. Returns unsubscribe function, that will unregister it.
onLoadCustomElementsCancel		CallbackRegistration<OnLoadCustomElementsCancelCallbackPayload>	Registers a callback that will be fired when the custom elements load was canceled. Returns unsubscribe function, that will unregister it.
onLoadCustomElementsError		CallbackRegistration<OnLoadCustomElementsErrorCallbackPayload>	Registers a callback that will be fired when error is thrown during the custom elements load. Returns unsubscribe function, that will unregister it.
onLoadCustomElementsStart		CallbackRegistration<OnLoadCustomElementsStartCallbackPayload>	Registers a callback that will be fired when the custom elements load starts. Returns unsubscribe function, that will unregister it, once called. Multiple callbacks can be registered by this function.
onLoadCustomElementsSuccess		CallbackRegistration<OnLoadCustomElementsSuccessCallbackPayload>	Registers a callback that will be fired when the custom elements load is successfuly completed. Returns unsubscribe function, that will unregister it.
onLoadInitialElementsPageCancel		CallbackRegistration<OnLoadInitialElementsPageCancelCallbackPayload>	Registers a callback that will be fired when the initial elements page load was canceled. Returns unsubscribe function, that will unregister it.
onLoadInitialElementsPageError		CallbackRegistration<OnLoadInitialElementsPageErrorCallbackPayload>	Registers a callback that will be fired when error is thrown during the initial elements page load. Returns unsubscribe function, that will unregister it.
onLoadInitialElementsPageStart		CallbackRegistration<OnLoadInitialElementsPageStartCallbackPayload>	Registers a callback that will be fired when the initial elements page load starts. Returns unsubscribe function, that will unregister it, once called. Multiple callbacks can be registered by this function.
onLoadInitialElementsPageSuccess		CallbackRegistration<OnLoadInitialElementsPageSuccessCallbackPayload>	Registers a callback that will be fired when the initial elements page load is successfuly completed. Returns unsubscribe function, that will unregister it.
onLoadIrrelevantElementsCancel		CallbackRegistration<OnLoadIrrelevantElementsCancelCallbackPayload>	Registers a callback that will be fired when the irrelevant elements load was canceled. Returns unsubscribe function, that will unregister it.
onLoadIrrelevantElementsError		CallbackRegistration<OnLoadIrrelevantElementsErrorCallbackPayload>	Registers a callback that will be fired when error is thrown during the irrelevant elements load. Returns unsubscribe function, that will unregister it.
onLoadIrrelevantElementsStart		CallbackRegistration<OnLoadIrrelevantElementsStartCallbackPayload>	Registers a callback that will be fired when the irrelevant elements load starts. Returns unsubscribe function, that will unregister it, once called. Multiple callbacks can be registered by this function.
onLoadIrrelevantElementsSuccess		CallbackRegistration<OnLoadIrrelevantElementsSuccessCallbackPayload>	Registers a callback that will be fired when the irrelevant elements load is successfuly completed. Returns unsubscribe function, that will unregister it.
onLoadNextElementsPageCancel		CallbackRegistration<OnLoadNextElementsPageCancelCallbackPayload>	Registers a callback that will be fired when the next elements page load was canceled. Returns unsubscribe function, that will unregister it.
onLoadNextElementsPageError		CallbackRegistration<OnLoadNextElementsPageErrorCallbackPayload>	Registers a callback that will be fired when error is thrown during the next elements page load. Returns unsubscribe function, that will unregister it.
onLoadNextElementsPageStart		CallbackRegistration<OnLoadNextElementsPageStartCallbackPayload>	Registers a callback that will be fired when the next elements page load starts. Returns unsubscribe function, that will unregister it, once called. Multiple callbacks can be registered by this function.
onLoadNextElementsPageSuccess		CallbackRegistration<OnLoadNextElementsPageSuccessCallbackPayload>	Registers a callback that will be fired when the next elements page load is successfuly completed. Returns unsubscribe function, that will unregister it.

Methods

Method	Description
cancelCustomElementsLoad(correlation)	Cancels the running custom elements load, if it matches the specified correlation.
cancelInitialElementsPageLoad()	Cancels the running initial elements page load, if any.
cancelIrrelevantElementsLoad(correlation)	Cancels the running irrelevant elements load, if it matches the specified correlation.
cancelNextElementsPageLoad()	Cancels the running next elements page load, if any.
getAllElements()	Returns all attribute elements loaded by initialElementsPageLoad and nextElementsPageLoad methods.
getDisplayAsLabel()	Get the label used for representing the attribute filter elements visually if defined.
getElementsByKey(keys)	Returns the attribute elements for the specified keys.
getInitialElementsPageError()	Returns error, if it was thrown during the initial elements page load, undefined otherwise.
getInitialElementsPageStatus()	Returns the current status of the initial elements page load.
getInitTotalCountError()	Returns error, if it was thrown during the total count initialization, undefined otherwise.
getInitTotalCountStatus()	Returns the current status of the total count initialization.
getLimit()	Returns the current limit used for the attribute element loads.
getLimitingAttributeFilters()	Returns the current attribute filters used to filter the attribute element loads.
getLimitingAttributeFiltersAttributes()	Returns metadata of the attributes set by IAttributeElementLoader.setLimitingAttributeFilters(). Note that these attributes will be available only after successful initialization, or after successful IAttributeElementLoader.loadInitialElementsPage() load.
getLimitingDateFilters()	Returns the current date filters used to filter the attribute element loads.
getLimitingMeasures()	Returns the current measures used to filter the attribute element loads.
getLimitingValidationItems()	Return the current validation items used to filter the attribute element loads.
getNextElementsPageError()	Returns error, if it was thrown during the next elements page load, undefined otherwise.
getNextElementsPageStatus()	Returns the current status of the next elements page load.
getOffset()	Returns the current offset used for the attribute element loads.
getOrder()	Returns the current order used for the attribute element loads.
getSearch()	Returns the current search string used to filter the attribute element loads.
getTotalElementsCount()	Returns the total count of the attribute elements. Total elements count is loaded by default only for child filters.
getTotalElementsCountWithCurrentSettings()	Returns the total count of the attribute elements with currently set options.
initTotalCount(correlation)	Starts load of total count
loadCustomElements(options, correlation)	Loads the attribute elements with the provided options.
loadInitialElementsPage(correlation)	Resets the paging and loads the attribute elements with the current options.
loadIrrelevantElements(correlation)	Loads the irrelevant subset of currently selected elements. Irrelevant elements are the selected elements that may be filtered out by limiting filters.
loadNextElementsPage(correlation)	Loads next page of the attribute elements with the current options.
setDisplayAsLabel(displayAsLabel)	Set the label used for representing the attribute filter elements visually.
setDisplayForm(displayForm)	Set attribute's display form
setLimit(limit)	Set the limit for the upcoming attribute element loads.
setLimitingAttributeFilters(filters)	Set the attribute filters to filter the upcoming attribute element loads.
setLimitingDateFilters(filters)	Set the date filters to filter the upcoming attribute element loads.
setLimitingMeasures(measures)	Set the measures to filter the upcoming attribute element loads.
setLimitingValidationItems(validateBy)	Set the validation items to filter the upcoming attribute element loads.
setOrder(order)	Set the order for the upcoming attribute element loads.
setSearch(search)	Set the search to filter the upcoming attribute element loads.