API Reference@grafana/data › AppPlugin

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}/*If the NavModel is configured, the page will have a managed frame, otheriwse it has full control.NOTE: this structure will change in 7.2+ so that it is managed with a normal react router

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}/*

If the NavModel is configured, the page will have a managed frame, otheriwse it has full control.

NOTE: this structure will change in 7.2+ so that it is managed with a normal react router

Signature

setRootPage(root: ComponentClass<AppRootProps<T>>, rootNav?: NavModel): this;

Parameters

Parameter Type Description
root ComponentClass<AppRootProps<T>>
rootNav NavModel

Returns:

this