This is documentation for the next version of Grafana. For the latest stable release, go to the latest version.

API Reference@grafana/dataAnnotationQuery

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 string | 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?: string | 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;