@mui/x-charts-pro 8.0.0-alpha.9 → 8.0.0-beta.1

package/internals/plugins/useChartProZoom/useChartProZoom.js

@@ -1,12 +1,17 @@
+"use strict";
 'use client';
 
-import _extends from "@babel/runtime/helpers/esm/extends";
-import * as React from 'react';
-import { useSelector, getSVGPoint, selectorChartDrawingArea } from '@mui/x-charts/internals';
-import { creatZoomLookup } from "./creatZoomLookup.js";
-import { getDiff, getHorizontalCenterRatio, getPinchScaleRatio, getVerticalCenterRatio, getWheelScaleRatio, isSpanValid, preventDefault, zoomAtPoint } from "./useChartProZoom.utils.js";
-import { selectorChartZoomOptionsLookup } from "./useChartProZoom.selectors.js";
-
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useChartProZoom = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var React = _interopRequireWildcard(require("react"));
+var _useEnhancedEffect = _interopRequireDefault(require("@mui/utils/useEnhancedEffect"));
+var _internals = require("@mui/x-charts/internals");
+var _useChartProZoom = require("./useChartProZoom.utils");
 // It is helpful to avoid the need to provide the possibly auto-generated id for each axis.
 function initializeZoomData(options) {
   return Object.values(options).map(({
@@ -19,39 +24,79 @@ function initializeZoomData(options) {
     end
   }));
 }
-export const useChartProZoom = ({
+const useChartProZoom = ({
   store,
   instance,
   svgRef,
   params
 }) => {
-  const drawingArea = useSelector(store, selectorChartDrawingArea);
-  const optionsLookup = useSelector(store, selectorChartZoomOptionsLookup);
+  const {
+    zoomData: paramsZoomData,
+    onZoomChange
+  } = params;
+  const drawingArea = (0, _internals.useSelector)(store, _internals.selectorChartDrawingArea);
+  const optionsLookup = (0, _internals.useSelector)(store, _internals.selectorChartZoomOptionsLookup);
   const isZoomEnabled = Object.keys(optionsLookup).length > 0;
 
-  // Add events
-  const panningEventCacheRef = React.useRef([]);
-  const zoomEventCacheRef = React.useRef([]);
-  const eventPrevDiff = React.useRef(0);
-  const interactionTimeoutRef = React.useRef(undefined);
+  // Manage controlled state
+
+  (0, _useEnhancedEffect.default)(() => {
+    if (paramsZoomData === undefined) {
+      return undefined;
+    }
+    store.update(prevState => {
+      if (process.env.NODE_ENV !== 'production' && !prevState.zoom.isControlled) {
+        console.error([`MUI X: A chart component is changing the \`zoomData\` from uncontrolled to controlled.`, 'Elements should not switch from uncontrolled to controlled (or vice versa).', 'Decide between using a controlled or uncontrolled for the lifetime of the component.', "The nature of the state is determined during the first render. It's considered controlled if the value is not `undefined`.", 'More info: https://fb.me/react-controlled-components'].join('\n'));
+      }
+      return (0, _extends2.default)({}, prevState, {
+        zoom: (0, _extends2.default)({}, prevState.zoom, {
+          isInteracting: true,
+          zoomData: paramsZoomData
+        })
+      });
+    });
+    const timeout = setTimeout(() => {
+      store.update(prevState => {
+        return (0, _extends2.default)({}, prevState, {
+          zoom: (0, _extends2.default)({}, prevState.zoom, {
+            isInteracting: false
+          })
+        });
+      });
+    }, 166);
+    return () => {
+      clearTimeout(timeout);
+    };
+  }, [store, paramsZoomData]);
+
+  // Add instance methods
   const setIsInteracting = React.useCallback(isInteracting => {
-    store.update(prev => _extends({}, prev, {
-      zoom: _extends({}, prev.zoom, {
+    store.update(prev => (0, _extends2.default)({}, prev, {
+      zoom: (0, _extends2.default)({}, prev.zoom, {
         isInteracting
       })
     }));
   }, [store]);
   const setZoomDataCallback = React.useCallback(zoomData => {
     store.update(prevState => {
-      const newZoomData = typeof zoomData === 'function' ? zoomData(prevState.zoom.zoomData) : zoomData;
-      params.onZoomChange?.(newZoomData);
-      return _extends({}, prevState, {
-        zoom: _extends({}, prevState.zoom, {
+      const newZoomData = typeof zoomData === 'function' ? zoomData([...prevState.zoom.zoomData]) : zoomData;
+      onZoomChange?.(newZoomData);
+      if (prevState.zoom.isControlled) {
+        return prevState;
+      }
+      return (0, _extends2.default)({}, prevState, {
+        zoom: (0, _extends2.default)({}, prevState.zoom, {
           zoomData: newZoomData
         })
       });
     });
-  }, [params, store]);
+  }, [onZoomChange, store]);
+
+  // Add events
+  const panningEventCacheRef = React.useRef([]);
+  const zoomEventCacheRef = React.useRef([]);
+  const eventPrevDiff = React.useRef(0);
+  const interactionTimeoutRef = React.useRef(undefined);
 
   // Add event for chart panning
   const isPanEnabled = React.useMemo(() => Object.values(optionsLookup).some(v => v.panning) || false, [optionsLookup]);
@@ -69,7 +114,7 @@ export const useChartProZoom = ({
       if (touchStartRef.current == null) {
         return;
       }
-      const point = getSVGPoint(element, event);
+      const point = (0, _internals.getSVGPoint)(element, event);
       const movementX = point.x - touchStartRef.current.x;
       const movementY = (point.y - touchStartRef.current.y) * -1;
       const newZoomData = touchStartRef.current.zoomData.map(zoom => {
@@ -97,7 +142,7 @@ export const useChartProZoom = ({
         if (newMinPercent < MIN_PERCENT || newMaxPercent > MAX_PERCENT || span < options.minSpan || span > options.maxSpan) {
           return zoom;
         }
-        return _extends({}, zoom, {
+        return (0, _extends2.default)({}, zoom, {
           start: newMinPercent,
           end: newMaxPercent
         });
@@ -106,7 +151,7 @@ export const useChartProZoom = ({
     };
     const handleDown = event => {
       panningEventCacheRef.current.push(event);
-      const point = getSVGPoint(element, event);
+      const point = (0, _internals.getSVGPoint)(element, event);
       if (!instance.isPointInside(point)) {
         return;
       }
@@ -152,7 +197,7 @@ export const useChartProZoom = ({
       if (element === null) {
         return;
       }
-      const point = getSVGPoint(element, event);
+      const point = (0, _internals.getSVGPoint)(element, event);
       if (!instance.isPointInside(point)) {
         return;
       }
@@ -172,13 +217,13 @@ export const useChartProZoom = ({
           if (!option) {
             return zoom;
           }
-          const centerRatio = option.axisDirection === 'x' ? getHorizontalCenterRatio(point, drawingArea) : getVerticalCenterRatio(point, drawingArea);
+          const centerRatio = option.axisDirection === 'x' ? (0, _useChartProZoom.getHorizontalCenterRatio)(point, drawingArea) : (0, _useChartProZoom.getVerticalCenterRatio)(point, drawingArea);
           const {
             scaleRatio,
             isZoomIn
-          } = getWheelScaleRatio(event, option.step);
-          const [newMinRange, newMaxRange] = zoomAtPoint(centerRatio, scaleRatio, zoom, option);
-          if (!isSpanValid(newMinRange, newMaxRange, isZoomIn, option)) {
+          } = (0, _useChartProZoom.getWheelScaleRatio)(event, option.step);
+          const [newMinRange, newMaxRange] = (0, _useChartProZoom.zoomAtPoint)(centerRatio, scaleRatio, zoom, option);
+          if (!(0, _useChartProZoom.isSpanValid)(newMinRange, newMaxRange, isZoomIn, option)) {
             return zoom;
           }
           return {
@@ -205,7 +250,7 @@ export const useChartProZoom = ({
         return;
       }
       const firstEvent = zoomEventCacheRef.current[0];
-      const curDiff = getDiff(zoomEventCacheRef.current);
+      const curDiff = (0, _useChartProZoom.getDiff)(zoomEventCacheRef.current);
       setZoomDataCallback(prevZoomData => {
         const newZoomData = prevZoomData.map(zoom => {
           const option = optionsLookup[zoom.axisId];
@@ -215,16 +260,16 @@ export const useChartProZoom = ({
           const {
             scaleRatio,
             isZoomIn
-          } = getPinchScaleRatio(curDiff, eventPrevDiff.current, option.step);
+          } = (0, _useChartProZoom.getPinchScaleRatio)(curDiff, eventPrevDiff.current, option.step);
 
           // If the scale ratio is 0, it means the pinch gesture is not valid.
           if (scaleRatio === 0) {
             return zoom;
           }
-          const point = getSVGPoint(element, firstEvent);
-          const centerRatio = option.axisDirection === 'x' ? getHorizontalCenterRatio(point, drawingArea) : getVerticalCenterRatio(point, drawingArea);
-          const [newMinRange, newMaxRange] = zoomAtPoint(centerRatio, scaleRatio, zoom, option);
-          if (!isSpanValid(newMinRange, newMaxRange, isZoomIn, option)) {
+          const point = (0, _internals.getSVGPoint)(element, firstEvent);
+          const centerRatio = option.axisDirection === 'x' ? (0, _useChartProZoom.getHorizontalCenterRatio)(point, drawingArea) : (0, _useChartProZoom.getVerticalCenterRatio)(point, drawingArea);
+          const [newMinRange, newMaxRange] = (0, _useChartProZoom.zoomAtPoint)(centerRatio, scaleRatio, zoom, option);
+          if (!(0, _useChartProZoom.isSpanValid)(newMinRange, newMaxRange, isZoomIn, option)) {
             return zoom;
           }
           return {
@@ -255,8 +300,8 @@ export const useChartProZoom = ({
     element.addEventListener('pointerleave', pointerUpHandler);
 
     // Prevent zooming the entire page on touch devices
-    element.addEventListener('touchstart', preventDefault);
-    element.addEventListener('touchmove', preventDefault);
+    element.addEventListener('touchstart', _useChartProZoom.preventDefault);
+    element.addEventListener('touchmove', _useChartProZoom.preventDefault);
     return () => {
       element.removeEventListener('wheel', wheelHandler);
       element.removeEventListener('pointerdown', pointerDownHandler);
@@ -265,8 +310,8 @@ export const useChartProZoom = ({
       element.removeEventListener('pointercancel', pointerUpHandler);
       element.removeEventListener('pointerout', pointerUpHandler);
       element.removeEventListener('pointerleave', pointerUpHandler);
-      element.removeEventListener('touchstart', preventDefault);
-      element.removeEventListener('touchmove', preventDefault);
+      element.removeEventListener('touchstart', _useChartProZoom.preventDefault);
+      element.removeEventListener('touchmove', _useChartProZoom.preventDefault);
       if (interactionTimeoutRef.current) {
         clearTimeout(interactionTimeoutRef.current);
       }
@@ -281,23 +326,32 @@ export const useChartProZoom = ({
     }
   };
 };
+exports.useChartProZoom = useChartProZoom;
 useChartProZoom.params = {
   initialZoom: true,
-  onZoomChange: true
+  onZoomChange: true,
+  zoomData: true
 };
 useChartProZoom.getDefaultizedParams = ({
   params
 }) => {
-  const optionsLookup = _extends({}, creatZoomLookup(params.defaultizedXAxis), creatZoomLookup(params.defaultizedYAxis));
-  return _extends({}, params, {
-    optionsLookup
-  });
+  return (0, _extends2.default)({}, params);
 };
 useChartProZoom.getInitialState = params => {
+  const {
+    initialZoom,
+    zoomData,
+    defaultizedXAxis,
+    defaultizedYAxis
+  } = params;
+  const optionsLookup = (0, _extends2.default)({}, (0, _internals.createZoomLookup)('x')(defaultizedXAxis), (0, _internals.createZoomLookup)('y')(defaultizedYAxis));
   return {
     zoom: {
-      zoomData: params.initialZoom === undefined ? initializeZoomData(params.optionsLookup) : params.initialZoom,
-      isInteracting: false
+      zoomData:
+      // eslint-disable-next-line no-nested-ternary
+      zoomData !== undefined ? zoomData : initialZoom !== undefined ? initialZoom : initializeZoomData(optionsLookup),
+      isInteracting: false,
+      isControlled: zoomData !== undefined
     }
   };
 };