Menu

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.

Enterprise Open source

AnnotationQuery interface

This JSON object is stored in the dashboard json model.

Signature

typescript
export interface AnnotationQuery<TQuery extends DataQuery = DataQuery> 

Import

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

Properties

PropertyTypeDescription
builtInnumber
datasourceDatasourceRef | string | null
enableboolean
hideboolean
iconColorstring
mappingsAnnotationEventMappings
namestring
snapshotDataany
targetTQuery
typestring

builtIn property

Signature

typescript
builtIn?: number;

datasource property

Signature

typescript
datasource?: DatasourceRef | string | null;

enable property

Signature

typescript
enable: boolean;

hide property

Signature

typescript
hide?: boolean;

iconColor property

Signature

typescript
iconColor: string;

mappings property

Signature

typescript
mappings?: AnnotationEventMappings;

name property

Signature

typescript
name: string;

snapshotData property

Signature

typescript
snapshotData?: any;

target property

Signature

typescript
target?: TQuery;

type property

Signature

typescript
type?: string;