@vx/annotation

Status

We recommend using react-annotation by @susielu. This package is a work in progress. In the future we may make some helpers built on top of react-annotation.

Installation

npm install --save @vx/annotation

Components

• LinePathAnnotation

API

<LinePathAnnotation />

# LinePathAnnotation.className<string>

Add a class name to the line path.

# LinePathAnnotation.label<string>

The text for your label.

# LinePathAnnotation.labelAnchor<enum('start'|'middle'|'end')>

The label's textAnchor.

Default

'middle'

# LinePathAnnotation.labelDx<number>

The x-coordinate shift to the label.

Default

0

# LinePathAnnotation.labelDy<number>

The y-coordinate shift to the label

Default

0

# LinePathAnnotation.labelFill<string>

The color of label. Defaults to props.stroke.

# LinePathAnnotation.labelFontSize<number>

The font size of the label text.

Default

10

# LinePathAnnotation.labelPaintOrder<string>

The label's SVG paint-order.

Default

'stroke'

# LinePathAnnotation.labelStroke<string>

The color of the label.

Default

'white'

# LinePathAnnotation.labelStrokeWidth<number>

The stroke width of the label text.

Default

3

# LinePathAnnotation.left<number>

A left pixel offset applied to the entire bar group.

Default

0

# LinePathAnnotation.points<array>

An array of points describing the line path.

Default

[]

# LinePathAnnotation.stroke<string>

The color of the line.

Default

'black'

# LinePathAnnotation.strokeWidth<number>

The pixel width of the line.

Default

1

# LinePathAnnotation.top<number>

A top pixel offset applied to the entire bar group.

Default

0