IGetDashboardOptions

IGetDashboardOptions.exportIdpropertyAlpha

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

Specify id of the currently performed dashboard pdf export. This id is used to retrieve export-related metadata, such as currently active attribute filters.

The id is missing when the dashboard is not loaded in the export mode

exportId?: string;

IGetDashboardOptions.exportTabIdpropertyAlpha

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

Tab identifier to export. Used for export of dashboard with tabs.

exportTabId?: string;

IGetDashboardOptions.exportTypepropertyAlpha

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

Specify type of the currently performed dashboard export. This id is used to retrieve export-related metadata, such as currently active attribute filters.

exportType?: "visual" | "slides";

IGetDashboardOptions.includeAvailableViaLinkpropertyAlpha

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

Specify if also dashboards available only via link should be loaded. Such dashboards may not be supported by every backend.

Defaults to false.

includeAvailableViaLink?: boolean;

IGetDashboardOptions.loadUserDatapropertyAlpha

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

Specify if information about the users that created/modified the dashboard should be loaded. Defaults to false.

If user is inactive or logged in user has not rights to access this information than users that created/modified is undefined.

loadUserData?: boolean;