DashboardStoreAccessor

Home > @gooddata/sdk-ui-dashboard > DashboardStoreAccessor

DashboardStoreAccessor class

This class serves the selector and the dispatcher properties of the dashboard component state.

Signature:

export declare class DashboardStoreAccessor 

Remarks

The component has an optional property through which you can handle set the values for DashboardDispatch and DashboardSelectorEvaluator.

In your component using you can create and instance of the DashboardStoreAccessor object and use it like in the example below. The example shows the accessor's usage as well. There is a need to check the select and dispatch object existence.

See DashboardStoreAccessorRepository on possible way how to use the store accessor.

To get latest properties, use static member function . If there is already an instance created, it will return this instance and will return new instance of the DashboardStoreAccessor otherwise.

Constructors

Constructor	Modifiers	Description
(constructor)(selector, dispatch)		Constructs a new instance of the DashboardStoreAccessor class

Properties

Property	Modifiers	Type	Description
dispatch		DashboardDispatch | undefined
getDashboardDispatch		() => DashboardDispatch	Returns current dispatch object for the dashboard component state.
getDashboardSelect		() => DashboardSelectorEvaluator	Returns current selector for the dashboard's component state.
isDashboardStoreAccessorInitialized		() => boolean	Checks if DashboardStoreAccessor is fully initialized.
selectorEvaluator		DashboardSelectorEvaluator | undefined
setSelectAndDispatch		(state: DashboardState, dispatch: DashboardDispatch) => void	Callback to be passed as component property to set and to handle Dashboard component state from outside of the component.