IAttributeFilterLoader

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

IAttributeFilterLoader interface

Handles the loading of the all required metadata for the attribute filter handler.

Signature:

export interface IAttributeFilterLoader extends IAttributeLoader, IAttributeElementLoader 

Extends: IAttributeLoader, IAttributeElementLoader

Properties

Property	Modifiers	Type	Description
onInitCancel		CallbackRegistration<OnInitCancelCallbackPayload>	Registers a callback that will be fired when the initialization was canceled. Returns unsubscribe function, that will unregister it.
onInitError		CallbackRegistration<OnInitErrorCallbackPayload>	Registers a callback that will be fired when error is thrown during the initialization. Returns unsubscribe function, that will unregister it.
onInitStart		CallbackRegistration<OnInitStartCallbackPayload>	Registers a callback that will be fired when the initialization starts. Returns unsubscribe function, that will unregister it, once called.
onInitSuccess		CallbackRegistration<OnInitSuccessCallbackPayload>	Registers a callback that will be fired when the initialization is successfuly completed. Returns unsubscribe function, that will unregister it.
onUpdate		CallbackRegistration<void>	Registers a callback that will be fired when some data of the attribute filter handler has been changed/updated. Returns unsubscribe function, that will unregister it.

Methods

Method	Description
getFilter()	Get the effective filter for execution.
getFilterToDisplay()	Get the filter to display in component, including custom displayAsLabel applied. Note: This filter is not used for execution and can be completely the same as getFilter one.
getInitError()	Returns error, if it was thrown during the initialization, undefined otherwise.
getInitStatus()	Returns the current status of the initialization.
getOriginalFilter()	Get original filter used for initialization During initialization process of migration to primary label could happen
init(correlation)	Loads all the required data to initialize the attribute filter handler: attribute, selected attribute elements, initial elements page and optionally elements total count (for filters with parent).