grafana/docs/sources/packages_api/data/appplugin.md

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "AppPlugin" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

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