ReferenceDot

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 | String

  If the x-axis specified by xAxisId is a number axis, the type of x must be Number. If the x-axis specified by xAxisId is a category axis, the value of x must be one of the categorys, otherwise no dot will be drawn.

• yNumber | String

  If the y-axis specified by yAxisId is a number axis, the type of y must be Number. If the y-axis specified by yAxisId is a category axis, the value of y must be one of the categorys, otherwise no dot will be drawn.

• ifOverflow'discard' | 'hidden' | 'visible' | 'extendDomain'

  Defines how to draw the reference dot if it falls partly outside the canvas. If set to 'discard', the reference dot will not be drawn at all. If set to 'hidden', the reference dot will be clipped to the canvas. If set to 'visible', the reference dot will be drawn completely. If set to 'extendDomain', the domain of the overflown axis will be extended such that the reference dot fits into the canvas.

  DEFAULT: 'discard'

• 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:

  <ReferenceDot x="a" y={400} label="MAX"/>
  <ReferenceDot x="a" y={400} label={<CustomizedLabel />}/>
  <ReferenceDot x="a" y={400} label={renderLabel} />

• shapeReactElement | Functionoptional

  If set a ReactElement, the shape of dot can be customized. If set a function, the function will be called to render customized shape.

• onClickFunctionoptional

  The customized event handler of click in this chart.

• onMouseDownFunctionoptional

  The customized event handler of mousedown in this chart.

• onMouseUpFunctionoptional

  The customized event handler of mouseup in this chart.

• onMouseOverFunctionoptional

  The customized event handler of mouseover in this chart.

• onMouseOutFunctionoptional

  The customized event handler of mouseout in this chart.

• onMouseEnterFunctionoptional

  The customized event handler of mouseenter in this chart.

• onMouseMoveFunctionoptional

  The customized event handler of mousemove in this chart.

• onMouseLeaveFunctionoptional

  The customized event handler of mouseleave in this chart.