The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
grafana/docs/sources/packages_api/runtime/dashboardinfo.md

64 lines
1.3 KiB

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DashboardInfo"
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
type = "docs"
+++
## DashboardInfo interface
Describes the basic dashboard information that can be passed as the meta analytics payload.
<b>Signature</b>
```typescript
export interface DashboardInfo
```
<b>Import</b>
```typescript
import { DashboardInfo } from '@grafana/runtime';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [dashboardId](#dashboardid-property) | <code>number</code> | |
| [dashboardName](#dashboardname-property) | <code>string</code> | |
| [dashboardUid](#dashboarduid-property) | <code>string</code> | |
| [folderName](#foldername-property) | <code>string</code> | |
### dashboardId property
<b>Signature</b>
```typescript
dashboardId: number;
```
### dashboardName property
<b>Signature</b>
```typescript
dashboardName: string;
```
### dashboardUid property
<b>Signature</b>
```typescript
dashboardUid: string;
```
### folderName property
<b>Signature</b>
```typescript
folderName?: string;
```