mirror of
https://github.com/grafana/grafana.git
synced 2025-08-02 12:32:11 +08:00
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.
This commit is contained in:
188
docs/sources/packages_api/data/dataqueryrequest.md
Normal file
188
docs/sources/packages_api/data/dataqueryrequest.md
Normal file
@ -0,0 +1,188 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataQueryRequest"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataQueryRequest interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataQueryRequest<TQuery extends DataQuery = DataQuery>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataQueryRequest } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [app](#app-property) | <code>CoreApp | string</code> | |
|
||||
| [cacheTimeout](#cachetimeout-property) | <code>string</code> | |
|
||||
| [dashboardId](#dashboardid-property) | <code>number</code> | |
|
||||
| [endTime](#endtime-property) | <code>number</code> | |
|
||||
| [exploreMode](#exploremode-property) | <code>ExploreMode</code> | |
|
||||
| [interval](#interval-property) | <code>string</code> | |
|
||||
| [intervalMs](#intervalms-property) | <code>number</code> | |
|
||||
| [maxDataPoints](#maxdatapoints-property) | <code>number</code> | |
|
||||
| [panelId](#panelid-property) | <code>number</code> | |
|
||||
| [range](#range-property) | <code>TimeRange</code> | |
|
||||
| [rangeRaw](#rangeraw-property) | <code>RawTimeRange</code> | |
|
||||
| [requestId](#requestid-property) | <code>string</code> | |
|
||||
| [reverse](#reverse-property) | <code>boolean</code> | |
|
||||
| [scopedVars](#scopedvars-property) | <code>ScopedVars</code> | |
|
||||
| [startTime](#starttime-property) | <code>number</code> | |
|
||||
| [targets](#targets-property) | <code>TQuery[]</code> | |
|
||||
| [timeInfo](#timeinfo-property) | <code>string</code> | |
|
||||
| [timezone](#timezone-property) | <code>string</code> | |
|
||||
|
||||
### app property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
app: CoreApp | string;
|
||||
```
|
||||
|
||||
### cacheTimeout property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
cacheTimeout?: string;
|
||||
```
|
||||
|
||||
### dashboardId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dashboardId: number;
|
||||
```
|
||||
|
||||
### endTime property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
endTime?: number;
|
||||
```
|
||||
|
||||
### exploreMode property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
exploreMode?: ExploreMode;
|
||||
```
|
||||
|
||||
### interval property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
interval: string;
|
||||
```
|
||||
|
||||
### intervalMs property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
intervalMs?: number;
|
||||
```
|
||||
|
||||
### maxDataPoints property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
maxDataPoints?: number;
|
||||
```
|
||||
|
||||
### panelId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
panelId: number;
|
||||
```
|
||||
|
||||
### range property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
range?: TimeRange;
|
||||
```
|
||||
|
||||
### rangeRaw property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
rangeRaw?: RawTimeRange;
|
||||
```
|
||||
|
||||
### requestId property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
requestId: string;
|
||||
```
|
||||
|
||||
### reverse property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
reverse?: boolean;
|
||||
```
|
||||
|
||||
### scopedVars property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
scopedVars: ScopedVars;
|
||||
```
|
||||
|
||||
### startTime property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
startTime: number;
|
||||
```
|
||||
|
||||
### targets property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
targets: TQuery[];
|
||||
```
|
||||
|
||||
### timeInfo property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timeInfo?: string;
|
||||
```
|
||||
|
||||
### timezone property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
timezone: string;
|
||||
```
|
Reference in New Issue
Block a user