IDashboardSettingsDialogProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
export interface IDashboardSettingsDialogProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) Analytical backend from which the dashboard obtains data to render. | |||
boolean | (ALPHA) (Optional) Is dashboard setting dialog visible. | ||
(payload: IDashboardSettingsApplyPayload) => void | (ALPHA) Callback to be called when user apply dashboard settings. | ||
() => void | (ALPHA) Callback to be called when user closes the dashboard settings dialog. | ||
(error: GoodDataSdkError) => void | (ALPHA) (Optional) Callback to be called, when error occurs. | ||
string | (ALPHA) Identifier of analytical workspace, from which the dashboard obtains data to render. |
Property details
IDashboardSettingsDialogProps.backendpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Analytical backend from which the dashboard obtains data to render.
backend: IAnalyticalBackend;
IDashboardSettingsDialogProps.isVisiblepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Is dashboard setting dialog visible.
isVisible?: boolean;
IDashboardSettingsDialogProps.onApplypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Callback to be called when user apply dashboard settings.
onApply: (payload: IDashboardSettingsApplyPayload) => void;
IDashboardSettingsDialogProps.onCancelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Callback to be called when user closes the dashboard settings dialog.
onCancel: () => void;
IDashboardSettingsDialogProps.onErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Callback to be called, when error occurs.
onError?: (error: GoodDataSdkError) => void;
IDashboardSettingsDialogProps.workspacepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Identifier of analytical workspace, from which the dashboard obtains data to render.
workspace: string;