ReferenceDot

Props

• childrenReactNodeoptional

• 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

• rnumber | stringoptional

  The radius of dot.

  DEFAULT: 10

• shapeFunction | ReactNodeoptional

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

• xnumber | stringoptional

  The x-coordinate of the center of the dot.

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

  FORMAT:

  <ReferenceDot x="January" y="2026" />

• xAxisIdnumber | stringoptional

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

  DEFAULT: 0

• ynumber | stringoptional

  The y-coordinate of the center of the dot.

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

  FORMAT:

  <ReferenceDot x="January" y="2026" />

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

  Examples:

  • Z-Index and layers guide

• onAbortReactEventHandler<P, T>optional

• onAbortCaptureReactEventHandler<P, T>optional

• onAnimationEndAnimationEventHandler<P, T>optional

• onAnimationEndCaptureAnimationEventHandler<P, T>optional

• onAnimationIterationAnimationEventHandler<P, T>optional

• onAnimationIterationCaptureAnimationEventHandler<P, T>optional

• onAnimationStartAnimationEventHandler<P, T>optional

• onAnimationStartCaptureAnimationEventHandler<P, T>optional

• onAuxClickRechartsMouseEventHandler<P, T>optional

• onAuxClickCaptureRechartsMouseEventHandler<P, T>optional

• onBeforeInputFormEventHandler<P, T>optional

• onBeforeInputCaptureFormEventHandler<P, T>optional

• onBlurFocusEventHandler<P, T>optional

• onBlurCaptureFocusEventHandler<P, T>optional

• onCanPlayReactEventHandler<P, T>optional

• onCanPlayCaptureReactEventHandler<P, T>optional

• onCanPlayThroughReactEventHandler<P, T>optional

• onCanPlayThroughCaptureReactEventHandler<P, T>optional

• onChangeFormEventHandler<P, T>optional

• onChangeCaptureFormEventHandler<P, T>optional

• onClickRechartsMouseEventHandler<P, T>optional

  The customized event handler of click in this chart.

• onClickCaptureRechartsMouseEventHandler<P, T>optional

• onCompositionEndCompositionEventHandler<P, T>optional

• onCompositionEndCaptureCompositionEventHandler<P, T>optional

• onCompositionStartCompositionEventHandler<P, T>optional

• onCompositionStartCaptureCompositionEventHandler<P, T>optional

• onCompositionUpdateCompositionEventHandler<P, T>optional

• onCompositionUpdateCaptureCompositionEventHandler<P, T>optional

• onContextMenuRechartsMouseEventHandler<P, T>optional

• onContextMenuCaptureRechartsMouseEventHandler<P, T>optional

• onCopyClipboardEventHandler<P, T>optional

• onCopyCaptureClipboardEventHandler<P, T>optional

• onCutClipboardEventHandler<P, T>optional

• onCutCaptureClipboardEventHandler<P, T>optional

• onDoubleClickRechartsMouseEventHandler<P, T>optional

• onDoubleClickCaptureRechartsMouseEventHandler<P, T>optional

• onDragDragEventHandler<P, T>optional

• onDragCaptureDragEventHandler<P, T>optional

• onDragEndDragEventHandler<P, T>optional

• onDragEndCaptureDragEventHandler<P, T>optional

• onDragEnterDragEventHandler<P, T>optional

• onDragEnterCaptureDragEventHandler<P, T>optional

• onDragExitDragEventHandler<P, T>optional

• onDragExitCaptureDragEventHandler<P, T>optional

• onDragLeaveDragEventHandler<P, T>optional

• onDragLeaveCaptureDragEventHandler<P, T>optional

• onDragOverDragEventHandler<P, T>optional

• onDragOverCaptureDragEventHandler<P, T>optional

• onDragStartDragEventHandler<P, T>optional

• onDragStartCaptureDragEventHandler<P, T>optional

• onDropDragEventHandler<P, T>optional

• onDropCaptureDragEventHandler<P, T>optional

• onDurationChangeReactEventHandler<P, T>optional

• onDurationChangeCaptureReactEventHandler<P, T>optional

• onEmptiedReactEventHandler<P, T>optional

• onEmptiedCaptureReactEventHandler<P, T>optional

• onEncryptedReactEventHandler<P, T>optional

• onEncryptedCaptureReactEventHandler<P, T>optional

• onEndedReactEventHandler<P, T>optional

• onEndedCaptureReactEventHandler<P, T>optional

• onErrorReactEventHandler<P, T>optional

• onErrorCaptureReactEventHandler<P, T>optional

• onFocusFocusEventHandler<P, T>optional

• onFocusCaptureFocusEventHandler<P, T>optional

• onGotPointerCapturePointerEventHandler<P, T>optional

• onGotPointerCaptureCapturePointerEventHandler<P, T>optional

• onInputFormEventHandler<P, T>optional

• onInputCaptureFormEventHandler<P, T>optional

• onInvalidFormEventHandler<P, T>optional

• onInvalidCaptureFormEventHandler<P, T>optional

• onKeyDownKeyboardEventHandler<P, T>optional

• onKeyDownCaptureKeyboardEventHandler<P, T>optional

• onKeyPressKeyboardEventHandler<P, T>optional

• onKeyPressCaptureKeyboardEventHandler<P, T>optional

• onKeyUpKeyboardEventHandler<P, T>optional

• onKeyUpCaptureKeyboardEventHandler<P, T>optional

• onLoadReactEventHandler<P, T>optional

• onLoadCaptureReactEventHandler<P, T>optional

• onLoadedDataReactEventHandler<P, T>optional

• onLoadedDataCaptureReactEventHandler<P, T>optional

• onLoadedMetadataReactEventHandler<P, T>optional

• onLoadedMetadataCaptureReactEventHandler<P, T>optional

• onLoadStartReactEventHandler<P, T>optional

• onLoadStartCaptureReactEventHandler<P, T>optional

• onLostPointerCapturePointerEventHandler<P, T>optional

• onLostPointerCaptureCapturePointerEventHandler<P, T>optional

• onMouseDownRechartsMouseEventHandler<P, T>optional

  The customized event handler of mousedown in this chart.

• onMouseDownCaptureRechartsMouseEventHandler<P, T>optional

• onMouseEnterRechartsMouseEventHandler<P, T>optional

  The customized event handler of mouseenter in this chart.

• onMouseLeaveRechartsMouseEventHandler<P, T>optional

  The customized event handler of mouseleave in this chart.

• onMouseMoveRechartsMouseEventHandler<P, T>optional

  The customized event handler of mousemove in this chart.

• onMouseMoveCaptureRechartsMouseEventHandler<P, T>optional

• onMouseOutRechartsMouseEventHandler<P, T>optional

  The customized event handler of mouseout in this chart.

• onMouseOutCaptureRechartsMouseEventHandler<P, T>optional

• onMouseOverRechartsMouseEventHandler<P, T>optional

  The customized event handler of mouseover in this chart.

• onMouseOverCaptureRechartsMouseEventHandler<P, T>optional

• onMouseUpRechartsMouseEventHandler<P, T>optional

  The customized event handler of mouseup in this chart.

• onMouseUpCaptureRechartsMouseEventHandler<P, T>optional

• onPasteClipboardEventHandler<P, T>optional

• onPasteCaptureClipboardEventHandler<P, T>optional

• onPauseReactEventHandler<P, T>optional

• onPauseCaptureReactEventHandler<P, T>optional

• onPlayReactEventHandler<P, T>optional

• onPlayCaptureReactEventHandler<P, T>optional

• onPlayingReactEventHandler<P, T>optional

• onPlayingCaptureReactEventHandler<P, T>optional

• onPointerCancelPointerEventHandler<P, T>optional

• onPointerCancelCapturePointerEventHandler<P, T>optional

• onPointerDownPointerEventHandler<P, T>optional

• onPointerDownCapturePointerEventHandler<P, T>optional

• onPointerEnterPointerEventHandler<P, T>optional

• onPointerEnterCapturePointerEventHandler<P, T>optional

• onPointerLeavePointerEventHandler<P, T>optional

• onPointerLeaveCapturePointerEventHandler<P, T>optional

• onPointerMovePointerEventHandler<P, T>optional

• onPointerMoveCapturePointerEventHandler<P, T>optional

• onPointerOutPointerEventHandler<P, T>optional

• onPointerOutCapturePointerEventHandler<P, T>optional

• onPointerOverPointerEventHandler<P, T>optional

• onPointerOverCapturePointerEventHandler<P, T>optional

• onPointerUpPointerEventHandler<P, T>optional

• onPointerUpCapturePointerEventHandler<P, T>optional

• onProgressReactEventHandler<P, T>optional

• onProgressCaptureReactEventHandler<P, T>optional

• onRateChangeReactEventHandler<P, T>optional

• onRateChangeCaptureReactEventHandler<P, T>optional

• onResetFormEventHandler<P, T>optional

• onResetCaptureFormEventHandler<P, T>optional

• onScrollUIEventHandler<P, T>optional

• onScrollCaptureUIEventHandler<P, T>optional

• onSeekedReactEventHandler<P, T>optional

• onSeekedCaptureReactEventHandler<P, T>optional

• onSeekingReactEventHandler<P, T>optional

• onSeekingCaptureReactEventHandler<P, T>optional

• onSelectReactEventHandler<P, T>optional

• onSelectCaptureReactEventHandler<P, T>optional

• onStalledReactEventHandler<P, T>optional

• onStalledCaptureReactEventHandler<P, T>optional

• onSubmitFormEventHandler<P, T>optional

• onSubmitCaptureFormEventHandler<P, T>optional

• onSuspendReactEventHandler<P, T>optional

• onSuspendCaptureReactEventHandler<P, T>optional

• onTimeUpdateReactEventHandler<P, T>optional

• onTimeUpdateCaptureReactEventHandler<P, T>optional

• onTouchCancelTouchEventHandler<P, T>optional

• onTouchCancelCaptureTouchEventHandler<P, T>optional

• onTouchEndTouchEventHandler<P, T>optional

• onTouchEndCaptureTouchEventHandler<P, T>optional

• onTouchMoveTouchEventHandler<P, T>optional

• onTouchMoveCaptureTouchEventHandler<P, T>optional

• onTouchStartTouchEventHandler<P, T>optional

• onTouchStartCaptureTouchEventHandler<P, T>optional

• onTransitionEndTransitionEventHandler<P, T>optional

• onTransitionEndCaptureTransitionEventHandler<P, T>optional

• onVolumeChangeReactEventHandler<P, T>optional

• onVolumeChangeCaptureReactEventHandler<P, T>optional

• onWaitingReactEventHandler<P, T>optional

• onWaitingCaptureReactEventHandler<P, T>optional

• onWheelWheelEventHandler<P, T>optional

• onWheelCaptureWheelEventHandler<P, T>optional