AppPlugin class

Signature

export declare class AppPlugin<T = KeyValue> extends GrafanaPlugin<AppPluginMeta<T>>

Import

import { AppPlugin } from '@grafana/data';

Properties

Methods

root property

Signature

root?: ComponentType<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

Returns:

void

setComponentsFromLegacyExports method

Signature

setComponentsFromLegacyExports(pluginExports: any): void;

Parameters

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: ComponentType<AppRootProps<T>>, rootNav?: NavModel): this;

Parameters

Returns:

this