API

Charts

General Components

Cartesian Components

Polar Components

Shapes

Scatter

Parent Components

Scatter consumes context provided by these components:

Child Components

Scatter provides context for these components:

Properties

  • activeShape(union of 12 variants)optional

    Scatter symbols can change when user interacts with them.

    FORMAT: 

    <Scatter activeShape={{ fill: 'red' }} />

    Examples:

  • animationBeginnumberoptional

    Specifies when the animation should begin, the unit of this option is ms.

    DEFAULT: 0

  • animationDurationnumberoptional

    Specifies the duration of animation, the unit of this option is ms.

    DEFAULT: 400

  • animationEasing"linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out"optional

    The type of easing function.

    DEFAULT: "linear"

  • childrenReactNodeoptional

  • classNamestringoptional

  • dataArray<any>optional

  • dataKeystring | number | Functionoptional

    Decides how to extract the numerical value of this Scatter from the data:

    • string: the name of the field in the data object;
    • number: the index of the field in the data;
    • function: a function that receives the data object and returns the value of this Scatter.

    If undefined, it will reuse the dataKey of YAxis.

  • hidebooleanoptional

    DEFAULT: false

  • idstringoptional

    Unique identifier of this component. Used as a HTML attribute id, and also to identify this element internally.

    If undefined, Recharts will generate a unique ID automatically.

  • isAnimationActivefalse | true | "auto"optional

    If set false, animation of Scatter points will be disabled. If set "auto", the animation will be disabled in SSR and enabled in browser.

    DEFAULT: "auto"

  • labelfalse | true | ReactNode | Function | Propsoptional

    Renders one label for each data point. Options:

    • true: renders default labels;
    • false: no labels are rendered;
    • object: the props of LabelList component;
    • ReactElement: a custom label element;
    • function: a render function of custom label.

    DEFAULT: false

  • legendType"none" | "circle" | "cross" | "diamond" | "line" | "plainline" | "rect" | "square" | "star" | "triangle" | "wye"optional

    The type of icon in legend. If set to 'none', no legend item will be rendered.

    DEFAULT: "circle"

    FORMAT: 

    <Scatter legendType="diamond" />

  • line(union of 5 variants)optional

    Renders line connecting individual points. Options"

    • false: no line is drawn.
    • true: a default line is drawn.
    • ReactElement: the option is the custom line element.
    • function: the function will be called to render customized line.
    • object: the option is the props of Curve element.

    Also see the lineType prop which controls how is this line calculated.

    DEFAULT: false

    FORMAT: 

    <Scatter line />
<Scatter line={CustomizedLineComponent} />
<Scatter line={{ strokeDasharray: '5 5' }} />

    Examples:

  • lineJointType"step" | "basis" | "basisClosed" | "basisOpen" | "bumpX" | "bumpY" | "bump" | "linear" | "linearClosed" | "natural" | "monotoneX" | "monotoneY" | "monotone" | "stepBefore" | "stepAfter" | CurveFactoryoptional

    Determines the shape of joint line. Same as type prop on Curve, Line and Area components.

    Has no effect if line prop is not set or is false or if lineType is 'fitting'.

    DEFAULT: "linear"

    Examples:

  • lineType"fitting" | "joint"optional

    Determines calculation method of the line if the line prop is set. Options:

    • 'joint': line will be generated by connecting all the points.
    • 'fitting': line will be generated by fitting algorithm (linear regression).

    Has no effect if line prop is not set or is false.

    DEFAULT: "joint"

    FORMAT: 

    <Scatter line lineType="fitting" />

    Examples:

  • namestringoptional

    The name of data. This option will be used in tooltip and legend to represent this graphical item. If no value was set to this option, the value of dataKey will be used alternatively.

  • shape(union of 12 variants)optional

    Determines the shape of individual data points. Can be one of the predefined shapes as a string. If set a ReactElement, the shape of line can be customized. If set a function, the function will be called to render customized shape.

    DEFAULT: "circle"

    FORMAT: 

    <Scatter shape={CustomizedShapeComponent} />
<Scatter shape="diamond" />

    Examples:

  • tooltipType"none"optional

  • xAxisIdstring | numberoptional

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

    DEFAULT: 0

  • yAxisIdstring | numberoptional

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

    DEFAULT: 0

  • zAxisIdstring | numberoptional

    The id of ZAxis which is corresponding to the data. Required when there are multiple ZAxes.

    ZAxis does not render directly, has no ticks and no tick line. It is used to control the size of each scatter point.

    DEFAULT: 0

    Examples:

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

  • onAbortAdaptChildReactEventHandler<P, T>optional

  • onAbortCaptureAdaptChildReactEventHandler<P, T>optional

  • onAnimationEndAdaptChildAnimationEventHandler<P, T>optional

  • onAnimationEndCaptureAdaptChildAnimationEventHandler<P, T>optional

  • onAnimationIterationAdaptChildAnimationEventHandler<P, T>optional

  • onAnimationIterationCaptureAdaptChildAnimationEventHandler<P, T>optional

  • onAnimationStartAdaptChildAnimationEventHandler<P, T>optional

  • onAnimationStartCaptureAdaptChildAnimationEventHandler<P, T>optional

  • onAuxClickAdaptChildMouseEventHandler<P, T>optional

  • onAuxClickCaptureAdaptChildMouseEventHandler<P, T>optional

  • onBeforeInputAdaptChildFormEventHandler<P, T>optional

  • onBeforeInputCaptureAdaptChildFormEventHandler<P, T>optional

  • onBlurAdaptChildFocusEventHandler<P, T>optional

  • onBlurCaptureAdaptChildFocusEventHandler<P, T>optional

  • onCanPlayAdaptChildReactEventHandler<P, T>optional

  • onCanPlayCaptureAdaptChildReactEventHandler<P, T>optional

  • onCanPlayThroughAdaptChildReactEventHandler<P, T>optional

  • onCanPlayThroughCaptureAdaptChildReactEventHandler<P, T>optional

  • onChangeAdaptChildFormEventHandler<P, T>optional

  • onChangeCaptureAdaptChildFormEventHandler<P, T>optional

  • onClickAdaptChildMouseEventHandler<P, T>optional

  • onClickCaptureAdaptChildMouseEventHandler<P, T>optional

  • onCompositionEndAdaptChildCompositionEventHandler<P, T>optional

  • onCompositionEndCaptureAdaptChildCompositionEventHandler<P, T>optional

  • onCompositionStartAdaptChildCompositionEventHandler<P, T>optional

  • onCompositionStartCaptureAdaptChildCompositionEventHandler<P, T>optional

  • onCompositionUpdateAdaptChildCompositionEventHandler<P, T>optional

  • onCompositionUpdateCaptureAdaptChildCompositionEventHandler<P, T>optional

  • onContextMenuAdaptChildMouseEventHandler<P, T>optional

  • onContextMenuCaptureAdaptChildMouseEventHandler<P, T>optional

  • onCopyAdaptChildClipboardEventHandler<P, T>optional

  • onCopyCaptureAdaptChildClipboardEventHandler<P, T>optional

  • onCutAdaptChildClipboardEventHandler<P, T>optional

  • onCutCaptureAdaptChildClipboardEventHandler<P, T>optional

  • onDoubleClickAdaptChildMouseEventHandler<P, T>optional

  • onDoubleClickCaptureAdaptChildMouseEventHandler<P, T>optional

  • onDragAdaptChildDragEventHandler<P, T>optional

  • onDragCaptureAdaptChildDragEventHandler<P, T>optional

  • onDragEndAdaptChildDragEventHandler<P, T>optional

  • onDragEndCaptureAdaptChildDragEventHandler<P, T>optional

  • onDragEnterAdaptChildDragEventHandler<P, T>optional

  • onDragEnterCaptureAdaptChildDragEventHandler<P, T>optional

  • onDragExitAdaptChildDragEventHandler<P, T>optional

  • onDragExitCaptureAdaptChildDragEventHandler<P, T>optional

  • onDragLeaveAdaptChildDragEventHandler<P, T>optional

  • onDragLeaveCaptureAdaptChildDragEventHandler<P, T>optional

  • onDragOverAdaptChildDragEventHandler<P, T>optional

  • onDragOverCaptureAdaptChildDragEventHandler<P, T>optional

  • onDragStartAdaptChildDragEventHandler<P, T>optional

  • onDragStartCaptureAdaptChildDragEventHandler<P, T>optional

  • onDropAdaptChildDragEventHandler<P, T>optional

  • onDropCaptureAdaptChildDragEventHandler<P, T>optional

  • onDurationChangeAdaptChildReactEventHandler<P, T>optional

  • onDurationChangeCaptureAdaptChildReactEventHandler<P, T>optional

  • onEmptiedAdaptChildReactEventHandler<P, T>optional

  • onEmptiedCaptureAdaptChildReactEventHandler<P, T>optional

  • onEncryptedAdaptChildReactEventHandler<P, T>optional

  • onEncryptedCaptureAdaptChildReactEventHandler<P, T>optional

  • onEndedAdaptChildReactEventHandler<P, T>optional

  • onEndedCaptureAdaptChildReactEventHandler<P, T>optional

  • onErrorAdaptChildReactEventHandler<P, T>optional

  • onErrorCaptureAdaptChildReactEventHandler<P, T>optional

  • onFocusAdaptChildFocusEventHandler<P, T>optional

  • onFocusCaptureAdaptChildFocusEventHandler<P, T>optional

  • onGotPointerCaptureAdaptChildPointerEventHandler<P, T>optional

  • onGotPointerCaptureCaptureAdaptChildPointerEventHandler<P, T>optional

  • onInputAdaptChildFormEventHandler<P, T>optional

  • onInputCaptureAdaptChildFormEventHandler<P, T>optional

  • onInvalidAdaptChildFormEventHandler<P, T>optional

  • onInvalidCaptureAdaptChildFormEventHandler<P, T>optional

  • onKeyDownAdaptChildKeyboardEventHandler<P, T>optional

  • onKeyDownCaptureAdaptChildKeyboardEventHandler<P, T>optional

  • onKeyPressAdaptChildKeyboardEventHandler<P, T>optional

  • onKeyPressCaptureAdaptChildKeyboardEventHandler<P, T>optional

  • onKeyUpAdaptChildKeyboardEventHandler<P, T>optional

  • onKeyUpCaptureAdaptChildKeyboardEventHandler<P, T>optional

  • onLoadAdaptChildReactEventHandler<P, T>optional

  • onLoadCaptureAdaptChildReactEventHandler<P, T>optional

  • onLoadedDataAdaptChildReactEventHandler<P, T>optional

  • onLoadedDataCaptureAdaptChildReactEventHandler<P, T>optional

  • onLoadedMetadataAdaptChildReactEventHandler<P, T>optional

  • onLoadedMetadataCaptureAdaptChildReactEventHandler<P, T>optional

  • onLoadStartAdaptChildReactEventHandler<P, T>optional

  • onLoadStartCaptureAdaptChildReactEventHandler<P, T>optional

  • onLostPointerCaptureAdaptChildPointerEventHandler<P, T>optional

  • onLostPointerCaptureCaptureAdaptChildPointerEventHandler<P, T>optional

  • onMouseDownAdaptChildMouseEventHandler<P, T>optional

  • onMouseDownCaptureAdaptChildMouseEventHandler<P, T>optional

  • onMouseEnterAdaptChildMouseEventHandler<P, T>optional

  • onMouseLeaveAdaptChildMouseEventHandler<P, T>optional

  • onMouseMoveAdaptChildMouseEventHandler<P, T>optional

  • onMouseMoveCaptureAdaptChildMouseEventHandler<P, T>optional

  • onMouseOutAdaptChildMouseEventHandler<P, T>optional

  • onMouseOutCaptureAdaptChildMouseEventHandler<P, T>optional

  • onMouseOverAdaptChildMouseEventHandler<P, T>optional

  • onMouseOverCaptureAdaptChildMouseEventHandler<P, T>optional

  • onMouseUpAdaptChildMouseEventHandler<P, T>optional

  • onMouseUpCaptureAdaptChildMouseEventHandler<P, T>optional

  • onPasteAdaptChildClipboardEventHandler<P, T>optional

  • onPasteCaptureAdaptChildClipboardEventHandler<P, T>optional

  • onPauseAdaptChildReactEventHandler<P, T>optional

  • onPauseCaptureAdaptChildReactEventHandler<P, T>optional

  • onPlayAdaptChildReactEventHandler<P, T>optional

  • onPlayCaptureAdaptChildReactEventHandler<P, T>optional

  • onPlayingAdaptChildReactEventHandler<P, T>optional

  • onPlayingCaptureAdaptChildReactEventHandler<P, T>optional

  • onPointerCancelAdaptChildPointerEventHandler<P, T>optional

  • onPointerCancelCaptureAdaptChildPointerEventHandler<P, T>optional

  • onPointerDownAdaptChildPointerEventHandler<P, T>optional

  • onPointerDownCaptureAdaptChildPointerEventHandler<P, T>optional

  • onPointerEnterAdaptChildPointerEventHandler<P, T>optional

  • onPointerEnterCaptureAdaptChildPointerEventHandler<P, T>optional

  • onPointerLeaveAdaptChildPointerEventHandler<P, T>optional

  • onPointerLeaveCaptureAdaptChildPointerEventHandler<P, T>optional

  • onPointerMoveAdaptChildPointerEventHandler<P, T>optional

  • onPointerMoveCaptureAdaptChildPointerEventHandler<P, T>optional

  • onPointerOutAdaptChildPointerEventHandler<P, T>optional

  • onPointerOutCaptureAdaptChildPointerEventHandler<P, T>optional

  • onPointerOverAdaptChildPointerEventHandler<P, T>optional

  • onPointerOverCaptureAdaptChildPointerEventHandler<P, T>optional

  • onPointerUpAdaptChildPointerEventHandler<P, T>optional

  • onPointerUpCaptureAdaptChildPointerEventHandler<P, T>optional

  • onProgressAdaptChildReactEventHandler<P, T>optional

  • onProgressCaptureAdaptChildReactEventHandler<P, T>optional

  • onRateChangeAdaptChildReactEventHandler<P, T>optional

  • onRateChangeCaptureAdaptChildReactEventHandler<P, T>optional

  • onResetAdaptChildFormEventHandler<P, T>optional

  • onResetCaptureAdaptChildFormEventHandler<P, T>optional

  • onScrollAdaptChildUIEventHandler<P, T>optional

  • onScrollCaptureAdaptChildUIEventHandler<P, T>optional

  • onSeekedAdaptChildReactEventHandler<P, T>optional

  • onSeekedCaptureAdaptChildReactEventHandler<P, T>optional

  • onSeekingAdaptChildReactEventHandler<P, T>optional

  • onSeekingCaptureAdaptChildReactEventHandler<P, T>optional

  • onSelectAdaptChildReactEventHandler<P, T>optional

  • onSelectCaptureAdaptChildReactEventHandler<P, T>optional

  • onStalledAdaptChildReactEventHandler<P, T>optional

  • onStalledCaptureAdaptChildReactEventHandler<P, T>optional

  • onSubmitAdaptChildFormEventHandler<P, T>optional

  • onSubmitCaptureAdaptChildFormEventHandler<P, T>optional

  • onSuspendAdaptChildReactEventHandler<P, T>optional

  • onSuspendCaptureAdaptChildReactEventHandler<P, T>optional

  • onTimeUpdateAdaptChildReactEventHandler<P, T>optional

  • onTimeUpdateCaptureAdaptChildReactEventHandler<P, T>optional

  • onTouchCancelAdaptChildTouchEventHandler<P, T>optional

  • onTouchCancelCaptureAdaptChildTouchEventHandler<P, T>optional

  • onTouchEndAdaptChildTouchEventHandler<P, T>optional

  • onTouchEndCaptureAdaptChildTouchEventHandler<P, T>optional

  • onTouchMoveAdaptChildTouchEventHandler<P, T>optional

  • onTouchMoveCaptureAdaptChildTouchEventHandler<P, T>optional

  • onTouchStartAdaptChildTouchEventHandler<P, T>optional

  • onTouchStartCaptureAdaptChildTouchEventHandler<P, T>optional

  • onTransitionEndAdaptChildTransitionEventHandler<P, T>optional

  • onTransitionEndCaptureAdaptChildTransitionEventHandler<P, T>optional

  • onVolumeChangeAdaptChildReactEventHandler<P, T>optional

  • onVolumeChangeCaptureAdaptChildReactEventHandler<P, T>optional

  • onWaitingAdaptChildReactEventHandler<P, T>optional

  • onWaitingCaptureAdaptChildReactEventHandler<P, T>optional

  • onWheelAdaptChildWheelEventHandler<P, T>optional

  • onWheelCaptureAdaptChildWheelEventHandler<P, T>optional