DataSourcePlugin class

Signature

export declare class DataSourcePlugin<DSType extends DataSourceApi<TQuery, TOptions>, TQuery extends DataQuery = DataSourceQueryType<DSType>, TOptions extends DataSourceJsonData = DataSourceOptionsType<DSType>, TSecureOptions = {}> extends GrafanaPlugin<DataSourcePluginMeta<TOptions>>

Import

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

Constructors

Properties

Methods

constructor(DataSourceClass)

Constructs a new instance of the DataSourcePlugin class

Signature

constructor(DataSourceClass: DataSourceConstructor<DSType, TQuery, TOptions>);

Parameters

components property

Signature

components: DataSourcePluginComponents<DSType, TQuery, TOptions, TSecureOptions>;

DataSourceClass property

Signature

DataSourceClass: DataSourceConstructor<DSType, TQuery, TOptions>;

setAnnotationQueryCtrl method

Signature

setAnnotationQueryCtrl(AnnotationsQueryCtrl: any): this;

Parameters

Returns:

this

setComponentsFromLegacyExports method

Signature

setComponentsFromLegacyExports(pluginExports: any): void;

Parameters

Returns:

void

setConfigCtrl method

Signature

setConfigCtrl(ConfigCtrl: any): this;

Parameters

Returns:

this

setConfigEditor method

Signature

setConfigEditor(editor: ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>>): this;

Parameters

Returns:

this

setExploreLogsQueryField method

Signature

setExploreLogsQueryField(ExploreQueryField: ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>): this;

Parameters

Returns:

this

setExploreMetricsQueryField method

Signature

setExploreMetricsQueryField(ExploreQueryField: ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>): this;

Parameters

Returns:

this

setExploreQueryField method

Signature

setExploreQueryField(ExploreQueryField: ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>): this;

Parameters

Returns:

this

setExploreStartPage method

Signature

setExploreStartPage(ExploreStartPage: ComponentType<QueryEditorHelpProps<TQuery>>): this;

Parameters

Returns:

this

setMetadataInspector method

Signature

setMetadataInspector(MetadataInspector: ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>>): this;

Parameters

Returns:

this

setQueryCtrl method

Signature

setQueryCtrl(QueryCtrl: any): this;

Parameters

Returns:

this

setQueryEditor method

Signature

setQueryEditor(QueryEditor: ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>): this;

Parameters

Returns:

this

setQueryEditorHelp method

Signature

setQueryEditorHelp(QueryEditorHelp: ComponentType<QueryEditorHelpProps<TQuery>>): this;

Parameters

Returns:

this

setVariableQueryEditor method

Signature

setVariableQueryEditor(VariableQueryEditor: any): this;

Parameters

Returns:

this