mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 19:52:35 +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.
3.0 KiB
3.0 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "AppPlugin" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
AppPlugin class
Signature
export declare class AppPlugin<T = KeyValue> extends GrafanaPlugin<AppPluginMeta<T>>
Import
import { AppPlugin } from '@grafana/data';
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| angularPages | { [component: string]: any; } |
||
| root | ComponentClass<AppRootProps<T>> |
||
| rootNav | NavModel |
Methods
| Method | Modifiers | Description |
|---|---|---|
| init(meta) | Called after the module has loaded, and before the app is used. This function may be called multiple times on the same instance. The first time, this.meta will be undefined |
|
| setComponentsFromLegacyExports(pluginExports) | ||
| setRootPage(root, rootNav) | Set the component displayed under: /a/${plugin-id}/* |
angularPages property
Signature
angularPages?: {
[component: string]: any;
};
root property
Signature
root?: ComponentClass<AppRootProps<T>>;
rootNav property
Signature
rootNav?: NavModel;
init method
Called after the module has loaded, and before the app is used. This function may be called multiple times on the same instance. The first time, this.meta will be undefined
Signature
init(meta: AppPluginMeta): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| meta | AppPluginMeta |
Returns:
void
setComponentsFromLegacyExports method
Signature
setComponentsFromLegacyExports(pluginExports: any): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| pluginExports | any |
Returns:
void
setRootPage method
Set the component displayed under: /a/${plugin-id}/*
Signature
setRootPage(root: ComponentClass<AppRootProps<T>>, rootNav?: NavModel): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| root | ComponentClass<AppRootProps<T>> |
|
| rootNav | NavModel |
Returns:
this