Skip to main content

RectAnnotation Spec

Defines a line annotation in the chart.

Overview

Compatible Specs

RectAnnotation spec can be used multiple times along with any of the following specs:

Global Specs

Specs

Props

All props can be found via RectAnnotationProps type.

BaseAnnotationSpec Props

Inherits BaseAnnotationSpec props

outside

  • Type: outside?: boolean
  • Default: false

Renders annotation outside of chart area within axis gutter

outsideDimension

  • Type: outsideDimension?: number

Dimension, either height or width, of outside annotation

zIndex

  • Type: zIndex?: number
  • Default: -1

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