API

Charts

General Components

Cartesian Components

Polar Components

Shapes

ScatterChart

Related Links

Parent Components

ScatterChart consumes context provided by these components:

Props

  • accessibilityLayerbooleanoptional

    Turn on accessibility support for keyboard-only and screen reader users.

    DEFAULT: true

  • barCategoryGapnumber | stringoptional

    The gap between two bar categories, which can be a percent value or a fixed value.

    DEFAULT: "10%"

    Examples:

  • barGapnumber | stringoptional

    The gap between two bars in the same category.

    DEFAULT: 4

    Examples:

  • barSizenumber | stringoptional

    The width or height of each bar. If the barSize is not specified, the size of the bar will be calculated by the barCategoryGap, barGap and the quantity of bar groups.

  • baseValue"dataMax" | "dataMin" | numberoptional

    The base value of area.

  • childrenReactNodeoptional

    Examples:

  • classNamestringoptional

  • compactbooleanoptional

  • dataReadonlyArray<DataPointType>optional

    The source data. Each element should be an object. The properties of each object represent the values of different data dimensions.

    Use the dataKey prop to specify which properties to use.

    FORMAT: 

    data={[{ name: 'a', value: 12 }]}
data={[{ label: 'foo', measurements: [5, 12] }]}

  • dataKeyFunction | number | stringoptional

  • descstringoptional

  • height`${number}%` | numberoptional

    The height of chart container. Can be a number or a percent string like "100%".

    Examples:

  • idstringoptional

  • layout"horizontal" | "vertical"optional

    The layout of chart defines the orientation of axes, graphical items, and tooltip.

    DEFAULT: "horizontal"

  • marginPartial<Margin>optional

    Empty space around the container.

    DEFAULT: {"top":5,"right":5,"bottom":5,"left":5}

    Examples:

  • maxBarSizenumberoptional

    The maximum width of all the bars in a horizontal BarChart, or maximum height in a vertical BarChart.

  • refFunction | React.RefObject<SVGSVGElement> | nulloptional

  • responsivebooleanoptional

    If true, then it will listen to container size changes and adapt the SVG chart accordingly. If false, then it renders the chart at the specified width and height and will stay that way even if the container size changes.

    This is similar to ResponsiveContainer but without the need for an extra wrapper component. The responsive prop also uses standard CSS sizing rules, instead of custom resolution logic (like ResponsiveContainer does).

    DEFAULT: false

    Examples:

  • reverseStackOrderbooleanoptional

    If false, stacked items will be rendered left to right. If true, stacked items will be rendered right to left.

    Render direction affects SVG layering, not x position.

    DEFAULT: false

  • rolestringoptional

    The ARIA role for the chart, which provides semantic information for screen reader users.

  • stackOffset"expand" | "none" | "positive" | "sign" | "silhouette" | "wiggle"optional

    The type of offset function used to generate the lower and upper values in the series array. The types are built-in offsets in d3-shape. Only applicable for stacked Area or Bar charts. Has no effect when the stackId prop is not set on Area or Bar components.

    DEFAULT: "none"

    Examples:

  • styleReact.CSSPropertiesoptional

    Examples:

  • syncIdnumber | stringoptional

    Charts with the same syncId will synchronize Tooltip and Brush events.

    Examples:

  • syncMethod"index" | "value" | Functionoptional

    Customize how the charts will synchronize tooltips and brushes.index: synchronize using the data index in the data array. Index expects that all data has the same length.value: synchronize using the data value on categorical axis (categorical: XAxis in horizontal layout, YAxis in vertical layout). function: a custom sync method which receives tick and data as argument and returns an index.

    DEFAULT: "index"

  • tabIndexnumberoptional

    If and where the chart should appear in the tab order

  • throttleDelay"raf" | numberoptional

    Decides the time interval to throttle events. Only events defined in throttledEvents prop are throttled. All other events are executed immediately/synchronously.

    Options:

    • number: the time interval in milliseconds
    • 'raf': use requestAnimationFrame to schedule updates.

    DEFAULT: "raf"

  • throttledEvents"all" | Array<keyof GlobalEventHandlersEventMap>optional

    Defines which events should be throttled. Events not in this list will not be throttled.

    Use the special value 'all' to throttle all events. Empty array means no events are throttled.

    Use the prop throttleDelay to define the throttling interval.

    If an event is on this list, then you lose the opportunity to access the event synchronously. Which means that if you want to call e.preventDefault() or e.stopPropagation() inside the event handler, then that event handler must not be in this list.

    DEFAULT: ["mousemove","touchmove","pointermove","scroll","wheel"]

  • titlestringoptional

  • width`${number}%` | numberoptional

    The width of chart container. Can be a number or a percent string like "100%".

    Examples:

  • onClickCategoricalChartFunc<React.MouseEvent<SVGGraphicsElement, MouseEvent>>optional

    The customized event handler of click in this chart.

  • onContextMenuCategoricalChartFunc<React.MouseEvent<SVGGraphicsElement, MouseEvent>>optional

    The customized event handler of contextmenu in this chart.

  • onDoubleClickCategoricalChartFunc<React.MouseEvent<SVGGraphicsElement, MouseEvent>>optional

    The customized event handler of dblclick in this chart.

  • onMouseDownCategoricalChartFunc<React.MouseEvent<SVGGraphicsElement, MouseEvent>>optional

    The customized event handler of mousedown in this chart.

  • onMouseEnterCategoricalChartFunc<React.MouseEvent<SVGGraphicsElement, MouseEvent>>optional

    The customized event handler of mouseenter in this chart.

  • onMouseLeaveCategoricalChartFunc<React.MouseEvent<SVGGraphicsElement, MouseEvent>>optional

    The customized event handler of mouseleave in this chart.

  • onMouseMoveCategoricalChartFunc<React.MouseEvent<SVGGraphicsElement, MouseEvent>>optional

    The customized event handler of mousemove in this chart.

  • onMouseUpCategoricalChartFunc<React.MouseEvent<SVGGraphicsElement, MouseEvent>>optional

    The customized event handler of mouseup in this chart.

  • onTouchEndCategoricalChartFunc<React.TouchEvent<SVGGraphicsElement>>optional

    The customized event handler of touchend in this chart.

  • onTouchMoveCategoricalChartFunc<React.TouchEvent<SVGGraphicsElement>>optional

    The customized event handler of touchmove in this chart.

  • onTouchStartCategoricalChartFunc<React.TouchEvent<SVGGraphicsElement>>optional

    The customized event handler of touchstart in this chart.