@mui/x-charts 6.0.0-alpha.8 → 6.0.0-alpha.9

package/legacy/SparkLineChart/SparkLineChart.js

@@ -1,21 +1,14 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
 import * as React from 'react';
 import PropTypes from 'prop-types';
-import { styled } from '@mui/material/styles';
 import { BarPlot } from '../BarChart';
-import { LinePlot, MarkPlot, AreaPlot, markElementClasses } from '../LineChart';
+import { LinePlot, AreaPlot, LineHighlightPlot } from '../LineChart';
 import { ResponsiveChartContainer } from '../ResponsiveChartContainer';
 import { DEFAULT_X_AXIS_KEY } from '../constants';
 import { ChartsTooltip } from '../ChartsTooltip';
 import { ChartsAxisHighlight } from '../ChartsAxisHighlight';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
-var SparkLineMarkPlot = styled(MarkPlot)(_defineProperty({}, "& .".concat(markElementClasses.root), _defineProperty({
-  display: 'none'
-}, "&.".concat(markElementClasses.highlighted), {
-  display: 'inherit'
-})));
 var SPARKLINE_DEFAULT_MARGIN = {
   top: 5,
   bottom: 5,
@@ -61,7 +54,8 @@ var SparkLineChart = /*#__PURE__*/React.forwardRef(function SparkLineChart(props
       valueFormatter: valueFormatter
     }, plotType === 'bar' ? {} : {
       area: area,
-      curve: curve
+      curve: curve,
+      disableHighlight: !showHighlight
     })],
     width: width,
     height: height,
@@ -89,7 +83,10 @@ var SparkLineChart = /*#__PURE__*/React.forwardRef(function SparkLineChart(props
       }), /*#__PURE__*/_jsx(LinePlot, {
         slots: slots,
         slotProps: slotProps
-      }), showHighlight && /*#__PURE__*/_jsx(SparkLineMarkPlot, {})]
+      }), /*#__PURE__*/_jsx(LineHighlightPlot, {
+        slots: slots,
+        slotProps: slotProps
+      })]
     }), /*#__PURE__*/_jsx(ChartsAxisHighlight, _extends({}, axisHighlight)), showTooltip && /*#__PURE__*/_jsx(ChartsTooltip, _extends({}, tooltip)), children]
   });
 });

package/legacy/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-charts v6.0.0-alpha.8
+ * @mui/x-charts v6.0.0-alpha.9
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the

package/models/seriesType/line.d.ts

@@ -1,6 +1,28 @@
 import { DefaultizedProps } from '../helpers';
 import { CartesianSeriesType, CommonDefaultizedProps, CommonSeriesType, StackableSeriesType } from './common';
 export type CurveType = 'catmullRom' | 'linear' | 'monotoneX' | 'monotoneY' | 'natural' | 'step' | 'stepBefore' | 'stepAfter';
+export interface ShowMarkParams {
+    /**
+     * The item index.
+     */
+    index: number;
+    /**
+     * The x coordinate in the SVG.
+     */
+    x: number;
+    /**
+     * The y coordinate in the SVG.
+     */
+    y: number;
+    /**
+     * The item position value. It likely comes from the axis `data` property.
+     */
+    position: number | Date;
+    /**
+     * The item value. It comes from the series `data` property.
+     */
+    value: number;
+}
 export interface LineSeriesType extends CommonSeriesType<number>, CartesianSeriesType, StackableSeriesType {
     type: 'line';
     /**
@@ -15,6 +37,17 @@ export interface LineSeriesType extends CommonSeriesType<number>, CartesianSerie
     area?: boolean;
     label?: string;
     curve?: CurveType;
+    /**
+     * Define which items of the series should display a mark.
+     * If can be a boolean that applies to all items.
+     * Or a callback that gets some item properties and returns true if the item should be displayed.
+     */
+    showMark?: boolean | ((params: ShowMarkParams) => boolean);
+    /**
+     * Do not render the line highlight item if set to `true`.
+     * @default false
+     */
+    disableHighlight?: boolean;
 }
 /**
  * An object that allows to identify a single line.

package/modern/LineChart/LineChart.js

@@ -12,6 +12,7 @@ import { ChartsTooltip } from '../ChartsTooltip';
 import { ChartsLegend } from '../ChartsLegend';
 import { ChartsAxisHighlight } from '../ChartsAxisHighlight';
 import { ChartsClipPath } from '../ChartsClipPath';
+import { LineHighlightPlot } from './LineHighlightPlot';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
 const LineChart = /*#__PURE__*/React.forwardRef(function LineChart(props, ref) {
@@ -29,6 +30,7 @@ const LineChart = /*#__PURE__*/React.forwardRef(function LineChart(props, ref) {
     axisHighlight = {
       x: 'line'
     },
+    disableLineItemHighlight,
     legend,
     topAxis,
     leftAxis,
@@ -43,6 +45,7 @@ const LineChart = /*#__PURE__*/React.forwardRef(function LineChart(props, ref) {
   return /*#__PURE__*/_jsxs(ResponsiveChartContainer, {
     ref: ref,
     series: series.map(s => _extends({
+      disableHighlight: !!disableLineItemHighlight,
       type: 'line'
     }, s)),
     width: width,
@@ -76,13 +79,16 @@ const LineChart = /*#__PURE__*/React.forwardRef(function LineChart(props, ref) {
       bottomAxis: bottomAxis,
       slots: slots,
       slotProps: slotProps
-    }), /*#__PURE__*/_jsx(MarkPlot, {
+    }), /*#__PURE__*/_jsx(ChartsAxisHighlight, _extends({}, axisHighlight)), /*#__PURE__*/_jsx(MarkPlot, {
+      slots: slots,
+      slotProps: slotProps
+    }), /*#__PURE__*/_jsx(LineHighlightPlot, {
       slots: slots,
       slotProps: slotProps
     }), /*#__PURE__*/_jsx(ChartsLegend, _extends({}, legend, {
       slots: slots,
       slotProps: slotProps
-    })), /*#__PURE__*/_jsx(ChartsAxisHighlight, _extends({}, axisHighlight)), /*#__PURE__*/_jsx(ChartsTooltip, _extends({}, tooltip)), /*#__PURE__*/_jsx(ChartsClipPath, {
+    })), /*#__PURE__*/_jsx(ChartsTooltip, _extends({}, tooltip)), /*#__PURE__*/_jsx(ChartsClipPath, {
       id: clipPathId
     }), children]
   });
@@ -128,6 +134,10 @@ process.env.NODE_ENV !== "production" ? LineChart.propTypes = {
   dataset: PropTypes.arrayOf(PropTypes.object),
   desc: PropTypes.string,
   disableAxisListener: PropTypes.bool,
+  /**
+   * If `true`, render the line highlight item.
+   */
+  disableLineItemHighlight: PropTypes.bool,
   height: PropTypes.number,
   /**
    * Indicate which axis to display the left of the charts.
@@ -205,12 +215,14 @@ process.env.NODE_ENV !== "production" ? LineChart.propTypes = {
     curve: PropTypes.oneOf(['catmullRom', 'linear', 'monotoneX', 'monotoneY', 'natural', 'step', 'stepAfter', 'stepBefore']),
     data: PropTypes.arrayOf(PropTypes.number),
     dataKey: PropTypes.string,
+    disableHighlight: PropTypes.bool,
     highlightScope: PropTypes.shape({
       faded: PropTypes.oneOf(['global', 'none', 'series']),
       highlighted: PropTypes.oneOf(['item', 'none', 'series'])
     }),
     id: PropTypes.string,
     label: PropTypes.string,
+    showMark: PropTypes.oneOfType([PropTypes.func, PropTypes.bool]),
     stack: PropTypes.string,
     stackOffset: PropTypes.oneOf(['diverging', 'expand', 'none', 'silhouette', 'wiggle']),
     stackOrder: PropTypes.oneOf(['appearance', 'ascending', 'descending', 'insideOut', 'none', 'reverse']),

package/modern/LineChart/LineHighlightElement.js

@@ -0,0 +1,68 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["x", "y", "id", "classes", "color"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import composeClasses from '@mui/utils/composeClasses';
+import generateUtilityClass from '@mui/utils/generateUtilityClass';
+import { styled } from '@mui/material/styles';
+import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
+import { jsx as _jsx } from "react/jsx-runtime";
+export function getHighlightElementUtilityClass(slot) {
+  return generateUtilityClass('MuiHighlightElement', slot);
+}
+export const lineHighlightElementClasses = generateUtilityClasses('MuiHighlightElement', ['root']);
+const useUtilityClasses = ownerState => {
+  const {
+    classes,
+    id
+  } = ownerState;
+  const slots = {
+    root: ['root', `series-${id}`]
+  };
+  return composeClasses(slots, getHighlightElementUtilityClass, classes);
+};
+const HighlightElement = styled('circle', {
+  name: 'MuiHighlightElement',
+  slot: 'Root',
+  overridesResolver: (_, styles) => styles.root
+})(({
+  ownerState
+}) => ({
+  transform: `translate(${ownerState.x}px, ${ownerState.y}px)`,
+  transformOrigin: `${ownerState.x}px ${ownerState.y}px`,
+  fill: ownerState.color
+}));
+function LineHighlightElement(props) {
+  const {
+      x,
+      y,
+      id,
+      classes: innerClasses,
+      color
+    } = props,
+    other = _objectWithoutPropertiesLoose(props, _excluded);
+  const ownerState = {
+    id,
+    classes: innerClasses,
+    color,
+    x,
+    y
+  };
+  const classes = useUtilityClasses(ownerState);
+  return /*#__PURE__*/_jsx(HighlightElement, _extends({}, other, {
+    ownerState: ownerState,
+    className: classes.root,
+    cx: 0,
+    cy: 0,
+    r: other.r === undefined ? 5 : other.r
+  }));
+}
+process.env.NODE_ENV !== "production" ? LineHighlightElement.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  classes: PropTypes.object
+} : void 0;
+export { LineHighlightElement };

package/modern/LineChart/LineHighlightPlot.js

@@ -0,0 +1,91 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["slots", "slotProps"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { SeriesContext } from '../context/SeriesContextProvider';
+import { CartesianContext } from '../context/CartesianContextProvider';
+import { LineHighlightElement } from './LineHighlightElement';
+import { getValueToPositionMapper } from '../hooks/useScale';
+import { InteractionContext } from '../context/InteractionProvider';
+import { jsx as _jsx } from "react/jsx-runtime";
+function LineHighlightPlot(props) {
+  const {
+      slots,
+      slotProps
+    } = props,
+    other = _objectWithoutPropertiesLoose(props, _excluded);
+  const seriesData = React.useContext(SeriesContext).line;
+  const axisData = React.useContext(CartesianContext);
+  const {
+    axis
+  } = React.useContext(InteractionContext);
+  const highlightedIndex = axis.x?.index;
+  if (highlightedIndex === undefined) {
+    return null;
+  }
+  if (seriesData === undefined) {
+    return null;
+  }
+  const {
+    series,
+    stackingGroups
+  } = seriesData;
+  const {
+    xAxis,
+    yAxis,
+    xAxisIds,
+    yAxisIds
+  } = axisData;
+  const defaultXAxisId = xAxisIds[0];
+  const defaultYAxisId = yAxisIds[0];
+  const Element = slots?.lineHighlight ?? LineHighlightElement;
+  return /*#__PURE__*/_jsx("g", _extends({}, other, {
+    children: stackingGroups.flatMap(({
+      ids: groupIds
+    }) => {
+      return groupIds.flatMap(seriesId => {
+        const {
+          xAxisKey = defaultXAxisId,
+          yAxisKey = defaultYAxisId,
+          stackedData,
+          disableHighlight
+        } = series[seriesId];
+        if (disableHighlight) {
+          return null;
+        }
+        const xScale = getValueToPositionMapper(xAxis[xAxisKey].scale);
+        const yScale = yAxis[yAxisKey].scale;
+        const xData = xAxis[xAxisKey].data;
+        if (xData === undefined) {
+          throw new Error(`Axis of id "${xAxisKey}" should have data property to be able to display a line plot.`);
+        }
+        const x = xScale(xData[highlightedIndex]);
+        const y = yScale(stackedData[highlightedIndex][1]);
+        return /*#__PURE__*/_jsx(Element, _extends({
+          id: seriesId,
+          color: series[seriesId].color,
+          x: x,
+          y: y
+        }, slotProps?.lineHighlight), `${seriesId}`);
+      });
+    })
+  }));
+}
+process.env.NODE_ENV !== "production" ? LineHighlightPlot.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps: PropTypes.object,
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots: PropTypes.object
+} : void 0;
+export { LineHighlightPlot };

package/modern/LineChart/MarkElement.js

@@ -40,10 +40,7 @@ const MarkElementPath = styled('path', {
   transformOrigin: `${ownerState.x}px ${ownerState.y}px`,
   fill: theme.palette.background.paper,
   stroke: ownerState.color,
-  strokeWidth: 2,
-  '&.MuiMarkElement-highlighted': {
-    fill: ownerState.color
-  }
+  strokeWidth: 2
 }));
 MarkElementPath.propTypes = {
   // ----------------------------- Warning --------------------------------

package/modern/LineChart/MarkPlot.js

@@ -40,8 +40,12 @@ function MarkPlot(props) {
         const {
           xAxisKey = defaultXAxisId,
           yAxisKey = defaultYAxisId,
-          stackedData
+          stackedData,
+          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;
@@ -67,21 +71,33 @@ function MarkPlot(props) {
           return {
             x: xScale(x),
             y: yScale(y),
+            position: x,
+            value: y,
             index
           };
         }).filter(isInRange).map(({
           x,
           y,
-          index
-        }) => /*#__PURE__*/_jsx(Mark, _extends({
-          id: seriesId,
-          dataIndex: index,
-          shape: "circle",
-          color: series[seriesId].color,
-          x: x,
-          y: y,
-          highlightScope: series[seriesId].highlightScope
-        }, slotProps?.mark), `${seriesId}-${index}`));
+          index,
+          position,
+          value
+        }) => {
+          return showMark === true || showMark({
+            x,
+            y,
+            index,
+            position,
+            value
+          }) ? /*#__PURE__*/_jsx(Mark, _extends({
+            id: seriesId,
+            dataIndex: index,
+            shape: "circle",
+            color: series[seriesId].color,
+            x: x,
+            y: y,
+            highlightScope: series[seriesId].highlightScope
+          }, slotProps?.mark), `${seriesId}-${index}`) : null;
+        });
       });
     })
   }));

package/modern/LineChart/index.js

@@ -1,7 +1,9 @@
 export { LinePlot } from './LinePlot';
 export { AreaPlot } from './AreaPlot';
 export { MarkPlot } from './MarkPlot';
+export { LineHighlightPlot } from './LineHighlightPlot';
 export { LineChart } from './LineChart';
 export * from './AreaElement';
 export * from './LineElement';
-export * from './MarkElement';
+export * from './MarkElement';
+export * from './LineHighlightElement';

package/modern/SparkLineChart/SparkLineChart.js

@@ -1,23 +1,14 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import * as React from 'react';
 import PropTypes from 'prop-types';
-import { styled } from '@mui/material/styles';
 import { BarPlot } from '../BarChart';
-import { LinePlot, MarkPlot, AreaPlot, markElementClasses } from '../LineChart';
+import { LinePlot, AreaPlot, LineHighlightPlot } from '../LineChart';
 import { ResponsiveChartContainer } from '../ResponsiveChartContainer';
 import { DEFAULT_X_AXIS_KEY } from '../constants';
 import { ChartsTooltip } from '../ChartsTooltip';
 import { ChartsAxisHighlight } from '../ChartsAxisHighlight';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
-const SparkLineMarkPlot = styled(MarkPlot)({
-  [`& .${markElementClasses.root}`]: {
-    display: 'none',
-    [`&.${markElementClasses.highlighted}`]: {
-      display: 'inherit'
-    }
-  }
-});
 const SPARKLINE_DEFAULT_MARGIN = {
   top: 5,
   bottom: 5,
@@ -59,7 +50,8 @@ const SparkLineChart = /*#__PURE__*/React.forwardRef(function SparkLineChart(pro
       valueFormatter
     }, plotType === 'bar' ? {} : {
       area,
-      curve
+      curve,
+      disableHighlight: !showHighlight
     })],
     width: width,
     height: height,
@@ -85,7 +77,10 @@ const SparkLineChart = /*#__PURE__*/React.forwardRef(function SparkLineChart(pro
       }), /*#__PURE__*/_jsx(LinePlot, {
         slots: slots,
         slotProps: slotProps
-      }), showHighlight && /*#__PURE__*/_jsx(SparkLineMarkPlot, {})]
+      }), /*#__PURE__*/_jsx(LineHighlightPlot, {
+        slots: slots,
+        slotProps: slotProps
+      })]
     }), /*#__PURE__*/_jsx(ChartsAxisHighlight, _extends({}, axisHighlight)), showTooltip && /*#__PURE__*/_jsx(ChartsTooltip, _extends({}, tooltip)), children]
   });
 });

package/modern/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-charts v6.0.0-alpha.8
+ * @mui/x-charts v6.0.0-alpha.9
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts",
-  "version": "6.0.0-alpha.8",
+  "version": "6.0.0-alpha.9",
   "description": "The community edition of the charts components (MUI X).",
   "author": "MUI Team",
   "main": "./index.js",