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.

Grafana documentation API Reference @grafana/data AnnotationQuery

AnnotationQuery interface

This JSON object is stored in the dashboard json model.

Signature

typescript Copy

export interface AnnotationQuery<TQuery extends DataQuery = DataQuery> 

Import

typescript Copy

import { AnnotationQuery } from '@grafana/data';

Properties

builtIn property

Signature

typescript Copy

builtIn?: number;

datasource property

Signature

typescript Copy

datasource?: DataSourceRef | string | null;

enable property

Signature

typescript Copy

enable: boolean;

hide property

Signature

typescript Copy

hide?: boolean;

iconColor property

Signature

typescript Copy

iconColor: string;

mappings property

Signature

typescript Copy

mappings?: AnnotationEventMappings;

name property

Signature

typescript Copy

name: string;

snapshotData property

Signature

typescript Copy

snapshotData?: any;

target property

Signature

typescript Copy

target?: TQuery;

type property

Signature

typescript Copy

type?: string;