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.
3.0 KiB
3.0 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "PluginMeta" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
PluginMeta interface
Signature
export interface PluginMeta<T extends KeyValue = {}>
Import
import { PluginMeta } from '@grafana/data';
Properties
| Property | Type | Description |
|---|---|---|
| baseUrl | string |
|
| defaultNavUrl | string |
|
| dependencies | PluginDependencies |
|
| enabled | boolean |
|
| hasUpdate | boolean |
|
| id | string |
|
| includes | PluginInclude[] |
|
| info | PluginMetaInfo |
|
| jsonData | T |
|
| latestVersion | string |
|
| module | string |
|
| name | string |
|
| pinned | boolean |
|
| secureJsonData | KeyValue |
|
| state | PluginState |
|
| type | PluginType |
baseUrl property
Signature
baseUrl: string;
defaultNavUrl property
Signature
defaultNavUrl?: string;
dependencies property
Signature
dependencies?: PluginDependencies;
enabled property
Signature
enabled?: boolean;
hasUpdate property
Signature
hasUpdate?: boolean;
id property
Signature
id: string;
includes property
Signature
includes?: PluginInclude[];
info property
Signature
info: PluginMetaInfo;
jsonData property
Signature
jsonData?: T;
latestVersion property
Signature
latestVersion?: string;
module property
Signature
module: string;
name property
Signature
name: string;
pinned property
Signature
pinned?: boolean;
secureJsonData property
Signature
secureJsonData?: KeyValue;
state property
Signature
state?: PluginState;
type property
Signature
type: PluginType;