mirror of
https://github.com/grafana/grafana.git
synced 2024-12-01 04:59:15 -06:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
64 lines
1.3 KiB
Markdown
64 lines
1.3 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# 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;
|
|
```
|