Classes

EnumerationDescription
Supported echo event types that can be sent via the EchoSrv.
Describes the current health status of a data source plugin.
MetaAnalyticsEventNameThe meta analytics events that can be added to the echo service.

Functions

InterfaceDescription
Used to enable rendering of Angular components within a React component without losing proper typings.
AngularLoaderUsed to load an Angular component from the context of a React component. Please see the for a proper example.
AzureSettings
Used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. The BackendSrv is using the Fetch API under the hood to handle all the communication.The request function can be used to perform a remote call by specifying a . To make the BackendSrv a bit easier to use we have added a couple of shorthand functions that will use default values executing the request.
DashboardInfoDescribes the basic dashboard information that can be passed as the meta analytics payload.
Describes the payload of a dashboard view event.
DataRequestEventPayloadDescribes the payload of a data request event.
Describes the data request information passed as the meta analytics payload.
DataSourceSrvThis is the entry point for communicating with a datasource that is added as a plugin (both external and internal). Via this service you will get access to the that have a rich API for communicating with the datasource.
EchoBackendDescribes echo backends that can be registered to receive of events.
Describes an echo event.
EchoMetaDescribes the meta information that are sent together with each event.
Used to send events to all the registered backends. This should be accessed via the getEchoSrv() function. Will, by default, flush events to the backends every 10s or when the flush function is triggered.
Error type for fetch function in BackendSrv
Error type for fetch function in BackendSrv
Response for fetch function in BackendSrv
HealthCheckResultDescribes the payload returned when checking the health of a data source plugin.
Describes the payload of a user interaction event.
LocationSrvIf you need to automatically navigate the user to a new place in the application this should be done via the LocationSrv and it will make sure to update the application state accordingly.
MetaAnalyticsEventDescribes meta analytics event with predefined type.
Describes the payload of a pageview event.
PluginCssOptionsOption to specify a plugin css that should be applied for the dark and the light theme.
Describes a size with width/height
TemplateSrvVia the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.For a more in-depth description visit:

Variables

Type AliasDescription
BackendSrvRequestUsed to initiate a remote call via the
HealthCheckResultDetailsDescribes the details in the payload returned when checking the health of a data source plugin.If the ‘message’ key exists, this will be displayed in the error message in DataSourceSettingsPage If the ‘verboseMessage’ key exists, this will be displayed in the expandable details in the error message in DataSourceSettingsPage
Describes interaction event with predefined type.
MetaAnalyticsEventPayloadDescribes the meta analytics payload passed with the
PageviewEchoEventDescribes pageview event with predefined type.
This allows data sources to customize the streaming connection query