mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 01:41:50 +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.
117 lines
3.4 KiB
Markdown
117 lines
3.4 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# 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
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface DataSourcePluginComponents<DSType extends DataSourceApi<TQuery, TOptions>, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData, TSecureOptions = {}>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { DataSourcePluginComponents } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [AnnotationsQueryCtrl](#annotationsqueryctrl-property) | <code>any</code> | |
|
|
| [ConfigEditor](#configeditor-property) | <code>ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>></code> | |
|
|
| [ExploreLogsQueryField](#explorelogsqueryfield-property) | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
|
| [ExploreMetricsQueryField](#exploremetricsqueryfield-property) | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
|
| [ExploreQueryField](#explorequeryfield-property) | <code>ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>></code> | |
|
|
| [ExploreStartPage](#explorestartpage-property) | <code>ComponentType<ExploreStartPageProps></code> | |
|
|
| [MetadataInspector](#metadatainspector-property) | <code>ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>></code> | |
|
|
| [QueryCtrl](#queryctrl-property) | <code>any</code> | |
|
|
| [QueryEditor](#queryeditor-property) | <code>ComponentType<QueryEditorProps<DSType, TQuery, TOptions>></code> | |
|
|
| [VariableQueryEditor](#variablequeryeditor-property) | <code>any</code> | |
|
|
|
|
### AnnotationsQueryCtrl property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
AnnotationsQueryCtrl?: any;
|
|
```
|
|
|
|
### ConfigEditor property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
ConfigEditor?: ComponentType<DataSourcePluginOptionsEditorProps<TOptions, TSecureOptions>>;
|
|
```
|
|
|
|
### ExploreLogsQueryField property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
ExploreLogsQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
|
|
```
|
|
|
|
### ExploreMetricsQueryField property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
ExploreMetricsQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
|
|
```
|
|
|
|
### ExploreQueryField property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
ExploreQueryField?: ComponentType<ExploreQueryFieldProps<DSType, TQuery, TOptions>>;
|
|
```
|
|
|
|
### ExploreStartPage property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
ExploreStartPage?: ComponentType<ExploreStartPageProps>;
|
|
```
|
|
|
|
### MetadataInspector property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
MetadataInspector?: ComponentType<MetadataInspectorProps<DSType, TQuery, TOptions>>;
|
|
```
|
|
|
|
### QueryCtrl property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
QueryCtrl?: any;
|
|
```
|
|
|
|
### QueryEditor property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
QueryEditor?: ComponentType<QueryEditorProps<DSType, TQuery, TOptions>>;
|
|
```
|
|
|
|
### VariableQueryEditor property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
VariableQueryEditor?: any;
|
|
```
|