mirror of
https://github.com/grafana/grafana.git
synced 2025-09-28 10:33:45 +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.
91 lines
1.9 KiB
Markdown
91 lines
1.9 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "DataQuery"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## DataQuery interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface DataQuery
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { DataQuery } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [datasource](#datasource-property) | <code>string | null</code> | For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. |
|
|
| [hide](#hide-property) | <code>boolean</code> | true if query is disabled (ie not executed / sent to TSDB) |
|
|
| [key](#key-property) | <code>string</code> | Unique, guid like, string used in explore mode |
|
|
| [maxLines](#maxlines-property) | <code>number</code> | For limiting result lines. |
|
|
| [metric](#metric-property) | <code>any</code> | |
|
|
| [refId](#refid-property) | <code>string</code> | A - Z |
|
|
|
|
### datasource property
|
|
|
|
For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
datasource?: string | null;
|
|
```
|
|
|
|
### hide property
|
|
|
|
true if query is disabled (ie not executed / sent to TSDB)
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
hide?: boolean;
|
|
```
|
|
|
|
### key property
|
|
|
|
Unique, guid like, string used in explore mode
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
key?: string;
|
|
```
|
|
|
|
### maxLines property
|
|
|
|
For limiting result lines.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
maxLines?: number;
|
|
```
|
|
|
|
### metric property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
metric?: any;
|
|
```
|
|
|
|
### refId property
|
|
|
|
A - Z
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
refId: string;
|
|
```
|