IInsightViewProps

IInsightViewProps.backendproperty

Backend to work with.

Note: the backend must come either from this property or from BackendContext. If you do not specify backend here, then the executor MUST be rendered within an existing BackendContext.

backend?: IAnalyticalBackend;

IInsightViewProps.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;

IInsightViewProps.configproperty

When embedding insight rendered by a chart, you can specify extra options to merge with existing options saved for the insight.

config?: IChartConfig | IGeoConfig | IPivotTableConfig | PivotTableNextConfig | any;

IInsightViewProps.drillableItemsproperty

Configure chart drillability; e.g. which parts of the charts can be clicked.

drillableItems?: ExplicitDrill[];

IInsightViewProps.ErrorComponentproperty

Component to render if embedding fails.

ErrorComponent?: ComponentType<IErrorProps>;

IInsightViewProps.execConfigproperty

execConfig will provide the execution with necessary settings before initiating execution.

execConfig?: IExecutionConfig;

IInsightViewProps.executeByReferenceproperty

Indicates that the execution to obtain the data for the insight should be an ’execution by reference'.

Execution by reference means that the InsightView will ask analytical backend to compute results for an insight which is stored on the backend by specifying link to the insight, additional filters and description how to organize the data.

Otherwise, a freeform execution is done, in which the InsightView will send to backend the full execution definition of what to compute.

This distinction is in place because some backends MAY want to prohibit users from doing freeform executions and only allow computing data for set of insights created by admins.

Note: the need for execute by reference is rare. You will typically be notified by the solution admin to use this mode.

executeByReference?: boolean;

IInsightViewProps.filtersproperty

Additional filters to apply on top of the insight.

filters?: IFilter[];

IInsightViewProps.insightproperty

Reference to the insight to render. This can be specified by either object reference using URI or using identifier.

For convenience it is also possible to specify just the identifier of the insight.

insight: ObjRef | string;

IInsightViewProps.LoadingComponentproperty

Component to render while the insight is loading.

LoadingComponent?: ComponentType<ILoadingProps>;

IInsightViewProps.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;

IInsightViewProps.onInsightLoadedproperty

Called when the insight is loaded. This is to allow the embedding code to read the insight data.

onInsightLoaded?: (insight: IInsight) => void;

IInsightViewProps.showTitleproperty

In case this property is boolean it indicates that the title component will be rendered if specified in components properties. In case the property is string, this string must not be empty and will be shown as insight title. In case the property is a function, it should be implemented to take the loaded insight object and return modified title in string representation.

showTitle?: boolean | string | ((insight: IInsight) => string | undefined);

IInsightViewProps.TitleComponentproperty

Component to render insight title.

TitleComponent?: ComponentType<IInsightTitleProps>;

IInsightViewProps.workspaceproperty

Workspace where the insight exists.

Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify workspace here, then the executor MUST be rendered within an existing WorkspaceContext.

workspace?: string;