mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 19:52:35 +08:00
6bc369629d
* 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.
3.4 KiB
3.4 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "DataSourcePluginComponents" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
DataSourcePluginComponents interface
Signature
export interface DataSourcePluginComponents<DSType extends DataSourceApi<TQuery, TOptions>, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData, TSecureOptions = {}>
Import
import { DataSourcePluginComponents } from '@grafana/data';
Properties
| Property | Type | Description |
|---|---|---|
| AnnotationsQueryCtrl | any |
|
| ConfigEditor | ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>> |
|
| ExploreLogsQueryField | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> |
|
| ExploreMetricsQueryField | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> |
|
| ExploreQueryField | ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>> |
|
| ExploreStartPage | ComponentType<ExploreStartPageProps> |
|
| MetadataInspector | ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>> |
|
| QueryCtrl | any |
|
| QueryEditor | ComponentType<QueryEditorProps<DSType, TQuery, TOptions>> |
|
| VariableQueryEditor | any |
AnnotationsQueryCtrl property
Signature
AnnotationsQueryCtrl?: any;
ConfigEditor property
Signature
ConfigEditor?: ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>>;
ExploreLogsQueryField property
Signature
ExploreLogsQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
ExploreMetricsQueryField property
Signature
ExploreMetricsQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
ExploreQueryField property
Signature
ExploreQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
ExploreStartPage property
Signature
ExploreStartPage?: ComponentType<ExploreStartPageProps>;
MetadataInspector property
Signature
MetadataInspector?: ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>>;
QueryCtrl property
Signature
QueryCtrl?: any;
QueryEditor property
Signature
QueryEditor?: ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>;
VariableQueryEditor property
Signature
VariableQueryEditor?: any;