IDashboardBaseProps

IDashboardBaseProps.backendproperty

Analytical backend from which the dashboard obtains data to render.

backend?: IAnalyticalBackend;

Remarks

If you do not specify instance of analytical backend using this prop, then you MUST have BackendProvider up in the component tree.

IDashboardBaseProps.configproperty

Configuration that can be used to modify dashboard features, capabilities and behavior.

config?: DashboardConfig;

Remarks

If not specified, then the dashboard will retrieve and use the essential configuration from the backend.

IDashboardBaseProps.dashboardproperty

Specify dashboard to render; you can specify the dashboard either by reference (ObjRef) or by value (of type IDashboard).

dashboard?: string | ObjRef | IDashboard;

Remarks

As a convenience, you may also specify a dashboard object identifier - this is same as using idRef(objectIdentifier).

If you do not specify dashboard to render, a new default empty dashboard will be rendered.

IDashboardBaseProps.filterContextRefproperty

Specify reference to a filter context that should be used instead of the default, built-in filter context.

filterContextRef?: ObjRef;

Remarks

Note: this property only makes sense if you also specify dashboard by reference. If you specify dashboard by value, then the component assumes that the value also contains the desired filter context and will use it as is.

IDashboardBaseProps.initialTabIdpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Explicitly specify which tab should be opened first when the dashboard is rendered.

initialTabId?: string;

Remarks

This prop takes precedence over the dashboard’s persisted activeTabId. If the specified tab ID doesn’t exist, the first tab will be used.

IDashboardBaseProps.keyboardNavigationproperty

Specify tab index and addressable id for the dashboard components used by keyboard navigation

keyboardNavigation?: KeyboardNavigationConfig;

IDashboardBaseProps.permissionsproperty

Specify permissions to use when determining availability of the different features of the dashboard component.

permissions?: IWorkspacePermissions;

Remarks

If you do not specify permissions, the dashboard component will load permissions for the currently logged-in user.

IDashboardBaseProps.workspaceproperty

Identifier of analytical workspace, from which the dashboard obtains data to render.

workspace?: string;

Remarks

If you do not specify workspace identifier, then you MUST have WorkspaceProvider up in the component tree.