IGetDashboardOptions · GoodData.UI API reference

Home > @gooddata/sdk-backend-spi > IGetDashboardOptions

IGetDashboardOptions interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Configuration options for getting dashboards.

Signature:

export interface IGetDashboardOptions

Properties

Property	Type	Description
exportId?	string	*(ALPHA)* (Optional) 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
includeAvailableViaLink?	boolean	*(ALPHA)* (Optional) Specify if also dashboards available only via link should be loaded. Such dashboards may not be supported by every backend. Defaults to false.
loadUserData?	boolean	*(ALPHA)* (Optional) 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.

Property

Modifiers

Type

Description

exportId?

string

(ALPHA) (Optional) 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

includeAvailableViaLink?

boolean

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

Defaults to false.

loadUserData?

boolean

(ALPHA) (Optional) 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.