IInsightBodyProps
Insight body props.
export interface IInsightBodyProps extends Partial<IVisualizationCallbacks>
Extends: Partial<IVisualizationCallbacks>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
Backend to work with. | |||
IColorPalette | undefined | Configure color palette to use for the chart. If you do not specify this, then the palette will be obtained from style settings stored on the backend. | ||
{ mapboxToken?: string; agGridToken?: string; separators?: ISeparators; forceDisableDrillOnAxes?: boolean; isExportMode?: boolean; selectedPoints?: IDrillEventIntersectionElement[][]; } | Additional config that should be passed to the underlying visualization. | ||
ExplicitDrill[] | undefined | Configure chart drillability; e.g. which parts of the charts can be clicked. | ||
(Optional) This property contains current drill step context. It is undefined if rendered insight is placed directly in the dashboard. It is defined when the insight is rendered in a drill dialog. | |||
ComponentType<IErrorProps> | Component to render if embedding fails. | ||
(Optional) Contains configuration that should be part of insight execution | |||
The insight to render. | |||
(ALPHA) (Optional) Optional precomputed per-layer table definitions for layered visualizations “show as table” rendering. | |||
ComponentType<ILoadingProps> | Component to render while the insight is loading. | ||
Locale to use for localization of texts appearing in the chart. Note: text values coming from the data itself are not localized. | |||
(Optional) The current workspace permissions. | |||
IUserWorkspaceSettings | undefined | The current user settings. | ||
Definition of insight widget to render. | |||
string | Workspace where the insight exists. |
Property details
IInsightBodyProps.backendproperty
Backend to work with.
backend: IAnalyticalBackend;
IInsightBodyProps.colorPaletteproperty
Configure color palette to use for the chart. If you do not specify this, then the palette will be obtained from style settings stored on the backend.
colorPalette: IColorPalette | undefined;
IInsightBodyProps.configproperty
Additional config that should be passed to the underlying visualization.
config: {
mapboxToken?: string;
agGridToken?: string;
separators?: ISeparators;
forceDisableDrillOnAxes?: boolean;
isExportMode?: boolean;
selectedPoints?: IDrillEventIntersectionElement[][];
};
IInsightBodyProps.drillableItemsproperty
Configure chart drillability; e.g. which parts of the charts can be clicked.
drillableItems: ExplicitDrill[] | undefined;
IInsightBodyProps.drillStepproperty
This property contains current drill step context.
It is undefined if rendered insight is placed directly in the dashboard. It is defined when the insight is rendered in a drill dialog.
drillStep?: IDrillStep;
IInsightBodyProps.ErrorComponentproperty
Component to render if embedding fails.
ErrorComponent: ComponentType<IErrorProps>;
IInsightBodyProps.execConfigproperty
Contains configuration that should be part of insight execution
execConfig?: IExecutionConfig;
IInsightBodyProps.insightproperty
The insight to render.
insight: IInsight;
IInsightBodyProps.layerTablespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Optional precomputed per-layer table definitions for layered visualizations “show as table” rendering.
layerTables?: ILayerTableDefinition[];
IInsightBodyProps.LoadingComponentproperty
Component to render while the insight is loading.
LoadingComponent: ComponentType<ILoadingProps>;
IInsightBodyProps.localeproperty
Locale to use for localization of texts appearing in the chart.
Note: text values coming from the data itself are not localized.
locale: ILocale;
IInsightBodyProps.permissionsproperty
The current workspace permissions.
permissions?: IWorkspacePermissions;
IInsightBodyProps.settingsproperty
The current user settings.
settings: IUserWorkspaceSettings | undefined;
IInsightBodyProps.widgetproperty
Definition of insight widget to render.
widget: IInsightWidget;
IInsightBodyProps.workspaceproperty
Workspace where the insight exists.
workspace: string;