mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 09:02:24 +08:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "DataQueryResponse"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## DataQueryResponse interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface DataQueryResponse
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { DataQueryResponse } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [data](#data-property) | <code>DataQueryResponseData[]</code> | The response data. When streaming, this may be empty or a partial result set |
|
|
| [error](#error-property) | <code>DataQueryError</code> | Optionally include error info along with the response data |
|
|
| [key](#key-property) | <code>string</code> | 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](#state-property) | <code>LoadingState</code> | 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
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
data: DataQueryResponseData[];
|
|
```
|
|
|
|
### error property
|
|
|
|
Optionally include error info along with the response data
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
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)
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
key?: string;
|
|
```
|
|
|
|
### state property
|
|
|
|
Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
state?: LoadingState;
|
|
```
|