mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 20:02:13 +08:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
68 lines
1.6 KiB
Markdown
68 lines
1.6 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "AnnotationQueryRequest"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## AnnotationQueryRequest interface
|
|
|
|
Options passed to the datasource.annotationQuery method. See docs/plugins/developing/datasource.md
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface AnnotationQueryRequest<MoreOptions = {}>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { AnnotationQueryRequest } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [annotation](#annotation-property) | <code>{</code><br/><code> datasource: string;</code><br/><code> enable: boolean;</code><br/><code> name: string;</code><br/><code> } & MoreOptions</code> | |
|
|
| [dashboard](#dashboard-property) | <code>any</code> | |
|
|
| [range](#range-property) | <code>TimeRange</code> | |
|
|
| [rangeRaw](#rangeraw-property) | <code>RawTimeRange</code> | |
|
|
|
|
### annotation property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
annotation: {
|
|
datasource: string;
|
|
enable: boolean;
|
|
name: string;
|
|
} & MoreOptions;
|
|
```
|
|
|
|
### dashboard property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
dashboard: any;
|
|
```
|
|
|
|
### range property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
range: TimeRange;
|
|
```
|
|
|
|
### rangeRaw property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
rangeRaw: RawTimeRange;
|
|
```
|