AnnotationQueryBuilder🔗

Constructor🔗

new AnnotationQueryBuilder()

Methods🔗

build🔗

Builds the object.

build()

builtIn🔗

Set to 1 for the standard annotation query all dashboards have by default.

builtIn(builtIn: number)

datasource🔗

Datasource where the annotations data is

datasource(datasource: dashboard.DataSourceRef)

enable🔗

When enabled the annotation query is issued with every dashboard refresh

enable(enable: boolean)

expr🔗

expr(expr: string)

filter🔗

Filters to apply when fetching annotations

filter(filter: cog.Builder<dashboard.AnnotationPanelFilter>)

hide🔗

Annotation queries can be toggled on or off at the top of the dashboard.

When hide is true, the toggle is not shown in the dashboard.

hide(hide: boolean)

iconColor🔗

Color to use for the annotation event markers

iconColor(iconColor: string)

name🔗

Name of annotation.

name(name: string)

target🔗

TODO.. this should just be a normal query target

target(target: cog.Builder<dashboard.AnnotationTarget>)

type🔗

TODO -- this should not exist here, it is based on the --grafana-- datasource

type(type: string)

See also🔗

• AnnotationQuery