recharts
Version:
React charts
334 lines (328 loc) • 15.6 kB
JavaScript
var _excluded = ["x", "y"];
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
import { useEffect } from 'react';
import { useAppDispatch, useAppSelector } from '../state/hooks';
import { selectEventEmitter, selectSyncId, selectSyncMethod } from '../state/selectors/rootPropsSelectors';
import { BRUSH_SYNC_EVENT, eventCenter, TOOLTIP_SYNC_EVENT } from '../util/Events';
import { createEventEmitter } from '../state/optionsSlice';
import { setSyncInteraction } from '../state/tooltipSlice';
import { selectTooltipDataKey } from '../state/selectors/selectors';
import { selectActiveTooltipGraphicalItemId, selectTooltipAxisTicks } from '../state/selectors/tooltipSelectors';
import { selectSynchronisedTooltipState } from './syncSelectors';
import { useChartLayout, useViewBox } from '../context/chartLayoutContext';
import { setDataStartEndIndexes } from '../state/chartDataSlice';
import { noop } from '../util/DataUtils';
/**
* Listens for tooltip sync events from other charts and dispatches the appropriate
* sync interaction state based on the current chart's syncMethod.
*
* Handles three sync methods:
* - 'index': passes through the tooltip index with coordinate scaling between chart viewBoxes
* - 'value': matches the incoming label against this chart's axis ticks by string comparison
* - function: delegates tick resolution to a user-provided callback
*
* When a synced label has no matching tick (e.g. sparse chart), the tooltip is hidden
* but sourceViewBox is preserved to prevent counter-emission cascades.
*/
function useTooltipSyncEventsListener() {
var mySyncId = useAppSelector(selectSyncId);
var myEventEmitter = useAppSelector(selectEventEmitter);
var dispatch = useAppDispatch();
var syncMethod = useAppSelector(selectSyncMethod);
var tooltipTicks = useAppSelector(selectTooltipAxisTicks);
var layout = useChartLayout();
var viewBox = useViewBox();
var className = useAppSelector(state => state.rootProps.className);
useEffect(() => {
if (mySyncId == null) {
// This chart is not synchronised with any other chart so we don't need to listen for any events.
return noop;
}
var listener = (incomingSyncId, action, emitter) => {
if (myEventEmitter === emitter) {
// We don't want to dispatch actions that we sent ourselves.
return;
}
if (mySyncId !== incomingSyncId) {
// This event is not for this chart
return;
}
/*
* Handle source chart deactivation (mouseLeave) for ALL sync methods.
* This must be checked before any syncMethod-specific logic to ensure
* sourceViewBox is cleared, which allows isReceivingSynchronisation
* to become false and lets the normal emission flow resume.
*/
if (action.payload.active === false) {
dispatch(setSyncInteraction({
active: false,
coordinate: undefined,
dataKey: undefined,
index: null,
label: undefined,
sourceViewBox: undefined,
graphicalItemId: undefined
}));
return;
}
if (syncMethod === 'index') {
var _action$payload;
if (viewBox && action !== null && action !== void 0 && (_action$payload = action.payload) !== null && _action$payload !== void 0 && _action$payload.coordinate && action.payload.sourceViewBox) {
var _action$payload$coord = action.payload.coordinate,
{
x: _x,
y: _y
} = _action$payload$coord,
otherCoordinateProps = _objectWithoutProperties(_action$payload$coord, _excluded);
var {
x: sourceX,
y: sourceY,
width: sourceWidth,
height: sourceHeight
} = action.payload.sourceViewBox;
var scaledCoordinate = _objectSpread(_objectSpread({}, otherCoordinateProps), {}, {
x: viewBox.x + (sourceWidth ? (_x - sourceX) / sourceWidth : 0) * viewBox.width,
y: viewBox.y + (sourceHeight ? (_y - sourceY) / sourceHeight : 0) * viewBox.height
});
dispatch(_objectSpread(_objectSpread({}, action), {}, {
payload: _objectSpread(_objectSpread({}, action.payload), {}, {
coordinate: scaledCoordinate
})
}));
} else {
dispatch(action);
}
return;
}
if (tooltipTicks == null) {
// for the other two sync methods, we need the ticks to be available
return;
}
var activeTick;
if (typeof syncMethod === 'function') {
/*
* This is what the data shape in 2.x CategoricalChartState used to look like.
* In 3.x we store things differently but let's try to keep the old shape for compatibility.
*/
var syncMethodParam = {
activeTooltipIndex: action.payload.index == null ? undefined : Number(action.payload.index),
isTooltipActive: action.payload.active,
activeIndex: action.payload.index == null ? undefined : Number(action.payload.index),
activeLabel: action.payload.label,
activeDataKey: action.payload.dataKey,
activeCoordinate: action.payload.coordinate
};
// Call a callback function. If there is an application specific algorithm
var activeTooltipIndex = syncMethod(tooltipTicks, syncMethodParam);
activeTick = tooltipTicks[activeTooltipIndex];
} else if (syncMethod === 'value') {
// labels are always strings, tick.value might be a string or a number, depending on axis type
activeTick = tooltipTicks.find(tick => String(tick.value) === action.payload.label);
}
var {
coordinate
} = action.payload;
if (coordinate == null || viewBox == null) {
dispatch(setSyncInteraction({
active: false,
coordinate: undefined,
dataKey: undefined,
index: null,
label: undefined,
sourceViewBox: undefined,
graphicalItemId: undefined
}));
return;
}
if (activeTick == null) {
/*
* The label from the source chart doesn't match any tick in this chart.
* This happens when synced charts have different data arrays
* (e.g., one chart has 3 data points while another has 252).
*
* We set active: false so the tooltip hides (correct — no data for this date),
* but we keep sourceViewBox set to signal that we're still receiving sync events.
* The emission guard in useTooltipChartSynchronisation checks sourceViewBox
* (not active) to decide whether to suppress outgoing sync events.
* Without this, the chart would emit a counter-sync event with active: false,
* cascading to clear tooltips on ALL other synced charts.
*/
dispatch(setSyncInteraction({
active: false,
coordinate: undefined,
dataKey: undefined,
index: null,
label: undefined,
sourceViewBox: action.payload.sourceViewBox,
graphicalItemId: undefined
}));
return;
}
var {
x,
y
} = coordinate;
var validateChartX = Math.min(x, viewBox.x + viewBox.width);
var validateChartY = Math.min(y, viewBox.y + viewBox.height);
var activeCoordinate = {
x: layout === 'horizontal' ? activeTick.coordinate : validateChartX,
y: layout === 'horizontal' ? validateChartY : activeTick.coordinate
};
var syncAction = setSyncInteraction({
active: action.payload.active,
coordinate: activeCoordinate,
dataKey: action.payload.dataKey,
index: String(activeTick.index),
label: action.payload.label,
sourceViewBox: action.payload.sourceViewBox,
graphicalItemId: action.payload.graphicalItemId
});
dispatch(syncAction);
};
eventCenter.on(TOOLTIP_SYNC_EVENT, listener);
return () => {
eventCenter.off(TOOLTIP_SYNC_EVENT, listener);
};
}, [className, dispatch, myEventEmitter, mySyncId, syncMethod, tooltipTicks, layout, viewBox]);
}
/**
* Listens for brush sync events from other charts and updates this chart's
* data start/end indexes to match, keeping brush positions synchronised.
*/
function useBrushSyncEventsListener() {
var mySyncId = useAppSelector(selectSyncId);
var myEventEmitter = useAppSelector(selectEventEmitter);
var dispatch = useAppDispatch();
useEffect(() => {
if (mySyncId == null) {
// This chart is not synchronised with any other chart so we don't need to listen for any events.
return noop;
}
var listener = (incomingSyncId, action, emitter) => {
if (myEventEmitter === emitter) {
// We don't want to dispatch actions that we sent ourselves.
return;
}
if (mySyncId === incomingSyncId) {
dispatch(setDataStartEndIndexes(action));
}
};
eventCenter.on(BRUSH_SYNC_EVENT, listener);
return () => {
eventCenter.off(BRUSH_SYNC_EVENT, listener);
};
}, [dispatch, myEventEmitter, mySyncId]);
}
/**
* Will receive synchronisation events from other charts.
*
* Reads syncMethod from state and decides how to synchronise the tooltip based on that.
*
* @returns void
*/
export function useSynchronisedEventsFromOtherCharts() {
var dispatch = useAppDispatch();
useEffect(() => {
dispatch(createEventEmitter());
}, [dispatch]);
useTooltipSyncEventsListener();
useBrushSyncEventsListener();
}
/**
* Will send events to other charts.
* If syncId is undefined, no events will be sent.
*
* This ignores the syncMethod, because that is set and computed on the receiving end.
*
* Outgoing emissions are suppressed when `isReceivingSynchronisation` is true,
* which is determined by the presence of `sourceViewBox` in the sync state (not by
* the tooltip's `active` flag). This matters for charts with sparse data: when an
* incoming sync label has no matching tick, the tooltip becomes inactive but
* `sourceViewBox` remains set, so the chart is still considered "receiving" and
* will not emit a counter-sync event that would cascade-clear other charts' tooltips.
*
* @param tooltipEventType from Tooltip
* @param trigger from Tooltip
* @param activeCoordinate from state
* @param activeLabel from state
* @param activeIndex from state
* @param isTooltipActive from state
* @returns void
*/
export function useTooltipChartSynchronisation(tooltipEventType, trigger, activeCoordinate, activeLabel, activeIndex, isTooltipActive) {
var activeDataKey = useAppSelector(state => selectTooltipDataKey(state, tooltipEventType, trigger));
var activeGraphicalItemId = useAppSelector(selectActiveTooltipGraphicalItemId);
var eventEmitterSymbol = useAppSelector(selectEventEmitter);
var syncId = useAppSelector(selectSyncId);
var syncMethod = useAppSelector(selectSyncMethod);
var tooltipState = useAppSelector(selectSynchronisedTooltipState);
/*
* Use sourceViewBox (not active) to determine if we're receiving sync events.
* sourceViewBox is set whenever another chart sends a sync event to us — even when
* our own tooltip is inactive (because the label didn't match our data).
* This prevents charts with sparse data from emitting counter-sync events
* that would clear tooltips on all other synced charts.
*/
var isReceivingSynchronisation = (tooltipState === null || tooltipState === void 0 ? void 0 : tooltipState.sourceViewBox) != null;
var viewBox = useViewBox();
useEffect(() => {
if (isReceivingSynchronisation) {
/*
* This chart is currently receiving synchronisation events from another chart.
* Let's not send any outgoing synchronisation events while that's happening
* to avoid infinite loops and cascading tooltip clears.
*/
return;
}
if (syncId == null) {
/*
* syncId is not set, means that this chart is not synchronised with any other chart,
* means we don't need to send synchronisation events
*/
return;
}
if (eventEmitterSymbol == null) {
/*
* When using Recharts internal hooks and selectors outside charts context,
* these properties will be undefined. Let's return silently instead of throwing an error.
*/
return;
}
var syncAction = setSyncInteraction({
active: isTooltipActive,
coordinate: activeCoordinate,
dataKey: activeDataKey,
index: activeIndex,
label: typeof activeLabel === 'number' ? String(activeLabel) : activeLabel,
sourceViewBox: viewBox,
graphicalItemId: activeGraphicalItemId
});
eventCenter.emit(TOOLTIP_SYNC_EVENT, syncId, syncAction, eventEmitterSymbol);
}, [isReceivingSynchronisation, activeCoordinate, activeDataKey, activeGraphicalItemId, activeIndex, activeLabel, eventEmitterSymbol, syncId, syncMethod, isTooltipActive, viewBox]);
}
/**
* Emits brush sync events to other charts when the brush start/end indexes change.
* If syncId is undefined, no events will be sent.
*/
export function useBrushChartSynchronisation() {
var syncId = useAppSelector(selectSyncId);
var eventEmitterSymbol = useAppSelector(selectEventEmitter);
var brushStartIndex = useAppSelector(state => state.chartData.dataStartIndex);
var brushEndIndex = useAppSelector(state => state.chartData.dataEndIndex);
useEffect(() => {
if (syncId == null || brushStartIndex == null || brushEndIndex == null || eventEmitterSymbol == null) {
return;
}
var syncAction = {
startIndex: brushStartIndex,
endIndex: brushEndIndex
};
eventCenter.emit(BRUSH_SYNC_EVENT, syncId, syncAction, eventEmitterSymbol);
}, [brushEndIndex, brushStartIndex, eventEmitterSymbol, syncId]);
}