Skip to content

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(float $builtIn)

datasource🔗

Datasource where the annotations data is

datasource(\Grafana\Foundation\Dashboard\DataSourceRef $datasource)

enable🔗

When enabled the annotation query is issued with every dashboard refresh

enable(bool $enable)

expr🔗

expr(string $expr)

filter🔗

Filters to apply when fetching annotations

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\AnnotationPanelFilter> $filter

filter(\Grafana\Foundation\Cog\Builder $filter)

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(bool $hide)

iconColor🔗

Color to use for the annotation event markers

iconColor(string $iconColor)

name🔗

Name of annotation.

name(string $name)

target🔗

TODO.. this should just be a normal query target

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboard\AnnotationTarget> $target

target(\Grafana\Foundation\Cog\Builder $target)

type🔗

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

type(string $type)

See also🔗