API

Charts

General Components

Cartesian Components

Polar Components

Shapes

ReferenceLine

Draws a line on the chart connecting two points.

This component, unlike line, is aware of the cartesian coordinate system, so you specify the dimensions by using data coordinates instead of pixels.

ReferenceLine will calculate the pixels based on the provided data coordinates.

If you prefer to render using pixels rather than data coordinates, consider using the line SVG element instead.

Related Links

Parent Components

ReferenceLine consumes context provided by these components:

Child Components

ReferenceLine provides context for these components:

Props

  • classNamestringoptional

  • ifOverflow"discard" | "extendDomain" | "hidden" | "visible"optional

    Defines how to draw this component if it falls partly outside the canvas:

    • discard: the whole component will not be drawn at all
    • hidden: the component will be clipped to the chart plot area
    • visible: the component will be drawn completely
    • extendDomain: the domain of the overflown axis will be extended such that the whole component fits into the plot area

    DEFAULT: "discard"

  • label(union of 7 variants)optional

    Renders a single label.

    • false: no labels are rendered
    • string | number: the content of the label
    • object: the props of LabelList component
    • ReactElement: a custom label element
    • function: a render function of custom label

    DEFAULT: false

    Examples:

  • position"end" | "middle" | "start"optional

    The position of the reference line when the axis has bandwidth (e.g., a band scale). This determines where within the band the line is drawn.

    DEFAULT: "middle"

  • segmentreadonly [ { x?: number | string; y?: number | string; }, { x?: number | string; y?: number | string; }, ]optional

    Tuple of coordinates. If defined, renders a diagonal line segment.

  • shapeFunction | ReactNodeoptional

  • strokeWidthnumber | stringoptional

    The width of the stroke

    DEFAULT: 1

  • xnumber | stringoptional

    If defined, renders a vertical line on this position.

    This value is using your chart's domain, so you will provide a data value instead of a pixel value. ReferenceLine will internally calculate the correct pixel position.

    FORMAT: 

    <ReferenceLine x="Monday" />

  • xAxisIdnumber | stringoptional

    The id of x-axis which is corresponding to the data. Required when there are multiple XAxes.

    DEFAULT: 0

  • ynumber | stringoptional

    If defined, renders a horizontal line on this position.

    This value is using your chart's domain, so you will provide a data value instead of a pixel value. ReferenceLine will internally calculate the correct pixel position.

    FORMAT: 

    <ReferenceLine y="Page D" />

    Examples:

  • yAxisIdnumber | stringoptional

    The id of y-axis which is corresponding to the data. Required when there are multiple YAxes.

    DEFAULT: 0

  • zIndexnumberoptional

    Z-Index of this component and its children. The higher the value, the more on top it will be rendered. Components with higher zIndex will appear in front of components with lower zIndex. If undefined or 0, the content is rendered in the default layer without portals.

    DEFAULT: 400

    Examples: