mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
72 lines
1.8 KiB
Markdown
72 lines
1.8 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "QueryResultMetaNotice"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## QueryResultMetaNotice interface
|
|
|
|
QueryResultMetaNotice is a structure that provides user notices for query result data
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface QueryResultMetaNotice
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { QueryResultMetaNotice } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [inspect](#inspect-property) | <code>'meta' | 'error' | 'data' | 'stats'</code> | Optionally suggest an appropriate tab for the panel inspector |
|
|
| [link](#link-property) | <code>string</code> | An optional link that may be displayed in the UI. This value may be an absolute URL or relative to grafana root |
|
|
| [severity](#severity-property) | <code>'info' | 'warning' | 'error'</code> | Specify the notice severity |
|
|
| [text](#text-property) | <code>string</code> | Notice descriptive text |
|
|
|
|
### inspect property
|
|
|
|
Optionally suggest an appropriate tab for the panel inspector
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
inspect?: 'meta' | 'error' | 'data' | 'stats';
|
|
```
|
|
|
|
### link property
|
|
|
|
An optional link that may be displayed in the UI. This value may be an absolute URL or relative to grafana root
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
link?: string;
|
|
```
|
|
|
|
### severity property
|
|
|
|
Specify the notice severity
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
severity: 'info' | 'warning' | 'error';
|
|
```
|
|
|
|
### text property
|
|
|
|
Notice descriptive text
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
text: string;
|
|
```
|