File size: 4,318 Bytes
1e92f2d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 | 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<SVGElement>;
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<any>;
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 (
<CursorInternal
{...props}
coordinate={props.coordinate}
index={props.index}
payload={props.payload}
offset={offset}
layout={layout}
tooltipAxisBandSize={tooltipAxisBandSize}
chartName={chartName}
/>
);
}
|