Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Grafana documentation API Reference @grafana/data AppPlugin

AppPlugin class

Signature

typescript Copy

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

Import

typescript Copy

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

Properties

Methods

root property

Signature

typescript Copy

root?: ComponentClass<AppRootProps<T>>;

rootNav property

Signature

typescript Copy

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

typescript Copy

init(meta: AppPluginMeta): void;

Parameters

Returns:

void

setComponentsFromLegacyExports method

Signature

typescript Copy

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

typescript Copy

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

Parameters

Returns:

this