mirror of
https://github.com/grafana/grafana.git
synced 2025-08-03 03:13:49 +08:00
Docs: enable packages reference docs for 7-beta (#23953)
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
This commit is contained in:
@ -5,7 +5,6 @@
|
||||
title = "@grafana/runtime"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## @grafana/runtime package
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "AngularComponent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AngularComponent interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "AngularLoader"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AngularLoader interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "BackendSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## BackendSrv interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "BackendSrvRequest"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## BackendSrvRequest type
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "config"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## config variable
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "DashboardInfo"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DashboardInfo interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "DashboardViewEventPayload"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DashboardViewEventPayload interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "DataRequestEventPayload"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataRequestEventPayload interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "DataRequestInfo"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataRequestInfo interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "DataSourceSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceSrv interface
|
||||
@ -27,6 +26,7 @@ import { DataSourceSrv } from '@grafana/runtime';
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [get(name, scopedVars)](#get-method) | |
|
||||
| [getDataSourceSettingsByUid(uid)](#getdatasourcesettingsbyuid-method) | Returns metadata based on UID. |
|
||||
|
||||
### get method
|
||||
|
||||
@ -46,3 +46,22 @@ get(name?: string, scopedVars?: ScopedVars): Promise<DataSourceApi>;
|
||||
|
||||
`Promise<DataSourceApi>`
|
||||
|
||||
### getDataSourceSettingsByUid method
|
||||
|
||||
Returns metadata based on UID.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getDataSourceSettingsByUid(uid: string): DataSourceInstanceSettings | undefined;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| uid | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataSourceInstanceSettings | undefined`
|
||||
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "DataSourceWithBackend"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceWithBackend class
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "EchoBackend"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoBackend interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "EchoEvent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoEvent interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "EchoEventType"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoEventType enum
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "EchoMeta"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoMeta interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "EchoSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoSrv interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "getAngularLoader"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getAngularLoader() function
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "getBackendSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getBackendSrv variable
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "getDataSourceSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getDataSourceSrv() function
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "getEchoSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getEchoSrv() function
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "getLocationSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getLocationSrv() function
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "getTemplateSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getTemplateSrv variable
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "GrafanaBootConfig"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## GrafanaBootConfig class
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "HealthCheckResult"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## HealthCheckResult interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "HealthStatus"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## HealthStatus enum
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "loadPluginCss"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## loadPluginCss() function
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "LocationSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## LocationSrv interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "LocationUpdate"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## LocationUpdate interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "MetaAnalyticsEvent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## MetaAnalyticsEvent interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "MetaAnalyticsEventName"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## MetaAnalyticsEventName enum
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "MetaAnalyticsEventPayload"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## MetaAnalyticsEventPayload type
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "PluginCssOptions"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## PluginCssOptions interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "registerEchoBackend"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## registerEchoBackend variable
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "reportMetaAnalytics"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## reportMetaAnalytics variable
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "SizeMeta"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## SizeMeta interface
|
||||
|
@ -5,7 +5,6 @@
|
||||
title = "TemplateSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## TemplateSrv interface
|
||||
|
Reference in New Issue
Block a user