IVisualizationProps
Super-interface for all visualization props.
export interface IVisualizationProps
Remarks
Charts, tables or anything else - all should have these basic props.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) Configure drillability; e.g. which parts of the visualization can be interacted with. | |||
ComponentType<IErrorProps> | (Optional) React component to display in the event when there is an error with either obtaining the data from backend or with the data itself. | ||
string | (Optional) Set title to use for exported files. | ||
ComponentType<ILoadingProps> | (Optional) React component to display while loading data from the backend. | ||
string | (Optional) Set Locale for visualization localization. |
Property details
IVisualizationProps.drillableItemsproperty
Configure drillability; e.g. which parts of the visualization can be interacted with.
drillableItems?: ExplicitDrill[];
IVisualizationProps.ErrorComponentproperty
React component to display in the event when there is an error with either obtaining the data from backend or with the data itself.
ErrorComponent?: ComponentType<IErrorProps>;
IVisualizationProps.exportTitleproperty
Set title to use for exported files.
exportTitle?: string;
Remarks
Note: you can also specify export file name as parameters to the export function which you receive in the onExportReady. If you do not specify title here and neither as input to export function, the the name will default to name of the visualization component.
IVisualizationProps.LoadingComponentproperty
React component to display while loading data from the backend.
LoadingComponent?: ComponentType<ILoadingProps>;
IVisualizationProps.localeproperty
Set Locale for visualization localization.
locale?: string;
Remarks
Note: This locale will be used for everything EXCEPT the data being visualized.