annotation

Index

• fn withBuiltIn(value=0)
• fn withDatasource(value)
• fn withDatasourceMixin(value)
• fn withEnable(value=true)
• fn withExpr(value)
• fn withFilter(value)
• fn withFilterMixin(value)
• fn withHide(value=true)
• fn withIconColor(value)
• fn withName(value)
• fn withTarget(value)
• fn withTargetMixin(value)
• fn withType(value)
• obj datasource
  • fn withType(value)
  • fn withUid(value)
• obj filter
  • fn withExclude(value=true)
  • fn withIds(value)
  • fn withIdsMixin(value)
• obj target
  • fn withLimit(value)
  • fn withMatchAny(value=true)
  • fn withTags(value)
  • fn withTagsMixin(value)
  • fn withType(value)

Fields

fn withBuiltIn

withBuiltIn(value=0)

PARAMETERS:

• value (number)
  • default value: 0

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

fn withDatasource

withDatasource(value)

PARAMETERS:

• value (object)

Ref to a DataSource instance

fn withDatasourceMixin

withDatasourceMixin(value)

PARAMETERS:

• value (object)

Ref to a DataSource instance

fn withEnable

withEnable(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

When enabled the annotation query is issued with every dashboard refresh

fn withExpr

withExpr(value)

PARAMETERS:

• value (string)

fn withFilter

withFilter(value)

PARAMETERS:

• value (object)

Filters to apply when fetching annotations

fn withFilterMixin

withFilterMixin(value)

PARAMETERS:

• value (object)

Filters to apply when fetching annotations

fn withHide

withHide(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

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.

fn withIconColor

withIconColor(value)

PARAMETERS:

• value (string)

Color to use for the annotation event markers

fn withName

withName(value)

PARAMETERS:

• value (string)

Name of annotation.

fn withTarget

withTarget(value)

PARAMETERS:

• value (object)

TODO: this should be a regular DataQuery that depends on the selected dashboard these match the properties of the "grafana" datasouce that is default in most dashboards

fn withTargetMixin

withTargetMixin(value)

PARAMETERS:

• value (object)

TODO: this should be a regular DataQuery that depends on the selected dashboard these match the properties of the "grafana" datasouce that is default in most dashboards

fn withType

withType(value)

PARAMETERS:

• value (string)

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

obj datasource

fn datasource.withType

datasource.withType(value)

PARAMETERS:

• value (string)

The plugin type-id

fn datasource.withUid

datasource.withUid(value)

PARAMETERS:

• value (string)

Specific datasource instance

obj filter

fn filter.withExclude

filter.withExclude(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

Should the specified panels be included or excluded

fn filter.withIds

filter.withIds(value)

PARAMETERS:

• value (array)

Panel IDs that should be included or excluded

fn filter.withIdsMixin

filter.withIdsMixin(value)

PARAMETERS:

• value (array)

Panel IDs that should be included or excluded

obj target

fn target.withLimit

target.withLimit(value)

PARAMETERS:

• value (integer)

Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change

fn target.withMatchAny

target.withMatchAny(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change

fn target.withTags

target.withTags(value)

PARAMETERS:

• value (array)

Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change

fn target.withTagsMixin

target.withTagsMixin(value)

PARAMETERS:

• value (array)

Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change

fn target.withType

target.withType(value)

PARAMETERS:

• value (string)

Only required/valid for the grafana datasource... but code+tests is already depending on it so hard to change