IDashboardQuery

Home > @gooddata/sdk-ui-dashboard > IDashboardQuery

IDashboardQuery interface

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

Base type for all dashboard queries. A dashboard query encapsulates how complex, read-only dashboard-specific logic can be can be executed.

Signature:

export interface IDashboardQuery 

Properties

Property	Modifiers	Type	Description
correlationId?	readonly	string	(BETA) (Optional) Correlation ID can be provided when creating a query. Events emitted during the query processing will contain the same correlation ID.
type	readonly	DashboardQueryType	(BETA) Query type. Always starts with "GDC.DASH/QUERY".