IKpiProps

Props of the Kpi component.

export interface IKpiProps extends IWithLoadingEvents<IRawExecuteProps>

Extends: IWithLoadingEvents<IRawExecuteProps>

Properties

Property	Type	Description
backend?	IAnalyticalBackend	(Optional) Specify an instance of analytical backend instance to work with.
ErrorComponent?	ComponentType<IErrorProps>	(Optional) Specify react component to render if execution fails.
filters?	INullableFilter[]	(Optional) Specify filters to apply during calculation
LoadingComponent?	ComponentType<ILoadingProps>	(Optional) Specify react component to render while the data is loading.
locale?	string	(Optional) Specify locale to use for strings that the Kpi component may render (for instance when encountering errors).
measure	IMeasure	Specify measure whose value should be calculated and rendered.
separators?	ISeparators	(Optional) Specify number separators to use when rendering (segment delimiters, decimal point character)
workspace?	string	(Optional) Specify workspace to work with.

Specify an instance of analytical backend instance to work with.

backend?: IAnalyticalBackend;

Note: if you do not have a BackendProvider above in the component tree, then you MUST specify the backend.

Specify react component to render if execution fails.

ErrorComponent?: ComponentType<IErrorProps>;

Specify filters to apply during calculation

filters?: INullableFilter[];

Specify react component to render while the data is loading.

LoadingComponent?: ComponentType<ILoadingProps>;

Specify locale to use for strings that the Kpi component may render (for instance when encountering errors).

locale?: string;

Specify measure whose value should be calculated and rendered.

measure: IMeasure;

Specify number separators to use when rendering (segment delimiters, decimal point character)

separators?: ISeparators;

Specify workspace to work with.

workspace?: string;

Note: if you do not have a WorkspaceProvider above in the component tree, then you MUST specify the workspace.