mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 23:23:12 +08:00
6bc369629d
* 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.
79 lines
2.5 KiB
Markdown
79 lines
2.5 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# 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/) | |
|
|
|