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

+++

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

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

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

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

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

Constructor	Modifiers	Description
constructor(DataSourceClass)		Constructs a new instance of the DataSourcePlugin class

Properties

Property	Modifiers	Type	Description
components		DataSourcePluginComponents<DSType, TQuery, TOptions, TSecureOptions>
DataSourceClass		DataSourceConstructor<DSType, TQuery, TOptions>

Methods

Method	Modifiers	Description
setAnnotationQueryCtrl(AnnotationsQueryCtrl)
setComponentsFromLegacyExports(pluginExports)
setConfigCtrl(ConfigCtrl)
setConfigEditor(editor)
setExploreLogsQueryField(ExploreQueryField)
setExploreMetricsQueryField(ExploreQueryField)
setExploreQueryField(ExploreQueryField)
setExploreStartPage(ExploreStartPage)
setMetadataInspector(MetadataInspector)
setQueryCtrl(QueryCtrl)
setQueryEditor(QueryEditor)
setVariableQueryEditor(VariableQueryEditor)

constructor(DataSourceClass)

Constructs a new instance of the DataSourcePlugin class

Signature

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

Parameters

Parameter	Type	Description
DataSourceClass	DataSourceConstructor<DSType, TQuery, TOptions>

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

Parameter	Type	Description
AnnotationsQueryCtrl	any

Returns:

this

setComponentsFromLegacyExports method

Signature

setComponentsFromLegacyExports(pluginExports: any): void;

Parameters

Parameter	Type	Description
pluginExports	any

Returns:

void

setConfigCtrl method

Signature

setConfigCtrl(ConfigCtrl: any): this;

Parameters

Parameter	Type	Description
ConfigCtrl	any

Returns:

this

setConfigEditor method

Signature

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

Parameters

Parameter	Type	Description
editor	ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>>

Returns:

this

setExploreLogsQueryField method

Signature

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

Parameters

Parameter	Type	Description
ExploreQueryField	ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>

Returns:

this

setExploreMetricsQueryField method

Signature

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

Parameters

Parameter	Type	Description
ExploreQueryField	ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>

Returns:

this

setExploreQueryField method

Signature

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

Parameters

Parameter	Type	Description
ExploreQueryField	ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>

Returns:

this

setExploreStartPage method

Signature

setExploreStartPage(ExploreStartPage: ComponentType<ExploreStartPageProps>): this;

Parameters

Parameter	Type	Description
ExploreStartPage	ComponentType<ExploreStartPageProps>

Returns:

this

setMetadataInspector method

Signature

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

Parameters

Parameter	Type	Description
MetadataInspector	ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>>

Returns:

this

setQueryCtrl method

Signature

setQueryCtrl(QueryCtrl: any): this;

Parameters

Parameter	Type	Description
QueryCtrl	any

Returns:

this

setQueryEditor method

Signature

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

Parameters

Parameter	Type	Description
QueryEditor	ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>

Returns:

this

setVariableQueryEditor method

Signature

setVariableQueryEditor(VariableQueryEditor: any): this;

Parameters

Parameter	Type	Description
VariableQueryEditor	any

Returns:

this