Docs: run the api-extractor on master to update docs (#23726)
* regenerated packages docs. * fixed spelling issues. * fixed spelling issues.
This commit is contained in:
@@ -0,0 +1,64 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DashboardInfo"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## 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;
|
||||
```
|
||||
Reference in New Issue
Block a user