Files
grafana/docs/sources/packages_api/data/dataqueryrequest.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

3.4 KiB

+++

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

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

Signature

export interface DataQueryRequest<TQuery extends DataQuery = DataQuery> 

Import

import { DataQueryRequest } from '@grafana/data';

Properties

Property Type Description
app CoreApp | string
cacheTimeout string
dashboardId number
endTime number
exploreMode ExploreMode
interval string
intervalMs number
maxDataPoints number
panelId number
range TimeRange
rangeRaw RawTimeRange
requestId string
reverse boolean
scopedVars ScopedVars
startTime number
targets TQuery[]
timeInfo string
timezone string

app property

Signature

app: CoreApp | string;

cacheTimeout property

Signature

cacheTimeout?: string;

dashboardId property

Signature

dashboardId: number;

endTime property

Signature

endTime?: number;

exploreMode property

Signature

exploreMode?: ExploreMode;

interval property

Signature

interval: string;

intervalMs property

Signature

intervalMs?: number;

maxDataPoints property

Signature

maxDataPoints?: number;

panelId property

Signature

panelId: number;

range property

Signature

range?: TimeRange;

rangeRaw property

Signature

rangeRaw?: RawTimeRange;

requestId property

Signature

requestId: string;

reverse property

Signature

reverse?: boolean;

scopedVars property

Signature

scopedVars: ScopedVars;

startTime property

Signature

startTime: number;

targets property

Signature

targets: TQuery[];

timeInfo property

Signature

timeInfo?: string;

timezone property

Signature

timezone: string;