IDashboardCustomizationProps
Properties for Dashboard() customization.
export interface IDashboardCustomizationProps extends IDashboardCustomComponentProps
Extends: IDashboardCustomComponentProps
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 |
|---|---|---|---|
(Optional) Specify customization functions. | |||
(ALPHA) (Optional) Provide custom provider to change items rendered in insight menus. | |||
(ALPHA) (Optional) Provide custom configuration for the Menu button. | |||
(ALPHA) (Optional) Provide custom provider to change items rendered in rich text menus. |
Property details
IDashboardCustomizationProps.customizationFnsproperty
Specify customization functions.
customizationFns?: DashboardModelCustomizationFns;
Remarks
The dashboard component will call out to these functions at different points during its lifetime. See documentation of the different functions to learn more.
IDashboardCustomizationProps.insightMenuItemsProviderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Provide custom provider to change items rendered in insight menus.
insightMenuItemsProvider?: InsightMenuItemsProvider;
Remarks
If the function returns an empty array, the menu will not be rendered at all.
IDashboardCustomizationProps.menuButtonConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Provide custom configuration for the Menu button.
menuButtonConfig?: IMenuButtonConfiguration;
IDashboardCustomizationProps.richTextMenuItemsProviderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Provide custom provider to change items rendered in rich text menus.
richTextMenuItemsProvider?: RichTextMenuItemsProvider;
Remarks
If the function returns an empty array, the menu will not be rendered at all.