opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 19:52:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/packages_api/data/datasourceplugin.md
Marcus Andersson 6bc369629d Docs: adding first version of the auto-generated packages API docs. (#22107) 
* trying out api-extractor.

* works with our setup of build.

* wip.

* changed the packages so it works better with the api-extractor.

* Changes to make the api-extractor to work.

* cleaned up the api-extractor config files.

* added some more documentation.

* added tsdoc-metadata to gitignore.

* removed the generated docs (will do that in another PR).

* added execute permission to script for generating dosc.

* added so we will push generated docs to branch.

* will clean packages_api on abort.

* Fixed failing tests.

* fixed formatting issue with typedoc comment.

* temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved

* temporary enabled bable namespaces.

* updated build script.

* updated script.

* updated script with some colors.

* changed to camelCase.

* removed spacing.

* Starting to add documentation guidelines.

* added examples headline.

* added menu options.

* added parameters and return values.

* Fixed merge error.

* Added first version of auto-generated docs.

* changed so we use the eslint ignore syntax.

* changed to correct eslint ingnore comment.

* fixed some spelling errors reported by codespell.

* added script to generate docs in current folder.

* updated api docs.

* lerna bootstrap.

* added eror to the ingore words list.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.

* updated the autogenerated dosc.

* adding missing new line.
2020-02-26 10:03:53 +01:00

7.2 KiB
Raw Blame History

+++

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

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

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

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

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