ReferenceLine
Child Components
Properties
xAxisIdString | Number
The id of x-axis which is corresponding to the data.
DEFAULT: 0
yAxisIdString | Number
The id of y-axis which is corresponding to the data.
DEFAULT: 0
xNumber | Stringoptional
If set a string or a number, a vertical line perpendicular to the x-axis specified by xAxisId will be drawn. If the specified x-axis is a number axis, the type of x must be Number. If the specified x-axis is a category axis, the value of x must be one of the categorys, otherwise no line will be drawn.
yNumber | Stringoptional
If set a string or a number, a horizontal line perpendicular to the y-axis specified by yAxisId will be drawn. If the specified y-axis is a number axis, the type of y must be Number. If the specified y-axis is a category axis, the value of y must be one of the categorys, otherwise no line will be drawn.
alwaysShowBoolean@deprecated
Use 'ifOverflow' instead.
DEFAULT: false
ifOverflow'discard' | 'hidden' | 'visible' | 'extendDomain'
Defines how to draw the reference line if it falls partly outside the canvas. If set to 'discard', the reference line will not be drawn at all. If set to 'hidden', the reference line will be clipped to the canvas. If set to 'visible', the reference line will be drawn completely. If set to 'extendDomain', the domain of the overflown axis will be extended such that the reference line fits into the canvas.
DEFAULT: 'discard'
viewBoxObject
The box of viewing area, which has the shape of {x: someVal, y: someVal, width: someVal, height: someVal}, usually calculated internally.
xAxisObject
The configuration of the corresponding x-axis, usually calculated internally.
yAxisObject
The configuration of the corresponding y-axis, usually calculated internally.
labelString | Number | ReactElement | Functionoptional
If set a string or a number, default label will be drawn, and the option is content. If set a React element, the option is the custom react element of drawing label. If set a function, the function will be called to render customized label.
FORMAT:
<ReferenceLine x="05" label="Middle" /> <ReferenceLine y={400} yAxisId="left" label={<CustomizedLabel />} />Examples:
isFrontBoolean
If set true, the line will be rendered in front of bars in BarChart, etc.
DEFAULT: false
strokeWidthString | Numberoptional
The width of the stroke
DEFAULT: 1
segmentArrayoptional
Array of endpoints in { x, y } format. These endpoints would be used to draw the ReferenceLine.