IDashboardCustomComponentProps
Home > @gooddata/sdk-ui-dashboard > IDashboardCustomComponentProps
IDashboardCustomComponentProps interface
These props allow you to specify custom components or custom component providers that the Dashboard component will use for rendering different parts of the dashboard.
Signature:
export interface 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 or internal level.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| AlertingDialogComponent? | CustomAlertingDialogComponent | (ALPHA) (Optional) Specify component to use for rendering the alerting dialog. | |
| AlertingManagementDialogComponent? | CustomAlertingManagementDialogComponent | (ALPHA) (Optional) Specify component to use for rendering the alerting management dialog. | |
| ButtonBarComponent? | CustomButtonBarComponent | (ALPHA) (Optional) Specify component to use for rendering the button bar. | |
| DashboardAttributeFilterComponentProvider? | OptionalAttributeFilterComponentProvider | (ALPHA) (Optional) Specify custom component to use for rendering all attribute filters or a factory function to customize the component per different attribute filter. | |
| DashboardContentComponentProvider? | OptionalDashboardContentComponentProvider | (ALPHA) (Optional) Specify function to obtain custom component to use for extend rendering of dashboard content. | |
| DashboardDateFilterComponentProvider? | OptionalDateFilterComponentProvider | (ALPHA) (Optional) Specify component to use for rendering the date filters. | |
| ErrorComponent? | ComponentType<IErrorProps> | (ALPHA) (Optional) Component to render if embedding fails. | |
| FilterBarComponent? | CustomFilterBarComponent | (ALPHA) (Optional) Specify component to use for rendering the filter bar. | |
| InsightBodyComponentProvider? | OptionalInsightBodyComponentProvider | (ALPHA) (Optional) Specify function to obtain custom component to use for rendering an insight body (i.e. the insight itself) in the DefaultDashboardInsight. | |
| InsightComponentProvider? | OptionalInsightComponentProvider | (Optional) Specify function to obtain custom component to use for rendering an insight. | |
| InsightMenuButtonComponentProvider? | OptionalInsightMenuButtonComponentProvider | (ALPHA) (Optional) Specify function to obtain custom component to use for rendering an insight menu button. | |
| InsightMenuComponentProvider? | OptionalInsightMenuComponentProvider | (ALPHA) (Optional) Specify function to obtain custom component to use for rendering an insight menu. | |
| KpiComponentProvider? | OptionalKpiComponentProvider | (Optional) Specify function to obtain custom component to use for rendering a KPI. | |
| LayoutComponent? | CustomDashboardLayoutComponent | (ALPHA) (Optional) Specify component to use for rendering the layout. | |
| LoadingComponent? | ComponentType<ILoadingProps> | (ALPHA) (Optional) Component to render while the dashboard or a widget is loading. | |
| MenuButtonComponent? | CustomMenuButtonComponent | (ALPHA) (Optional) Specify component to use for rendering the menu button. | |
| RichTextComponentProvider? | OptionalRichTextComponentProvider | (Optional) Specify function to obtain custom component to use for rendering a rich text. | |
| SaveAsDialogComponent? | CustomSaveAsDialogComponent | (ALPHA) (Optional) Specify component to use for rendering the save as dialog. | |
| ScheduledEmailDialogComponent? | CustomScheduledEmailDialogComponent | (ALPHA) (Optional) Specify component to use for rendering the scheduled email dialog. | |
| ScheduledEmailManagementDialogComponent? | CustomScheduledEmailManagementDialogComponent | (ALPHA) (Optional) Specify component to use for rendering the scheduled email management dialog. | |
| ShareDialogComponent? | CustomShareDialogComponent | (ALPHA) (Optional) Specify component to use for rendering the share dialog. | |
| SidebarComponent? | CustomSidebarComponent | (ALPHA) (Optional) Specify component to use for rendering the sidebar. | |
| TitleComponent? | CustomTitleComponent | (ALPHA) (Optional) Specify component to use for rendering the title. | |
| TopBarComponent? | CustomTopBarComponent | (ALPHA) (Optional) Specify component to use for rendering the top bar. | |
| VisualizationSwitcherComponentProvider? | OptionalVisualizationSwitcherComponentProvider | (Optional) Specify function to obtain custom component to use for rendering a visualization switcher. | |
| VisualizationSwitcherToolbarComponentProvider? | OptionalVisualizationSwitcherToolbarComponentProvider | (Optional) Specify function to obtain custom component to use for rendering a visualization switcher toolbar. | |
| WidgetComponentProvider? | OptionalWidgetComponentProvider | (Optional) Specify function to obtain custom component to use for rendering a widget. |