grafana/docs/sources/packages_api/data/dataqueryresponse.md
Marcus Andersson cc3fc18076
Docs: enable packages reference docs for 7-beta (#23953)
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
2020-04-28 09:53:58 +02:00

2.0 KiB

+++

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

Do not edit this file. It is automatically generated by API Documenter.

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

title = "DataQueryResponse" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

DataQueryResponse interface

Signature

export interface DataQueryResponse 

Import

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

Properties

Property Type Description
data DataQueryResponseData[] The response data. When streaming, this may be empty or a partial result set
error DataQueryError Optionally include error info along with the response data
key string When returning multiple partial responses or streams Use this key to inform Grafana how to combine the partial responses Multiple responses with same key are replaced (latest used)
state LoadingState Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined

data property

The response data. When streaming, this may be empty or a partial result set

Signature

data: DataQueryResponseData[];

error property

Optionally include error info along with the response data

Signature

error?: DataQueryError;

key property

When returning multiple partial responses or streams Use this key to inform Grafana how to combine the partial responses Multiple responses with same key are replaced (latest used)

Signature

key?: string;

state property

Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined

Signature

state?: LoadingState;