import * as React from 'react'; import { ReactElement, cloneElement, createElement, isValidElement, SVGProps } from 'react'; import { clsx } from 'clsx'; import { ChartCoordinate, ChartOffsetInternal, LayoutType, TooltipEventType } from '../util/types'; import { Curve } from '../shape/Curve'; import { Cross } from '../shape/Cross'; import { getCursorRectangle } from '../util/cursor/getCursorRectangle'; import { Rectangle } from '../shape/Rectangle'; import { getRadialCursorPoints } from '../util/cursor/getRadialCursorPoints'; import { Sector } from '../shape/Sector'; import { getCursorPoints } from '../util/cursor/getCursorPoints'; import { filterProps } from '../util/ReactUtils'; import { useChartLayout, useOffsetInternal } from '../context/chartLayoutContext'; import { useTooltipAxisBandSize } from '../context/useTooltipAxis'; import { useChartName } from '../state/selectors/selectors'; import { TooltipPayload } from '../state/tooltipSlice'; /** * If set false, no cursor will be drawn when tooltip is active. * If set an object, the option is the configuration of cursor. * If set a React element, the option is the custom react element of drawing cursor */ export type CursorDefinition = boolean | ReactElement | SVGProps; export type CursorProps = { cursor: CursorDefinition; tooltipEventType: TooltipEventType; coordinate: ChartCoordinate; payload: TooltipPayload; index: string; }; export type CursorConnectedProps = CursorProps & { tooltipAxisBandSize: number; layout: LayoutType; offset: ChartOffsetInternal; coordinate: ChartCoordinate; payload: TooltipPayload; index: string; chartName: string; }; export function CursorInternal(props: CursorConnectedProps) { const { coordinate, payload, index, offset, tooltipAxisBandSize, layout, cursor, tooltipEventType, chartName } = props; // The cursor is a part of the Tooltip, and it should be shown (by default) when the Tooltip is active. const activeCoordinate = coordinate; const activePayload = payload; const activeTooltipIndex = index; if (!cursor || !activeCoordinate || (chartName !== 'ScatterChart' && tooltipEventType !== 'axis')) { return null; } let restProps, cursorComp: React.ComponentType; if (chartName === 'ScatterChart') { restProps = activeCoordinate; cursorComp = Cross; } else if (chartName === 'BarChart') { restProps = getCursorRectangle(layout, activeCoordinate, offset, tooltipAxisBandSize); cursorComp = Rectangle; } else if (layout === 'radial') { // @ts-expect-error TODO the state is marked as containing Coordinate but actually in polar charts it contains PolarCoordinate, we should keep the polar state separate const { cx, cy, radius, startAngle, endAngle } = getRadialCursorPoints(activeCoordinate); restProps = { cx, cy, startAngle, endAngle, innerRadius: radius, outerRadius: radius, }; cursorComp = Sector; } else { restProps = { points: getCursorPoints(layout, activeCoordinate, offset) }; cursorComp = Curve; } const extraClassName: string | undefined = typeof cursor === 'object' && 'className' in cursor ? cursor.className : undefined; const cursorProps = { stroke: '#ccc', pointerEvents: 'none', ...offset, ...restProps, ...filterProps(cursor, false), payload: activePayload, payloadIndex: activeTooltipIndex, className: clsx('recharts-tooltip-cursor', extraClassName), }; return isValidElement(cursor) ? cloneElement(cursor, cursorProps) : createElement(cursorComp, cursorProps); } /* * Cursor is the background, or a highlight, * that shows when user mouses over or activates * an area. * * It usually shows together with a tooltip * to emphasise which part of the chart does the tooltip refer to. */ export function Cursor(props: CursorProps) { const tooltipAxisBandSize = useTooltipAxisBandSize(); const offset = useOffsetInternal(); const layout = useChartLayout(); const chartName = useChartName(); return ( ); }