IDashboardExtensionProps
Cumulative properties for Dashboard() customization.
export interface IDashboardExtensionProps extends IDashboardEventing, IDashboardCustomizationProps, IDashboardWidgetsOverlayProps, IDashboardThemingProps
Extends: IDashboardEventing, IDashboardCustomizationProps, IDashboardWidgetsOverlayProps, IDashboardThemingProps
Remarks
IMPORTANT: while this interface is marked as public, you also need to heed the maturity annotations on each property. A lot of these properties are at this moment alpha level.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
Context<ReactReduxContextValue | null> | (Optional) Pass instance of ReactReduxContext where the dashboard component’s store should be saved. |
Property details
IDashboardExtensionProps.additionalReduxContextproperty
Pass instance of ReactReduxContext where the dashboard component’s store should be saved.
additionalReduxContext?: Context<ReactReduxContextValue | null>;
Remarks
This is essential if you are dynamically loading dashboard engine and then enriching the dashboard with embedded, local plugins. If such plugins are compiled against sdk-ui-dashboard and use Redux hooks (useDashboardSelect, useDashboardDispatch) then your solution will not work unless you explicitly send your application’s ReactDashboardContext into this prop.
Note: there is no need to use this prop unless you are dynamically loading the engine bundle.