IAttributeLoader
Home > @gooddata/sdk-ui-filters > IAttributeLoader
IAttributeLoader interface
Handles the loading of the attribute metadata.
Signature:
export interface IAttributeLoader
Properties
| Property | Type | Description |
|---|---|---|
| onLoadAttributeCancel | CallbackRegistration<OnLoadAttributeCancelCallbackPayload> | Registers a callback that will be fired when the attribute load was canceled. Returns unsubscribe function, that will unregister it. |
| onLoadAttributeError | CallbackRegistration<OnLoadAttributeErrorCallbackPayload> | Registers a callback that will be fired when error is thrown during the attribute load. Returns unsubscribe function, that will unregister it. |
| onLoadAttributeStart | CallbackRegistration<OnLoadAttributeStartCallbackPayload> | Registers a callback that will be fired when the attribute load starts. Returns unsubscribe function, that will unregister it, once called.Multiple callbacks can be registered by this function. |
| onLoadAttributeSuccess | CallbackRegistration<OnLoadAttributeSuccessCallbackPayload> | Registers a callback that will be fired when the attribute load is successfuly completed. Returns unsubscribe function, that will unregister it. |
Methods
| Method | Description |
|---|---|
| cancelAttributeLoad() | Cancels the running attribute load, if any. |
| getAttribute() | Returns the loaded attribute. |
| getAttributeError() | Returns error, if it was thrown during the attribute filter load, undefined otherwise. |
| getAttributeStatus() | Returns the current status of the attribute filter load. |
| loadAttribute(correlation) | Loads the metadata object for the attribute, that is used in the attribute filter. |