AnnotationLayer

annotationTypestring

Type of annotation layer

Possible values: [FORMULA, INTERVAL, EVENT, TIME_SERIES]

colorstringnullable

Layer color

descriptionColumnsstring[]

Columns to use as the description. If none are provided, all will be shown.

hideLinebooleannullable

Should line be hidden. Only applies to line annotations

intervalEndColumnstringnullable

Column containing end of interval. Only applies to interval layers

namestringrequired

Name of layer

opacitystringnullable

Opacity of layer

Possible values: [``, opacityLow, opacityMedium, opacityHigh]

overrides objectnullable

which properties should be overridable

showbooleanrequired

Should the layer be shown

showLabelbooleannullable

Should the label always be shown

showMarkersbooleanrequired

Should markers be shown. Only applies to line annotations.

sourceTypestring

Type of source for annotation data

Possible values: [``, line, NATIVE, table]

stylestring

Line style. Only applies to time-series annotations

Possible values: [dashed, dotted, solid, longDashed]

timeColumnstringnullable

Column with event date or interval start date

titleColumnstringnullable

Column with title

valuerequired

For formula annotations, this contains the formula. For other types, this is the primary key of the source object.

widthnumber

Width of annotation line

Possible values: >= 0

AnnotationLayer

{
  "annotationType": "FORMULA",
  "color": "string",
  "descriptionColumns": [
    "string"
  ],
  "hideLine": true,
  "intervalEndColumn": "string",
  "name": "string",
  "opacity": "",
  "overrides": {},
  "show": true,
  "showLabel": true,
  "showMarkers": true,
  "sourceType": "",
  "style": "dashed",
  "timeColumn": "string",
  "titleColumn": "string",
  "width": 0
}