mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: adding first version of the auto-generated packages API docs. (#22107)
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
This commit is contained in:
Marcus Andersson
GitHub
78
docs/sources/packages_api/runtime/_index.md
Normal file
78
docs/sources/packages_api/runtime/_index.md
Normal file
@@ -0,0 +1,78 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "@grafana/runtime"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## @grafana/runtime package
|
||||
|
||||
A library containing services, configurations etc. used to interact with the Grafana engine.
|
||||
|
||||
## Classes
|
||||
|
||||
| Class | Description |
|
||||
| --- | --- |
|
||||
| [DataSourceWithBackend](./datasourcewithbackend/) | |
|
||||
| [GrafanaBootConfig](./grafanabootconfig/) | |
|
||||
|
||||
## Enumerations
|
||||
|
||||
| Enumeration | Description |
|
||||
| --- | --- |
|
||||
| [EchoEventType](./echoeventtype/) | |
|
||||
|
||||
## Functions
|
||||
|
||||
| Function | Description |
|
||||
| --- | --- |
|
||||
| [getAngularLoader()](./getangularloader/) | |
|
||||
| [getDataSourceSrv()](./getdatasourcesrv/) | |
|
||||
| [getEchoSrv()](./getechosrv/) | |
|
||||
| [getLocationSrv()](./getlocationsrv/) | |
|
||||
| [loadPluginCss(options)](./loadplugincss/) | |
|
||||
| [setAngularLoader(v)](./setangularloader/) | |
|
||||
| [setDataSourceSrv(instance)](./setdatasourcesrv/) | |
|
||||
| [setEchoSrv(instance)](./setechosrv/) | |
|
||||
| [setLocationSrv(instance)](./setlocationsrv/) | |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [AngularComponent](./angularcomponent/) | |
|
||||
| [AngularLoader](./angularloader/) | |
|
||||
| [BackendSrv](./backendsrv/) | |
|
||||
| [BuildInfo](./buildinfo/) | |
|
||||
| [DataSourceSrv](./datasourcesrv/) | |
|
||||
| [EchoBackend](./echobackend/) | |
|
||||
| [EchoEvent](./echoevent/) | |
|
||||
| [EchoMeta](./echometa/) | |
|
||||
| [EchoSrv](./echosrv/) | |
|
||||
| [LocationSrv](./locationsrv/) | |
|
||||
| [LocationUpdate](./locationupdate/) | |
|
||||
| [MetaAnalyticsEvent](./metaanalyticsevent/) | |
|
||||
| [MetaAnalyticsEventPayload](./metaanalyticseventpayload/) | |
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [config](./config/) | |
|
||||
| [getBackendSrv](./getbackendsrv/) | |
|
||||
| [registerEchoBackend](./registerechobackend/) | |
|
||||
| [reportMetaAnalytics](./reportmetaanalytics/) | |
|
||||
| [setBackendSrv](./setbackendsrv/) | |
|
||||
| [SystemJS](./systemjs/) | |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [BackendSrvRequest](./backendsrvrequest/) | Currently implemented with: https://docs.angularjs.org/api/ng/service/$http\#usage but that will likely change in the future |
|
||||
| [UrlQueryMap](./urlquerymap/) | |
|
||||
| [UrlQueryValue](./urlqueryvalue/) | |
|
||||
|
||||
63
docs/sources/packages_api/runtime/angularcomponent.md
Normal file
63
docs/sources/packages_api/runtime/angularcomponent.md
Normal file
@@ -0,0 +1,63 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AngularComponent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AngularComponent interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AngularComponent
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AngularComponent } from '@grafana/runtime';
|
||||
```
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [destroy()](#destroy-method) | |
|
||||
| [digest()](#digest-method) | |
|
||||
| [getScope()](#getscope-method) | |
|
||||
|
||||
### destroy method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
destroy(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### digest method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
digest(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### getScope method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getScope(): any;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`any`
|
||||
|
||||
47
docs/sources/packages_api/runtime/angularloader.md
Normal file
47
docs/sources/packages_api/runtime/angularloader.md
Normal file
@@ -0,0 +1,47 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "AngularLoader"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## AngularLoader interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface AngularLoader
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { AngularLoader } from '@grafana/runtime';
|
||||
```
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [load(elem, scopeProps, template)](#load-method) | |
|
||||
|
||||
### load method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
load(elem: any, scopeProps: any, template: string): AngularComponent;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| elem | <code>any</code> | |
|
||||
| scopeProps | <code>any</code> | |
|
||||
| template | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`AngularComponent`
|
||||
|
||||
158
docs/sources/packages_api/runtime/backendsrv.md
Normal file
158
docs/sources/packages_api/runtime/backendsrv.md
Normal file
@@ -0,0 +1,158 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "BackendSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## BackendSrv interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface BackendSrv
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { BackendSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [datasourceRequest(options)](#datasourcerequest-method) | |
|
||||
| [delete(url)](#delete-method) | |
|
||||
| [get(url, params, requestId)](#get-method) | |
|
||||
| [patch(url, data)](#patch-method) | |
|
||||
| [post(url, data)](#post-method) | |
|
||||
| [put(url, data)](#put-method) | |
|
||||
| [request(options)](#request-method) | |
|
||||
|
||||
### datasourceRequest method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
datasourceRequest(options: BackendSrvRequest): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>BackendSrvRequest</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### delete method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
delete(url: string): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| url | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### get method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get(url: string, params?: any, requestId?: string): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| url | <code>string</code> | |
|
||||
| params | <code>any</code> | |
|
||||
| requestId | <code>string</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### patch method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
patch(url: string, data?: any): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| url | <code>string</code> | |
|
||||
| data | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### post method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
post(url: string, data?: any): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| url | <code>string</code> | |
|
||||
| data | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### put method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
put(url: string, data?: any): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| url | <code>string</code> | |
|
||||
| data | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### request method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
request(options: BackendSrvRequest): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>BackendSrvRequest</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
34
docs/sources/packages_api/runtime/backendsrvrequest.md
Normal file
34
docs/sources/packages_api/runtime/backendsrvrequest.md
Normal file
@@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "BackendSrvRequest"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## BackendSrvRequest type
|
||||
|
||||
### BackendSrvRequest type
|
||||
|
||||
Currently implemented with: https://docs.angularjs.org/api/ng/service/$http\#usage but that will likely change in the future
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type BackendSrvRequest = {
|
||||
url: string;
|
||||
retry?: number;
|
||||
headers?: any;
|
||||
method?: string;
|
||||
showSuccessAlert?: boolean;
|
||||
requestId?: string;
|
||||
[key: string]: any;
|
||||
};
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { BackendSrvRequest } from '@grafana/runtime';
|
||||
```
|
||||
89
docs/sources/packages_api/runtime/buildinfo.md
Normal file
89
docs/sources/packages_api/runtime/buildinfo.md
Normal file
@@ -0,0 +1,89 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "BuildInfo"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## BuildInfo interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface BuildInfo
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { BuildInfo } from '@grafana/runtime';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [commit](#commit-property) | <code>string</code> | |
|
||||
| [edition](#edition-property) | <code>string</code> | |
|
||||
| [env](#env-property) | <code>string</code> | |
|
||||
| [hasUpdate](#hasupdate-property) | <code>boolean</code> | |
|
||||
| [isEnterprise](#isenterprise-property) | <code>boolean</code> | |
|
||||
| [latestVersion](#latestversion-property) | <code>string</code> | |
|
||||
| [version](#version-property) | <code>string</code> | |
|
||||
|
||||
### commit property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
commit: string;
|
||||
```
|
||||
|
||||
### edition property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
edition: string;
|
||||
```
|
||||
|
||||
### env property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
env: string;
|
||||
```
|
||||
|
||||
### hasUpdate property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasUpdate: boolean;
|
||||
```
|
||||
|
||||
### isEnterprise property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
isEnterprise: boolean;
|
||||
```
|
||||
|
||||
### latestVersion property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
latestVersion: string;
|
||||
```
|
||||
|
||||
### version property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
version: string;
|
||||
```
|
||||
24
docs/sources/packages_api/runtime/config.md
Normal file
24
docs/sources/packages_api/runtime/config.md
Normal file
@@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "config"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## config variable
|
||||
|
||||
### config variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
config: GrafanaBootConfig
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { config } from '@grafana/runtime';
|
||||
```
|
||||
46
docs/sources/packages_api/runtime/datasourcesrv.md
Normal file
46
docs/sources/packages_api/runtime/datasourcesrv.md
Normal file
@@ -0,0 +1,46 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceSrv interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourceSrv
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [get(name, scopedVars)](#get-method) | |
|
||||
|
||||
### get method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
get(name?: string, scopedVars?: ScopedVars): Promise<DataSourceApi>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| name | <code>string</code> | |
|
||||
| scopedVars | <code>ScopedVars</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<DataSourceApi>`
|
||||
|
||||
100
docs/sources/packages_api/runtime/datasourcewithbackend.md
Normal file
100
docs/sources/packages_api/runtime/datasourcewithbackend.md
Normal file
@@ -0,0 +1,100 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceWithBackend"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourceWithBackend class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class DataSourceWithBackend<TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> extends DataSourceApi<TQuery, TOptions>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceWithBackend } from '@grafana/runtime';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(instanceSettings)](#constructor-instancesettings) | | Constructs a new instance of the <code>DataSourceWithBackend</code> class |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [query(request)](#query-method) | | Ideally final -- any other implementation would be wrong! |
|
||||
| [testDatasource()](#testdatasource-method) | | |
|
||||
| [toDataQueryResponse(rsp)](#todataqueryresponse-method) | | This makes the arrow library loading async. |
|
||||
|
||||
### constructor(instanceSettings)
|
||||
|
||||
Constructs a new instance of the `DataSourceWithBackend` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| instanceSettings | <code>DataSourceInstanceSettings<TOptions></code> | |
|
||||
|
||||
### query method
|
||||
|
||||
Ideally final -- any other implementation would be wrong!
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
query(request: DataQueryRequest): Observable<DataQueryResponse>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| request | <code>DataQueryRequest</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Observable<DataQueryResponse>`
|
||||
|
||||
### testDatasource method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
testDatasource(): Promise<{}>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<{}>`
|
||||
|
||||
### toDataQueryResponse method
|
||||
|
||||
This makes the arrow library loading async.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
toDataQueryResponse(rsp: any): Promise<DataQueryResponse>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rsp | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<DataQueryResponse>`
|
||||
|
||||
62
docs/sources/packages_api/runtime/echobackend.md
Normal file
62
docs/sources/packages_api/runtime/echobackend.md
Normal file
@@ -0,0 +1,62 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "EchoBackend"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoBackend interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface EchoBackend<T extends EchoEvent = any, O = any>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { EchoBackend } from '@grafana/runtime';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [addEvent](#addevent-property) | <code>(event: T) => void</code> | |
|
||||
| [flush](#flush-property) | <code>() => void</code> | |
|
||||
| [options](#options-property) | <code>O</code> | |
|
||||
| [supportedEvents](#supportedevents-property) | <code>EchoEventType[]</code> | |
|
||||
|
||||
### addEvent property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
addEvent: (event: T) => void;
|
||||
```
|
||||
|
||||
### flush property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
flush: () => void;
|
||||
```
|
||||
|
||||
### options property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
options: O;
|
||||
```
|
||||
|
||||
### supportedEvents property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
supportedEvents: EchoEventType[];
|
||||
```
|
||||
53
docs/sources/packages_api/runtime/echoevent.md
Normal file
53
docs/sources/packages_api/runtime/echoevent.md
Normal file
@@ -0,0 +1,53 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "EchoEvent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoEvent interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface EchoEvent<T extends EchoEventType = any, P = any>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { EchoEvent } from '@grafana/runtime';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [meta](#meta-property) | <code>EchoMeta</code> | |
|
||||
| [payload](#payload-property) | <code>P</code> | |
|
||||
| [type](#type-property) | <code>EchoEventType</code> | |
|
||||
|
||||
### meta property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
meta: EchoMeta;
|
||||
```
|
||||
|
||||
### payload property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
payload: P;
|
||||
```
|
||||
|
||||
### type property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
type: EchoEventType;
|
||||
```
|
||||
32
docs/sources/packages_api/runtime/echoeventtype.md
Normal file
32
docs/sources/packages_api/runtime/echoeventtype.md
Normal file
@@ -0,0 +1,32 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "EchoEventType"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoEventType enum
|
||||
|
||||
### EchoEventType enum
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum EchoEventType
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { EchoEventType } from '@grafana/runtime';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| MetaAnalytics | <code>"meta-analytics"</code> | |
|
||||
| Performance | <code>"performance"</code> | |
|
||||
|
||||
122
docs/sources/packages_api/runtime/echometa.md
Normal file
122
docs/sources/packages_api/runtime/echometa.md
Normal file
@@ -0,0 +1,122 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "EchoMeta"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoMeta interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface EchoMeta
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { EchoMeta } from '@grafana/runtime';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [screenSize](#screensize-property) | <code>SizeMeta</code> | |
|
||||
| [sessionId](#sessionid-property) | <code>string</code> | A unique browser session |
|
||||
| [timeSinceNavigationStart](#timesincenavigationstart-property) | <code>number</code> | A highres timestamp since navigation start |
|
||||
| [ts](#ts-property) | <code>number</code> | A millisecond epoch |
|
||||
| [url](#url-property) | <code>string</code> | |
|
||||
| [userAgent](#useragent-property) | <code>string</code> | |
|
||||
| [userId](#userid-property) | <code>number</code> | |
|
||||
| [userLogin](#userlogin-property) | <code>string</code> | |
|
||||
| [userSignedIn](#usersignedin-property) | <code>boolean</code> | |
|
||||
| [windowSize](#windowsize-property) | <code>SizeMeta</code> | |
|
||||
|
||||
### screenSize property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
screenSize: SizeMeta;
|
||||
```
|
||||
|
||||
### sessionId property
|
||||
|
||||
A unique browser session
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
sessionId: string;
|
||||
```
|
||||
|
||||
### timeSinceNavigationStart property
|
||||
|
||||
A highres timestamp since navigation start
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timeSinceNavigationStart: number;
|
||||
```
|
||||
|
||||
### ts property
|
||||
|
||||
A millisecond epoch
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
ts: number;
|
||||
```
|
||||
|
||||
### url property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
url?: string;
|
||||
```
|
||||
|
||||
### userAgent property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
userAgent: string;
|
||||
```
|
||||
|
||||
### userId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
userId: number;
|
||||
```
|
||||
|
||||
### userLogin property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
userLogin: string;
|
||||
```
|
||||
|
||||
### userSignedIn property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
userSignedIn: boolean;
|
||||
```
|
||||
|
||||
### windowSize property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
windowSize: SizeMeta;
|
||||
```
|
||||
76
docs/sources/packages_api/runtime/echosrv.md
Normal file
76
docs/sources/packages_api/runtime/echosrv.md
Normal file
@@ -0,0 +1,76 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "EchoSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## EchoSrv interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface EchoSrv
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { EchoSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [addBackend(backend)](#addbackend-method) | |
|
||||
| [addEvent(event, meta)](#addevent-method) | |
|
||||
| [flush()](#flush-method) | |
|
||||
|
||||
### addBackend method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
addBackend(backend: EchoBackend): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| backend | <code>EchoBackend</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### addEvent method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
addEvent<T extends EchoEvent>(event: Omit<T, 'meta'>, meta?: {}): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| event | <code>Omit<T, 'meta'></code> | |
|
||||
| meta | <code>{}</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
### flush method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
flush(): void;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
28
docs/sources/packages_api/runtime/getangularloader.md
Normal file
28
docs/sources/packages_api/runtime/getangularloader.md
Normal file
@@ -0,0 +1,28 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getAngularLoader"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getAngularLoader() function
|
||||
|
||||
### getAngularLoader() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function getAngularLoader(): AngularLoader;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getAngularLoader } from '@grafana/runtime';
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`AngularLoader`
|
||||
|
||||
24
docs/sources/packages_api/runtime/getbackendsrv.md
Normal file
24
docs/sources/packages_api/runtime/getbackendsrv.md
Normal file
@@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getBackendSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getBackendSrv variable
|
||||
|
||||
### getBackendSrv variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getBackendSrv: () => BackendSrv
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getBackendSrv } from '@grafana/runtime';
|
||||
```
|
||||
28
docs/sources/packages_api/runtime/getdatasourcesrv.md
Normal file
28
docs/sources/packages_api/runtime/getdatasourcesrv.md
Normal file
@@ -0,0 +1,28 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getDataSourceSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getDataSourceSrv() function
|
||||
|
||||
### getDataSourceSrv() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function getDataSourceSrv(): DataSourceSrv;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getDataSourceSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataSourceSrv`
|
||||
|
||||
28
docs/sources/packages_api/runtime/getechosrv.md
Normal file
28
docs/sources/packages_api/runtime/getechosrv.md
Normal file
@@ -0,0 +1,28 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getEchoSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getEchoSrv() function
|
||||
|
||||
### getEchoSrv() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function getEchoSrv(): EchoSrv;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getEchoSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`EchoSrv`
|
||||
|
||||
28
docs/sources/packages_api/runtime/getlocationsrv.md
Normal file
28
docs/sources/packages_api/runtime/getlocationsrv.md
Normal file
@@ -0,0 +1,28 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "getLocationSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## getLocationSrv() function
|
||||
|
||||
### getLocationSrv() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function getLocationSrv(): LocationSrv;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { getLocationSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`LocationSrv`
|
||||
|
||||
384
docs/sources/packages_api/runtime/grafanabootconfig.md
Normal file
384
docs/sources/packages_api/runtime/grafanabootconfig.md
Normal file
@@ -0,0 +1,384 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "GrafanaBootConfig"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## GrafanaBootConfig class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare class GrafanaBootConfig
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { GrafanaBootConfig } from '@grafana/runtime';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(options)](#constructor-options) | | Constructs a new instance of the <code>GrafanaBootConfig</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [alertingEnabled](#alertingenabled-property) | | <code>boolean</code> | |
|
||||
| [alertingErrorOrTimeout](#alertingerrorortimeout-property) | | <code>string</code> | |
|
||||
| [alertingMinInterval](#alertingmininterval-property) | | <code>number</code> | |
|
||||
| [alertingNoDataOrNullValues](#alertingnodataornullvalues-property) | | <code>string</code> | |
|
||||
| [allowOrgCreate](#alloworgcreate-property) | | <code>boolean</code> | |
|
||||
| [appSubUrl](#appsuburl-property) | | <code>string</code> | |
|
||||
| [authProxyEnabled](#authproxyenabled-property) | | <code>boolean</code> | |
|
||||
| [autoAssignOrg](#autoassignorg-property) | | <code>boolean</code> | |
|
||||
| [bootData](#bootdata-property) | | <code>any</code> | |
|
||||
| [buildInfo](#buildinfo-property) | | <code>BuildInfo</code> | |
|
||||
| [datasources](#datasources-property) | | <code>{</code><br/><code> [str: string]: DataSourceInstanceSettings;</code><br/><code> }</code> | |
|
||||
| [defaultDatasource](#defaultdatasource-property) | | <code>string</code> | |
|
||||
| [disableLoginForm](#disableloginform-property) | | <code>boolean</code> | |
|
||||
| [disableSanitizeHtml](#disablesanitizehtml-property) | | <code>boolean</code> | |
|
||||
| [disableUserSignUp](#disableusersignup-property) | | <code>boolean</code> | |
|
||||
| [editorsCanAdmin](#editorscanadmin-property) | | <code>boolean</code> | |
|
||||
| [exploreEnabled](#exploreenabled-property) | | <code>boolean</code> | |
|
||||
| [externalUserMngInfo](#externalusermnginfo-property) | | <code>string</code> | |
|
||||
| [externalUserMngLinkName](#externalusermnglinkname-property) | | <code>string</code> | |
|
||||
| [externalUserMngLinkUrl](#externalusermnglinkurl-property) | | <code>string</code> | |
|
||||
| [featureToggles](#featuretoggles-property) | | <code>FeatureToggles</code> | |
|
||||
| [ldapEnabled](#ldapenabled-property) | | <code>boolean</code> | |
|
||||
| [licenseInfo](#licenseinfo-property) | | <code>LicenseInfo</code> | |
|
||||
| [loginError](#loginerror-property) | | <code>any</code> | |
|
||||
| [loginHint](#loginhint-property) | | <code>any</code> | |
|
||||
| [navTree](#navtree-property) | | <code>any</code> | |
|
||||
| [newPanelTitle](#newpaneltitle-property) | | <code>string</code> | |
|
||||
| [oauth](#oauth-property) | | <code>any</code> | |
|
||||
| [panels](#panels-property) | | <code>{</code><br/><code> [key: string]: PanelPluginMeta;</code><br/><code> }</code> | |
|
||||
| [passwordHint](#passwordhint-property) | | <code>any</code> | |
|
||||
| [phantomJSRenderer](#phantomjsrenderer-property) | | <code>boolean</code> | |
|
||||
| [pluginsToPreload](#pluginstopreload-property) | | <code>string[]</code> | |
|
||||
| [samlEnabled](#samlenabled-property) | | <code>boolean</code> | |
|
||||
| [theme](#theme-property) | | <code>GrafanaTheme</code> | |
|
||||
| [verifyEmailEnabled](#verifyemailenabled-property) | | <code>boolean</code> | |
|
||||
| [viewersCanEdit](#viewerscanedit-property) | | <code>boolean</code> | |
|
||||
| [windowTitlePrefix](#windowtitleprefix-property) | | <code>string</code> | |
|
||||
|
||||
### constructor(options)
|
||||
|
||||
Constructs a new instance of the `GrafanaBootConfig` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(options: GrafanaBootConfig);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>GrafanaBootConfig</code> | |
|
||||
|
||||
### alertingEnabled property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alertingEnabled: boolean;
|
||||
```
|
||||
|
||||
### alertingErrorOrTimeout property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alertingErrorOrTimeout: string;
|
||||
```
|
||||
|
||||
### alertingMinInterval property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alertingMinInterval: number;
|
||||
```
|
||||
|
||||
### alertingNoDataOrNullValues property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alertingNoDataOrNullValues: string;
|
||||
```
|
||||
|
||||
### allowOrgCreate property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
allowOrgCreate: boolean;
|
||||
```
|
||||
|
||||
### appSubUrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
appSubUrl: string;
|
||||
```
|
||||
|
||||
### authProxyEnabled property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
authProxyEnabled: boolean;
|
||||
```
|
||||
|
||||
### autoAssignOrg property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
autoAssignOrg: boolean;
|
||||
```
|
||||
|
||||
### bootData property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
bootData: any;
|
||||
```
|
||||
|
||||
### buildInfo property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
buildInfo: BuildInfo;
|
||||
```
|
||||
|
||||
### datasources property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
datasources: {
|
||||
[str: string]: DataSourceInstanceSettings;
|
||||
};
|
||||
```
|
||||
|
||||
### defaultDatasource property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
defaultDatasource: string;
|
||||
```
|
||||
|
||||
### disableLoginForm property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
disableLoginForm: boolean;
|
||||
```
|
||||
|
||||
### disableSanitizeHtml property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
disableSanitizeHtml: boolean;
|
||||
```
|
||||
|
||||
### disableUserSignUp property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
disableUserSignUp: boolean;
|
||||
```
|
||||
|
||||
### editorsCanAdmin property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
editorsCanAdmin: boolean;
|
||||
```
|
||||
|
||||
### exploreEnabled property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exploreEnabled: boolean;
|
||||
```
|
||||
|
||||
### externalUserMngInfo property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
externalUserMngInfo: string;
|
||||
```
|
||||
|
||||
### externalUserMngLinkName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
externalUserMngLinkName: string;
|
||||
```
|
||||
|
||||
### externalUserMngLinkUrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
externalUserMngLinkUrl: string;
|
||||
```
|
||||
|
||||
### featureToggles property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
featureToggles: FeatureToggles;
|
||||
```
|
||||
|
||||
### ldapEnabled property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
ldapEnabled: boolean;
|
||||
```
|
||||
|
||||
### licenseInfo property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
licenseInfo: LicenseInfo;
|
||||
```
|
||||
|
||||
### loginError property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
loginError: any;
|
||||
```
|
||||
|
||||
### loginHint property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
loginHint: any;
|
||||
```
|
||||
|
||||
### navTree property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
navTree: any;
|
||||
```
|
||||
|
||||
### newPanelTitle property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
newPanelTitle: string;
|
||||
```
|
||||
|
||||
### oauth property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
oauth: any;
|
||||
```
|
||||
|
||||
### panels property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
panels: {
|
||||
[key: string]: PanelPluginMeta;
|
||||
};
|
||||
```
|
||||
|
||||
### passwordHint property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
passwordHint: any;
|
||||
```
|
||||
|
||||
### phantomJSRenderer property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
phantomJSRenderer: boolean;
|
||||
```
|
||||
|
||||
### pluginsToPreload property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
pluginsToPreload: string[];
|
||||
```
|
||||
|
||||
### samlEnabled property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
samlEnabled: boolean;
|
||||
```
|
||||
|
||||
### theme property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
theme: GrafanaTheme;
|
||||
```
|
||||
|
||||
### verifyEmailEnabled property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
verifyEmailEnabled: boolean;
|
||||
```
|
||||
|
||||
### viewersCanEdit property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
viewersCanEdit: boolean;
|
||||
```
|
||||
|
||||
### windowTitlePrefix property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
windowTitlePrefix: string;
|
||||
```
|
||||
34
docs/sources/packages_api/runtime/loadplugincss.md
Normal file
34
docs/sources/packages_api/runtime/loadplugincss.md
Normal file
@@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "loadPluginCss"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## loadPluginCss() function
|
||||
|
||||
### loadPluginCss() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function loadPluginCss(options: PluginCssOptions): Promise<any>;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { loadPluginCss } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>PluginCssOptions</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
45
docs/sources/packages_api/runtime/locationsrv.md
Normal file
45
docs/sources/packages_api/runtime/locationsrv.md
Normal file
@@ -0,0 +1,45 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "LocationSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## LocationSrv interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface LocationSrv
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { LocationSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [update(options)](#update-method) | |
|
||||
|
||||
### update method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
update(options: LocationUpdate): void;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>LocationUpdate</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
75
docs/sources/packages_api/runtime/locationupdate.md
Normal file
75
docs/sources/packages_api/runtime/locationupdate.md
Normal file
@@ -0,0 +1,75 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "LocationUpdate"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## LocationUpdate interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface LocationUpdate
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { LocationUpdate } from '@grafana/runtime';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [partial](#partial-property) | <code>boolean</code> | Add the query argument to the existing URL |
|
||||
| [path](#path-property) | <code>string</code> | |
|
||||
| [query](#query-property) | <code>UrlQueryMap</code> | |
|
||||
| [replace](#replace-property) | <code>boolean</code> | |
|
||||
| [routeParams](#routeparams-property) | <code>UrlQueryMap</code> | Do not change this unless you are the angular router |
|
||||
|
||||
### partial property
|
||||
|
||||
Add the query argument to the existing URL
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
partial?: boolean;
|
||||
```
|
||||
|
||||
### path property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
path?: string;
|
||||
```
|
||||
|
||||
### query property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
query?: UrlQueryMap;
|
||||
```
|
||||
|
||||
### replace property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
replace?: boolean;
|
||||
```
|
||||
|
||||
### routeParams property
|
||||
|
||||
Do not change this unless you are the angular router
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
routeParams?: UrlQueryMap;
|
||||
```
|
||||
22
docs/sources/packages_api/runtime/metaanalyticsevent.md
Normal file
22
docs/sources/packages_api/runtime/metaanalyticsevent.md
Normal file
@@ -0,0 +1,22 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "MetaAnalyticsEvent"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## MetaAnalyticsEvent interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface MetaAnalyticsEvent extends EchoEvent<EchoEventType.MetaAnalytics, MetaAnalyticsEventPayload>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { MetaAnalyticsEvent } from '@grafana/runtime';
|
||||
```
|
||||
134
docs/sources/packages_api/runtime/metaanalyticseventpayload.md
Normal file
134
docs/sources/packages_api/runtime/metaanalyticseventpayload.md
Normal file
@@ -0,0 +1,134 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "MetaAnalyticsEventPayload"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## MetaAnalyticsEventPayload interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface MetaAnalyticsEventPayload
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { MetaAnalyticsEventPayload } 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> | |
|
||||
| [dataSize](#datasize-property) | <code>number</code> | |
|
||||
| [datasourceId](#datasourceid-property) | <code>number</code> | |
|
||||
| [datasourceName](#datasourcename-property) | <code>string</code> | |
|
||||
| [duration](#duration-property) | <code>number</code> | |
|
||||
| [error](#error-property) | <code>string</code> | |
|
||||
| [eventName](#eventname-property) | <code>string</code> | |
|
||||
| [folderName](#foldername-property) | <code>string</code> | |
|
||||
| [panelId](#panelid-property) | <code>number</code> | |
|
||||
| [panelName](#panelname-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;
|
||||
```
|
||||
|
||||
### dataSize property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dataSize?: number;
|
||||
```
|
||||
|
||||
### datasourceId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
datasourceId?: number;
|
||||
```
|
||||
|
||||
### datasourceName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
datasourceName: string;
|
||||
```
|
||||
|
||||
### duration property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
duration: number;
|
||||
```
|
||||
|
||||
### error property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
error?: string;
|
||||
```
|
||||
|
||||
### eventName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
eventName: string;
|
||||
```
|
||||
|
||||
### folderName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
folderName?: string;
|
||||
```
|
||||
|
||||
### panelId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
panelId?: number;
|
||||
```
|
||||
|
||||
### panelName property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
panelName?: string;
|
||||
```
|
||||
24
docs/sources/packages_api/runtime/registerechobackend.md
Normal file
24
docs/sources/packages_api/runtime/registerechobackend.md
Normal file
@@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "registerEchoBackend"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## registerEchoBackend variable
|
||||
|
||||
### registerEchoBackend variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
registerEchoBackend: (backend: EchoBackend<any, any>) => void
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { registerEchoBackend } from '@grafana/runtime';
|
||||
```
|
||||
24
docs/sources/packages_api/runtime/reportmetaanalytics.md
Normal file
24
docs/sources/packages_api/runtime/reportmetaanalytics.md
Normal file
@@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "reportMetaAnalytics"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## reportMetaAnalytics variable
|
||||
|
||||
### reportMetaAnalytics variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reportMetaAnalytics: (payload: MetaAnalyticsEventPayload) => void
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { reportMetaAnalytics } from '@grafana/runtime';
|
||||
```
|
||||
34
docs/sources/packages_api/runtime/setangularloader.md
Normal file
34
docs/sources/packages_api/runtime/setangularloader.md
Normal file
@@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "setAngularLoader"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## setAngularLoader() function
|
||||
|
||||
### setAngularLoader() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function setAngularLoader(v: AngularLoader): void;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { setAngularLoader } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| v | <code>AngularLoader</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
24
docs/sources/packages_api/runtime/setbackendsrv.md
Normal file
24
docs/sources/packages_api/runtime/setbackendsrv.md
Normal file
@@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "setBackendSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## setBackendSrv variable
|
||||
|
||||
### setBackendSrv variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
setBackendSrv: (instance: BackendSrv) => void
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { setBackendSrv } from '@grafana/runtime';
|
||||
```
|
||||
34
docs/sources/packages_api/runtime/setdatasourcesrv.md
Normal file
34
docs/sources/packages_api/runtime/setdatasourcesrv.md
Normal file
@@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "setDataSourceSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## setDataSourceSrv() function
|
||||
|
||||
### setDataSourceSrv() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function setDataSourceSrv(instance: DataSourceSrv): void;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { setDataSourceSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| instance | <code>DataSourceSrv</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
34
docs/sources/packages_api/runtime/setechosrv.md
Normal file
34
docs/sources/packages_api/runtime/setechosrv.md
Normal file
@@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "setEchoSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## setEchoSrv() function
|
||||
|
||||
### setEchoSrv() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function setEchoSrv(instance: EchoSrv): void;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { setEchoSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| instance | <code>EchoSrv</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
34
docs/sources/packages_api/runtime/setlocationsrv.md
Normal file
34
docs/sources/packages_api/runtime/setlocationsrv.md
Normal file
@@ -0,0 +1,34 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "setLocationSrv"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## setLocationSrv() function
|
||||
|
||||
### setLocationSrv() function
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare function setLocationSrv(instance: LocationSrv): void;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { setLocationSrv } from '@grafana/runtime';
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| instance | <code>LocationSrv</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`void`
|
||||
|
||||
24
docs/sources/packages_api/runtime/systemjs.md
Normal file
24
docs/sources/packages_api/runtime/systemjs.md
Normal file
@@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "SystemJS"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## SystemJS variable
|
||||
|
||||
### SystemJS variable
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
SystemJS: any
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { SystemJS } from '@grafana/runtime';
|
||||
```
|
||||
24
docs/sources/packages_api/runtime/urlquerymap.md
Normal file
24
docs/sources/packages_api/runtime/urlquerymap.md
Normal file
@@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "UrlQueryMap"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## UrlQueryMap type
|
||||
|
||||
### UrlQueryMap type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type UrlQueryMap = Record<string, UrlQueryValue>;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { UrlQueryMap } from '@grafana/runtime';
|
||||
```
|
||||
24
docs/sources/packages_api/runtime/urlqueryvalue.md
Normal file
24
docs/sources/packages_api/runtime/urlqueryvalue.md
Normal file
@@ -0,0 +1,24 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "UrlQueryValue"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## UrlQueryValue type
|
||||
|
||||
### UrlQueryValue type
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare type UrlQueryValue = string | number | boolean | string[] | number[] | boolean[] | undefined | null;
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { UrlQueryValue } from '@grafana/runtime';
|
||||
```
|
||||
Reference in New Issue
Block a user