Skip to main content

BaseAnnotationSpec

Base spec to define annotations.

Overrides​

  • specType -> SpecType.Annotation
  • chartType -> ChartType.XYAxis

Props​

Spec Props​

Inherits Spec props

AnnotationPortalSettings Props​

Inherits AnnotationPortalSettings props

annotationType​

  • Types: annotationType: 'rectangle' | 'line'

Annotation type

groupId​

  • Types: groupId: GroupId
  • Default: DEFAULT_GLOBAL_ID

The ID of the axis group, needed for yDomain position

dataValues​

  • Types: dataValues: RectAnnotationDatum | LineAnnotationDatum<D>[]

Data values defined with coordinates and details

style​

  • Types: style?: RecursivePartial<RectAnnotationStyle | LineAnnotationStyle>

Custom annotation style. Overrides Theme styles.

hideTooltips​

  • Types: hideTooltips?: boolean

Toggles tooltip annotation visibility

zIndex​

  • Types: zIndex?: number
  • Default: Assigned per specific annotation spec.

z-index of the annotation relative to other elements in the chart

animations​

  • Types: animations?: AnnotationAnimationConfig[]

Animation configurations for annotations