@mui/x-charts 6.0.0-alpha.4 → 6.0.0-alpha.6

package/modern/ScatterChart/Scatter.js

@@ -16,62 +16,48 @@ function Scatter(props) {
   const {
     item
   } = React.useContext(InteractionContext);
-  const getXPosition = getValueToPositionMapper(xScale);
-  const getYPosition = getValueToPositionMapper(yScale);
   const getInteractionItemProps = useInteractionItemProps(series.highlightScope);
-  const xRange = xScale.range();
-  const yRange = yScale.range();
-  const isInRange = ({
-    x,
-    y
-  }) => {
-    if (x < Math.min(...xRange) || x > Math.max(...xRange)) {
-      return false;
-    }
-    if (y < Math.min(...yRange) || y > Math.max(...yRange)) {
-      return false;
-    }
-    return true;
-  };
-  return /*#__PURE__*/_jsx("g", {
-    children: series.data.map(({
-      x,
-      y,
-      id
-    }, index) => ({
-      x: getXPosition(x),
-      y: getYPosition(y),
-      id,
-      dataIndex: index
-    })).filter(isInRange).map(({
-      x,
-      y,
-      id,
-      dataIndex
-    }) => {
-      const isHighlighted = getIsHighlighted(item, {
-        type: 'scatter',
-        seriesId: series.id,
-        dataIndex
-      }, series.highlightScope);
-      const isFaded = !isHighlighted && getIsFaded(item, {
+  const cleanData = React.useMemo(() => {
+    const getXPosition = getValueToPositionMapper(xScale);
+    const getYPosition = getValueToPositionMapper(yScale);
+    const xRange = xScale.range();
+    const yRange = yScale.range();
+    const minXRange = Math.min(...xRange);
+    const maxXRange = Math.max(...xRange);
+    const minYRange = Math.min(...yRange);
+    const maxYRange = Math.max(...yRange);
+    const temp = [];
+    for (let i = 0; i < series.data.length; i += 1) {
+      const scatterPoint = series.data[i];
+      const x = getXPosition(scatterPoint.x);
+      const y = getYPosition(scatterPoint.y);
+      const isInRange = x >= minXRange && x <= maxXRange && y >= minYRange && y <= maxYRange;
+      const pointCtx = {
         type: 'scatter',
         seriesId: series.id,
-        dataIndex
-      }, series.highlightScope);
-      return /*#__PURE__*/_jsx("circle", _extends({
-        cx: 0,
-        cy: 0,
-        r: markerSize,
-        transform: `translate(${x}, ${y})`,
-        fill: color,
-        opacity: isFaded && 0.3 || 1
-      }, getInteractionItemProps({
-        type: 'scatter',
-        seriesId: series.id,
-        dataIndex
-      })), id);
-    })
+        dataIndex: i
+      };
+      if (isInRange) {
+        temp.push({
+          x,
+          y,
+          isFaded: !getIsHighlighted(item, pointCtx, series.highlightScope) && getIsFaded(item, pointCtx, series.highlightScope),
+          interactionProps: getInteractionItemProps(pointCtx),
+          id: scatterPoint.id
+        });
+      }
+    }
+    return temp;
+  }, [yScale, xScale, getInteractionItemProps, item, series.data, series.highlightScope, series.id]);
+  return /*#__PURE__*/_jsx("g", {
+    children: cleanData.map(dataPoint => /*#__PURE__*/_jsx("circle", _extends({
+      cx: 0,
+      cy: 0,
+      r: markerSize,
+      transform: `translate(${dataPoint.x}, ${dataPoint.y})`,
+      fill: color,
+      opacity: dataPoint.isFaded && 0.3 || 1
+    }, dataPoint.interactionProps), dataPoint.id))
   });
 }
 process.env.NODE_ENV !== "production" ? Scatter.propTypes = {

package/modern/ScatterChart/ScatterChart.js

@@ -64,7 +64,7 @@ process.env.NODE_ENV !== "production" ? ScatterChart.propTypes = {
   }),
   /**
    * Indicate which axis to display the bottom of the charts.
-   * Can be a string (the id of the axis) or an object `ChartsXAxisProps`
+   * Can be a string (the id of the axis) or an object `ChartsXAxisProps`.
    * @default xAxisIds[0] The id of the first provided axis
    */
   bottomAxis: PropTypes.oneOfType([PropTypes.shape({
@@ -86,12 +86,13 @@ process.env.NODE_ENV !== "production" ? ScatterChart.propTypes = {
    * Color palette used to colorize multiple series.
    */
   colors: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.func]),
+  dataset: PropTypes.arrayOf(PropTypes.object),
   desc: PropTypes.string,
   disableAxisListener: PropTypes.bool,
   height: PropTypes.number,
   /**
    * Indicate which axis to display the left of the charts.
-   * Can be a string (the id of the axis) or an object `ChartsYAxisProps`
+   * Can be a string (the id of the axis) or an object `ChartsYAxisProps`.
    * @default yAxisIds[0] The id of the first provided axis
    */
   leftAxis: PropTypes.oneOfType([PropTypes.shape({
@@ -131,7 +132,7 @@ process.env.NODE_ENV !== "production" ? ScatterChart.propTypes = {
   }),
   /**
    * Indicate which axis to display the right of the charts.
-   * Can be a string (the id of the axis) or an object `ChartsYAxisProps`
+   * Can be a string (the id of the axis) or an object `ChartsYAxisProps`.
    * @default null
    */
   rightAxis: PropTypes.oneOfType([PropTypes.shape({
@@ -176,7 +177,7 @@ process.env.NODE_ENV !== "production" ? ScatterChart.propTypes = {
   }),
   /**
    * Indicate which axis to display the top of the charts.
-   * Can be a string (the id of the axis) or an object `ChartsXAxisProps`
+   * Can be a string (the id of the axis) or an object `ChartsXAxisProps`.
    * @default null
    */
   topAxis: PropTypes.oneOfType([PropTypes.shape({
@@ -203,15 +204,17 @@ process.env.NODE_ENV !== "production" ? ScatterChart.propTypes = {
     axisId: PropTypes.string,
     classes: PropTypes.object,
     data: PropTypes.array,
+    dataKey: PropTypes.string,
     disableLine: PropTypes.bool,
     disableTicks: PropTypes.bool,
     fill: PropTypes.string,
+    hideTooltip: PropTypes.bool,
     id: PropTypes.string,
     label: PropTypes.string,
     labelFontSize: PropTypes.number,
-    max: PropTypes.number,
+    max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
     maxTicks: PropTypes.number,
-    min: PropTypes.number,
+    min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
     minTicks: PropTypes.number,
     position: PropTypes.oneOf(['bottom', 'left', 'right', 'top']),
     scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
@@ -225,15 +228,17 @@ process.env.NODE_ENV !== "production" ? ScatterChart.propTypes = {
     axisId: PropTypes.string,
     classes: PropTypes.object,
     data: PropTypes.array,
+    dataKey: PropTypes.string,
     disableLine: PropTypes.bool,
     disableTicks: PropTypes.bool,
     fill: PropTypes.string,
+    hideTooltip: PropTypes.bool,
     id: PropTypes.string,
     label: PropTypes.string,
     labelFontSize: PropTypes.number,
-    max: PropTypes.number,
+    max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
     maxTicks: PropTypes.number,
-    min: PropTypes.number,
+    min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
     minTicks: PropTypes.number,
     position: PropTypes.oneOf(['bottom', 'left', 'right', 'top']),
     scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),

package/modern/SparkLineChart/SparkLineChart.js

@@ -0,0 +1,187 @@
+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 { 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,
+  left: 5,
+  right: 5
+};
+const SparkLineChart = /*#__PURE__*/React.forwardRef(function SparkLineChart(props, ref) {
+  const {
+    xAxis,
+    width,
+    height,
+    margin = SPARKLINE_DEFAULT_MARGIN,
+    colors,
+    sx,
+    showTooltip,
+    tooltip,
+    showHighlight,
+    axisHighlight: inAxisHighlight,
+    children,
+    data,
+    plotType = 'line',
+    valueFormatter = v => v.toString(),
+    area,
+    curve = 'linear'
+  } = props;
+  const defaultXHighlight = showHighlight && plotType === 'bar' ? {
+    x: 'band'
+  } : {
+    x: 'none'
+  };
+  const axisHighlight = _extends({}, defaultXHighlight, inAxisHighlight);
+  return /*#__PURE__*/_jsxs(ResponsiveChartContainer, {
+    ref: ref,
+    series: [_extends({
+      type: plotType,
+      data,
+      valueFormatter
+    }, plotType === 'bar' ? {} : {
+      area,
+      curve
+    })],
+    width: width,
+    height: height,
+    margin: margin,
+    xAxis: [_extends({
+      id: DEFAULT_X_AXIS_KEY,
+      scaleType: plotType === 'bar' ? 'band' : 'linear',
+      data: Array.from({
+        length: data.length
+      }, (_, index) => index),
+      hideTooltip: xAxis === undefined
+    }, xAxis)],
+    colors: colors,
+    sx: sx,
+    disableAxisListener: (!showTooltip || tooltip?.trigger !== 'axis') && axisHighlight?.x === 'none' && axisHighlight?.y === 'none',
+    children: [plotType === 'bar' && /*#__PURE__*/_jsx(BarPlot, {}), plotType === 'line' && /*#__PURE__*/_jsxs(React.Fragment, {
+      children: [/*#__PURE__*/_jsx(AreaPlot, {}), /*#__PURE__*/_jsx(LinePlot, {}), showHighlight && /*#__PURE__*/_jsx(SparkLineMarkPlot, {})]
+    }), /*#__PURE__*/_jsx(ChartsAxisHighlight, _extends({}, axisHighlight)), showTooltip && /*#__PURE__*/_jsx(ChartsTooltip, _extends({}, tooltip)), children]
+  });
+});
+process.env.NODE_ENV !== "production" ? SparkLineChart.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * Set to `true` to fill spark line area.
+   * Has no effect if plotType='bar'.
+   * @default false
+   */
+  area: PropTypes.bool,
+  axisHighlight: PropTypes.shape({
+    x: PropTypes.oneOf(['band', 'line', 'none']),
+    y: PropTypes.oneOf(['line', 'none'])
+  }),
+  children: PropTypes.node,
+  className: PropTypes.string,
+  /**
+   * Color palette used to colorize multiple series.
+   */
+  colors: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.func]),
+  /**
+   * @default 'linear'
+   */
+  curve: PropTypes.oneOf(['catmullRom', 'linear', 'monotoneX', 'monotoneY', 'natural', 'step', 'stepAfter', 'stepBefore']),
+  /**
+   * Data to plot.
+   */
+  data: PropTypes.arrayOf(PropTypes.number).isRequired,
+  dataset: PropTypes.arrayOf(PropTypes.object),
+  desc: PropTypes.string,
+  disableAxisListener: PropTypes.bool,
+  height: PropTypes.number,
+  margin: PropTypes.shape({
+    bottom: PropTypes.number,
+    left: PropTypes.number,
+    right: PropTypes.number,
+    top: PropTypes.number
+  }),
+  /**
+   * Type of plot used.
+   * @default 'line'
+   */
+  plotType: PropTypes.oneOf(['bar', 'line']),
+  /**
+   * Set to `true` to highlight the value.
+   * With line, it shows a point.
+   * With bar, it shows a highlight band.
+   * @default false
+   */
+  showHighlight: PropTypes.bool,
+  /**
+   * Set to `true` to enable the tooltip in the sparkline.
+   * @default false
+   */
+  showTooltip: PropTypes.bool,
+  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
+  title: PropTypes.string,
+  tooltip: PropTypes.shape({
+    axisContent: PropTypes.elementType,
+    classes: PropTypes.object,
+    itemContent: PropTypes.elementType,
+    trigger: PropTypes.oneOf(['axis', 'item', 'none'])
+  }),
+  /**
+   * Formatter used by the tooltip.
+   * @param {number} value The value to format.
+   * @returns {string} the formatted value.
+   */
+  valueFormatter: PropTypes.func,
+  viewBox: PropTypes.shape({
+    height: PropTypes.number,
+    width: PropTypes.number,
+    x: PropTypes.number,
+    y: PropTypes.number
+  }),
+  width: PropTypes.number,
+  /**
+   * The xAxis configuration.
+   * Notice it is a single configuration object, not an array of configuration.
+   */
+  xAxis: PropTypes.shape({
+    axisId: PropTypes.string,
+    classes: PropTypes.object,
+    data: PropTypes.array,
+    dataKey: PropTypes.string,
+    disableLine: PropTypes.bool,
+    disableTicks: PropTypes.bool,
+    fill: PropTypes.string,
+    hideTooltip: PropTypes.bool,
+    id: PropTypes.string,
+    label: PropTypes.string,
+    labelFontSize: PropTypes.number,
+    max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
+    maxTicks: PropTypes.number,
+    min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
+    minTicks: PropTypes.number,
+    position: PropTypes.oneOf(['bottom', 'left', 'right', 'top']),
+    scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
+    stroke: PropTypes.string,
+    tickFontSize: PropTypes.number,
+    tickSize: PropTypes.number,
+    tickSpacing: PropTypes.number,
+    valueFormatter: PropTypes.func
+  })
+} : void 0;
+export { SparkLineChart };

package/modern/SparkLineChart/index.js

@@ -0,0 +1 @@
+export { SparkLineChart } from './SparkLineChart';

package/modern/context/CartesianContextProvider.js

@@ -32,12 +32,37 @@ export const CartesianContext = /*#__PURE__*/React.createContext({
   yAxisIds: []
 });
 function CartesianContextProvider({
-  xAxis,
-  yAxis,
+  xAxis: inXAxis,
+  yAxis: inYAxis,
+  dataset,
   children
 }) {
   const formattedSeries = React.useContext(SeriesContext);
   const drawingArea = React.useContext(DrawingContext);
+  const xAxis = React.useMemo(() => inXAxis?.map(axisConfig => {
+    const dataKey = axisConfig.dataKey;
+    if (dataKey === undefined || axisConfig.data !== undefined) {
+      return axisConfig;
+    }
+    if (dataset === undefined) {
+      throw Error('MUI: x-axis uses `dataKey` but no `dataset` is provided.');
+    }
+    return _extends({}, axisConfig, {
+      data: dataset.map(d => d[dataKey])
+    });
+  }), [inXAxis, dataset]);
+  const yAxis = React.useMemo(() => inYAxis?.map(axisConfig => {
+    const dataKey = axisConfig.dataKey;
+    if (dataKey === undefined || axisConfig.data !== undefined) {
+      return axisConfig;
+    }
+    if (dataset === undefined) {
+      throw Error('MUI: y-axis uses `dataKey` but no `dataset` is provided.');
+    }
+    return _extends({}, axisConfig, {
+      data: dataset.map(d => d[dataKey])
+    });
+  }), [inYAxis, dataset]);
   const value = React.useMemo(() => {
     const axisExtremumCallback = (acc, chartType, axis, getters, isDefaultAxis) => {
       const getter = getters[chartType];
@@ -180,19 +205,22 @@ process.env.NODE_ENV !== "production" ? CartesianContextProvider.propTypes = {
   // | To update them edit the TypeScript types and run "yarn proptypes"  |
   // ----------------------------------------------------------------------
   children: PropTypes.node,
+  dataset: PropTypes.arrayOf(PropTypes.object),
   xAxis: PropTypes.arrayOf(PropTypes.shape({
     axisId: PropTypes.string,
     classes: PropTypes.object,
     data: PropTypes.array,
+    dataKey: PropTypes.string,
     disableLine: PropTypes.bool,
     disableTicks: PropTypes.bool,
     fill: PropTypes.string,
+    hideTooltip: PropTypes.bool,
     id: PropTypes.string,
     label: PropTypes.string,
     labelFontSize: PropTypes.number,
-    max: PropTypes.number,
+    max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
     maxTicks: PropTypes.number,
-    min: PropTypes.number,
+    min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
     minTicks: PropTypes.number,
     position: PropTypes.oneOf(['bottom', 'left', 'right', 'top']),
     scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
@@ -206,15 +234,17 @@ process.env.NODE_ENV !== "production" ? CartesianContextProvider.propTypes = {
     axisId: PropTypes.string,
     classes: PropTypes.object,
     data: PropTypes.array,
+    dataKey: PropTypes.string,
     disableLine: PropTypes.bool,
     disableTicks: PropTypes.bool,
     fill: PropTypes.string,
+    hideTooltip: PropTypes.bool,
     id: PropTypes.string,
     label: PropTypes.string,
     labelFontSize: PropTypes.number,
-    max: PropTypes.number,
+    max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
     maxTicks: PropTypes.number,
-    min: PropTypes.number,
+    min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
     minTicks: PropTypes.number,
     position: PropTypes.oneOf(['bottom', 'left', 'right', 'top']),
     scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),

package/modern/context/DrawingProvider.js

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import useChartDimensions from '../hooks/useChartDimensions';
 
 /**
- * Defines the area in which it is possible to draw the charts
+ * Defines the area in which it is possible to draw the charts.
  */
 import { jsx as _jsx } from "react/jsx-runtime";
 export const DrawingContext = /*#__PURE__*/React.createContext({

package/modern/context/SeriesContextProvider.js

@@ -15,6 +15,7 @@ const seriesTypeFormatter = {
   line: lineSeriesFormatter,
   pie: pieSeriesFormatter
 };
+
 /**
  * This methods is the interface between what the developer is providing and what components receives
  * To simplify the components behaviors, it groups series by type, such that LinePlots props are not updated if some line data are modified
@@ -23,7 +24,7 @@ const seriesTypeFormatter = {
  * @param colors The color palette used to defaultize series colors
  * @returns An object structuring all the series by type.
  */
-const formatSeries = (series, colors) => {
+const formatSeries = (series, colors, dataset) => {
   // Group series by type
   const seriesGroups = {};
   series.forEach((seriesData, seriesIndex) => {
@@ -49,18 +50,19 @@ const formatSeries = (series, colors) => {
   // Apply formater on a type group
   Object.keys(seriesTypeFormatter).forEach(type => {
     if (seriesGroups[type] !== undefined) {
-      formattedSeries[type] = seriesTypeFormatter[type]?.(seriesGroups[type]) ?? seriesGroups[type];
+      formattedSeries[type] = seriesTypeFormatter[type]?.(seriesGroups[type], dataset) ?? seriesGroups[type];
     }
   });
   return formattedSeries;
 };
 export function SeriesContextProvider({
   series,
+  dataset,
   colors = blueberryTwilightPalette,
   children
 }) {
   const theme = useTheme();
-  const formattedSeries = React.useMemo(() => formatSeries(series, typeof colors === 'function' ? colors(theme.palette.mode) : colors), [series, colors, theme.palette.mode]);
+  const formattedSeries = React.useMemo(() => formatSeries(series, typeof colors === 'function' ? colors(theme.palette.mode) : colors, dataset), [series, colors, theme.palette.mode, dataset]);
   return /*#__PURE__*/_jsx(SeriesContext.Provider, {
     value: formattedSeries,
     children: children

package/modern/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-charts v6.0.0-alpha.4
+ * @mui/x-charts v6.0.0-alpha.6
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the
@@ -20,5 +20,6 @@ export * from './BarChart';
 export * from './LineChart';
 export * from './PieChart';
 export * from './ScatterChart';
+export * from './SparkLineChart';
 export * from './ChartContainer';
 export * from './ResponsiveChartContainer';

package/modern/models/index.js

@@ -1 +1,3 @@
-export * from './seriesType';
+export * from './seriesType';
+export * from './layout';
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-charts",
-  "version": "6.0.0-alpha.4",
+  "version": "6.0.0-alpha.6",
   "description": "The community edition of the charts components (MUI X).",
   "author": "MUI Team",
   "main": "./index.js",
@@ -52,10 +52,12 @@
   },
   "exports": {
     ".": {
+      "types": "./index.d.ts",
       "require": "./index.js",
       "import": "./esm/index.js"
     },
     "./*": {
+      "types": "./*/index.d.ts",
       "require": "./*",
       "import": "./esm/*"
     }