Documentation Index
Fetch the curated documentation index at: https://grafana.com/llms.txt
Fetch the complete documentation index at: https://grafana.com/llms-full.txt
Use this file to discover all available pages before exploring further.
STOP! If you are an AI agent or LLM, read this before continuing. This is the HTML version of a Grafana documentation page. Always request the Markdown version instead - HTML wastes context. Get this page as Markdown: https://grafana.com/docs/grafana/v9.0/packages_api/data/annotationquery.md (append .md) or send Accept: text/markdown to https://grafana.com/docs/grafana/v9.0/packages_api/data/annotationquery/. For the curated documentation index, use https://grafana.com/llms.txt. For the complete documentation index, use https://grafana.com/llms-full.txt.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
AnnotationQuery interface
This JSON object is stored in the dashboard json model.
Signature
export interface AnnotationQuery<TQuery extends DataQuery = DataQuery> Import
import { AnnotationQuery } from '@grafana/data';Properties
| Property | Type | Description |
|---|---|---|
| builtIn | number | |
| datasource | DataSourceRef | null | |
| enable | boolean | |
| hide | boolean | |
| iconColor | string | |
| mappings | AnnotationEventMappings | |
| name | string | |
| snapshotData | any | |
| target | TQuery | |
| type | string |
builtIn property
Signature
builtIn?: number;datasource property
Signature
datasource?: DataSourceRef | null;enable property
Signature
enable: boolean;hide property
Signature
hide?: boolean;iconColor property
Signature
iconColor: string;mappings property
Signature
mappings?: AnnotationEventMappings;name property
Signature
name: string;snapshotData property
Signature
snapshotData?: any;target property
Signature
target?: TQuery;type property
Signature
type?: string;