import * as React from 'react'; import PropTypes from 'prop-types'; import { useCartesianContext } from '../context/CartesianProvider'; import { MarkElement, MarkElementProps } from './MarkElement'; import { getValueToPositionMapper } from '../hooks/useScale'; import { useChartId } from '../hooks/useChartId'; import { DEFAULT_X_AXIS_KEY } from '../constants'; import { LineItemIdentifier } from '../models/seriesType/line'; import { cleanId } from '../internals/utils'; import getColor from './getColor'; import { useLineSeries } from '../hooks/useSeries'; export interface MarkPlotSlots { mark?: React.JSXElementConstructor; } export interface MarkPlotSlotProps { mark?: Partial; } export interface MarkPlotProps extends React.SVGAttributes, Pick { /** * Overridable component slots. * @default {} */ slots?: MarkPlotSlots; /** * The props used for each component slot. * @default {} */ slotProps?: MarkPlotSlotProps; /** * Callback fired when a line mark item is clicked. * @param {React.MouseEvent} event The event source of the callback. * @param {LineItemIdentifier} lineItemIdentifier The line mark item identifier. */ onItemClick?: ( event: React.MouseEvent, lineItemIdentifier: LineItemIdentifier, ) => void; } /** * Demos: * * - [Lines](https://mui.com/x/react-charts/lines/) * - [Line demonstration](https://mui.com/x/react-charts/line-demo/) * * API: * * - [MarkPlot API](https://mui.com/x/api/charts/mark-plot/) */ function MarkPlot(props: MarkPlotProps) { const { slots, slotProps, skipAnimation, onItemClick, ...other } = props; const seriesData = useLineSeries(); const axisData = useCartesianContext(); const chartId = useChartId(); const Mark = slots?.mark ?? MarkElement; if (seriesData === undefined) { return null; } const { series, stackingGroups } = seriesData; const { xAxis, yAxis, xAxisIds, yAxisIds } = axisData; const defaultXAxisId = xAxisIds[0]; const defaultYAxisId = yAxisIds[0]; return ( {stackingGroups.flatMap(({ ids: groupIds }) => { return groupIds.map((seriesId) => { const { xAxisKey = defaultXAxisId, yAxisKey = defaultYAxisId, stackedData, data, showMark = true, } = series[seriesId]; if (showMark === false) { return null; } const xScale = getValueToPositionMapper(xAxis[xAxisKey].scale); const yScale = yAxis[yAxisKey].scale; const xData = xAxis[xAxisKey].data; const xRange = xAxis[xAxisKey].scale.range(); const yRange = yScale.range(); const isInRange = ({ x, y }: { x: number; y: number }) => { if (x < Math.min(...xRange) || x > Math.max(...xRange)) { return false; } if (y < Math.min(...yRange) || y > Math.max(...yRange)) { return false; } return true; }; if (xData === undefined) { throw new Error( `MUI X Charts: ${ xAxisKey === DEFAULT_X_AXIS_KEY ? 'The first `xAxis`' : `The x-axis with id "${xAxisKey}"` } should have data property to be able to display a line plot.`, ); } const clipId = cleanId(`${chartId}-${seriesId}-line-clip`); // We assume that if displaying line mark, the line will also be rendered const colorGetter = getColor(series[seriesId], xAxis[xAxisKey], yAxis[yAxisKey]); return ( {xData ?.map((x, index) => { const value = data[index] == null ? null : stackedData[index][1]; return { x: xScale(x), y: value === null ? null : yScale(value)!, position: x, value, index, }; }) .filter(({ x, y, index, position, value }) => { if (value === null || y === null) { // Remove missing data point return false; } if (!isInRange({ x, y })) { // Remove out of range return false; } if (showMark === true) { return true; } return showMark({ x, y, index, position, value, }); }) .map(({ x, y, index }) => { return ( onItemClick(event, { type: 'line', seriesId, dataIndex: index })) } {...slotProps?.mark} /> ); })} ); }); })} ); } MarkPlot.propTypes = { // ----------------------------- Warning -------------------------------- // | These PropTypes are generated from the TypeScript type definitions | // | To update them edit the TypeScript types and run "pnpm proptypes" | // ---------------------------------------------------------------------- /** * Callback fired when a line mark item is clicked. * @param {React.MouseEvent} event The event source of the callback. * @param {LineItemIdentifier} lineItemIdentifier The line mark item identifier. */ onItemClick: PropTypes.func, /** * If `true`, animations are skipped. * @default false */ skipAnimation: PropTypes.bool, /** * The props used for each component slot. * @default {} */ slotProps: PropTypes.object, /** * Overridable component slots. * @default {} */ slots: PropTypes.object, } as any; export { MarkPlot };