@mui/x-charts-pro 8.0.0-beta.3 → 8.0.0

package/modern/internals/plugins/useChartProZoom/useChartProZoom.types.d.ts

@@ -1,53 +0,0 @@
-import { UseChartSeriesSignature, ChartPluginSignature, UseChartCartesianAxisSignature, UseChartCartesianAxisDefaultizedParameters, ZoomData } from '@mui/x-charts/internals';
-export interface UseChartProZoomParameters {
-  /**
-   * The list of zoom data related to each axis.
-   * Used to initialize the zoom in a specific configuration without controlling it.
-   */
-  initialZoom?: readonly ZoomData[];
-  /**
-   * Callback fired when the zoom has changed.
-   *
-   * @param {ZoomData[]} zoomData Updated zoom data.
-   */
-  onZoomChange?: (zoomData: ZoomData[]) => void;
-  /**
-   * The list of zoom data related to each axis.
-   */
-  zoomData?: readonly ZoomData[];
-}
-export type UseChartProZoomDefaultizedParameters = UseChartProZoomParameters & UseChartCartesianAxisDefaultizedParameters;
-export interface UseChartProZoomState {
-  zoom: {
-    /**
-     * Whether the user is currently interacting with the chart.
-     * This is useful to disable animations while the user is interacting.
-     */
-    isInteracting: boolean;
-    /**
-     * Mapping of axis id to the zoom data.
-     */
-    zoomData: readonly ZoomData[];
-    /**
-     * Internal information to know if the user control the state or not.
-     */
-    isControlled: boolean;
-  };
-}
-export interface UseChartProZoomPublicApi {
-  /**
-   * Set the zoom data state.
-   * @param {ZoomData[] | ((prev: ZoomData[]) => ZoomData[])} value  The new value. Can either be the new zoom data, or an updater function.
-   * @returns {void}
-   */
-  setZoomData: (value: ZoomData[] | ((prev: ZoomData[]) => ZoomData[])) => void;
-}
-export interface UseChartProZoomInstance extends UseChartProZoomPublicApi {}
-export type UseChartProZoomSignature = ChartPluginSignature<{
-  params: UseChartProZoomParameters;
-  defaultizedParams: UseChartProZoomDefaultizedParameters;
-  state: UseChartProZoomState;
-  publicAPI: UseChartProZoomPublicApi;
-  instance: UseChartProZoomInstance;
-  dependencies: [UseChartSeriesSignature, UseChartCartesianAxisSignature];
-}>;

package/modern/internals/plugins/useChartProZoom/useChartProZoom.types.js

@@ -1 +0,0 @@
-export {};

package/modern/internals/plugins/useChartProZoom/useChartProZoom.utils.d.ts

@@ -1,45 +0,0 @@
-import { DefaultizedZoomOptions, ZoomData } from '@mui/x-charts/internals';
-/**
- * Helper to get the range (in percents of a reference range) corresponding to a given scale.
- * @param centerRatio {number} The ratio of the point that should not move between the previous and next range.
- * @param scaleRatio {number} The target scale ratio.
- * @returns The range to display.
- */
-export declare const zoomAtPoint: (centerRatio: number, scaleRatio: number, currentZoomData: ZoomData, options: DefaultizedZoomOptions) => number[];
-/**
- * Checks if the new span is valid.
- */
-export declare function isSpanValid(minRange: number, maxRange: number, isZoomIn: boolean, option: DefaultizedZoomOptions): boolean;
-/**
- * Get the scale ratio and if it's a zoom in or out from a wheel event.
- */
-export declare function getWheelScaleRatio(event: WheelEvent, step: number): {
-  scaleRatio: number;
-  isZoomIn: boolean;
-};
-/**
- * Get the scale ratio and if it's a zoom in or out from a pinch gesture.
- */
-export declare function getPinchScaleRatio(curDiff: number, prevDiff: number, step: number): {
-  scaleRatio: number;
-  isZoomIn: boolean;
-};
-export declare function getDiff(eventCache: PointerEvent[]): number;
-/**
- * Get the ratio of the point in the horizontal center of the area.
- */
-export declare function getHorizontalCenterRatio(point: {
-  x: number;
-  y: number;
-}, area: {
-  left: number;
-  width: number;
-}): number;
-export declare function preventDefault(event: TouchEvent): void;
-export declare function getVerticalCenterRatio(point: {
-  x: number;
-  y: number;
-}, area: {
-  top: number;
-  height: number;
-}): number;

package/modern/internals/plugins/useChartProZoom/useChartProZoom.utils.js

@@ -1,126 +0,0 @@
-/**
- * Helper to get the range (in percents of a reference range) corresponding to a given scale.
- * @param centerRatio {number} The ratio of the point that should not move between the previous and next range.
- * @param scaleRatio {number} The target scale ratio.
- * @returns The range to display.
- */
-export const zoomAtPoint = (centerRatio, scaleRatio, currentZoomData, options) => {
-  const MIN_RANGE = options.minStart;
-  const MAX_RANGE = options.maxEnd;
-  const MIN_ALLOWED_SPAN = options.minSpan;
-  const minRange = currentZoomData.start;
-  const maxRange = currentZoomData.end;
-  const point = minRange + centerRatio * (maxRange - minRange);
-  let newMinRange = (minRange + point * (scaleRatio - 1)) / scaleRatio;
-  let newMaxRange = (maxRange + point * (scaleRatio - 1)) / scaleRatio;
-  let minSpillover = 0;
-  let maxSpillover = 0;
-  if (newMinRange < MIN_RANGE) {
-    minSpillover = Math.abs(newMinRange);
-    newMinRange = MIN_RANGE;
-  }
-  if (newMaxRange > MAX_RANGE) {
-    maxSpillover = Math.abs(newMaxRange - MAX_RANGE);
-    newMaxRange = MAX_RANGE;
-  }
-  if (minSpillover > 0 && maxSpillover > 0) {
-    return [MIN_RANGE, MAX_RANGE];
-  }
-  newMaxRange += minSpillover;
-  newMinRange -= maxSpillover;
-  newMinRange = Math.min(MAX_RANGE - MIN_ALLOWED_SPAN, Math.max(MIN_RANGE, newMinRange));
-  newMaxRange = Math.max(MIN_ALLOWED_SPAN, Math.min(MAX_RANGE, newMaxRange));
-  return [newMinRange, newMaxRange];
-};
-
-/**
- * Checks if the new span is valid.
- */
-export function isSpanValid(minRange, maxRange, isZoomIn, option) {
-  const newSpanPercent = maxRange - minRange;
-  if (isZoomIn && newSpanPercent < option.minSpan || !isZoomIn && newSpanPercent > option.maxSpan) {
-    return false;
-  }
-  if (minRange < option.minStart || maxRange > option.maxEnd) {
-    return false;
-  }
-  return true;
-}
-function getMultiplier(event) {
-  const ctrlMultiplier = event.ctrlKey ? 3 : 1;
-
-  // DeltaMode: 0 is pixel, 1 is line, 2 is page
-  // This is defined by the browser.
-  if (event.deltaMode === 1) {
-    return 1 * ctrlMultiplier;
-  }
-  if (event.deltaMode) {
-    return 10 * ctrlMultiplier;
-  }
-  return 0.2 * ctrlMultiplier;
-}
-
-/**
- * Get the scale ratio and if it's a zoom in or out from a wheel event.
- */
-export function getWheelScaleRatio(event, step) {
-  const deltaY = -event.deltaY;
-  const multiplier = getMultiplier(event);
-  const scaledStep = step * multiplier * deltaY / 1000;
-  // Clamp the scale ratio between 0.1 and 1.9 so that the zoom is not too big or too small.
-  const scaleRatio = Math.min(Math.max(1 + scaledStep, 0.1), 1.9);
-  const isZoomIn = deltaY > 0;
-  return {
-    scaleRatio,
-    isZoomIn
-  };
-}
-
-/**
- * Get the scale ratio and if it's a zoom in or out from a pinch gesture.
- */
-export function getPinchScaleRatio(curDiff, prevDiff, step) {
-  const scaledStep = step / 1000;
-  let scaleRatio = 0;
-  let isZoomIn = false;
-  const hasMoved = prevDiff > 0;
-  if (hasMoved && curDiff > prevDiff) {
-    // The distance between the two pointers has increased
-    scaleRatio = 1 + scaledStep;
-    isZoomIn = true;
-  }
-  if (hasMoved && curDiff < prevDiff) {
-    // The distance between the two pointers has decreased
-    scaleRatio = 1 - scaledStep;
-    isZoomIn = false;
-  }
-  return {
-    scaleRatio,
-    isZoomIn
-  };
-}
-export function getDiff(eventCache) {
-  const [firstEvent, secondEvent] = eventCache;
-  return Math.hypot(firstEvent.pageX - secondEvent.pageX, firstEvent.pageY - secondEvent.pageY);
-}
-
-/**
- * Get the ratio of the point in the horizontal center of the area.
- */
-export function getHorizontalCenterRatio(point, area) {
-  const {
-    left,
-    width
-  } = area;
-  return (point.x - left) / width;
-}
-export function preventDefault(event) {
-  event.preventDefault();
-}
-export function getVerticalCenterRatio(point, area) {
-  const {
-    top,
-    height
-  } = area;
-  return (point.y - top) / height * -1 + 1;
-}

package/modern/internals/utils/releaseInfo.d.ts

@@ -1 +0,0 @@
-export declare const getReleaseInfo: () => any;

package/modern/internals/utils/releaseInfo.js

@@ -1,13 +0,0 @@
-import ponyfillGlobal from '@mui/utils/ponyfillGlobal';
-export const getReleaseInfo = () => {
-  const releaseInfo = "MTc0MzYzMTIwMDAwMA==";
-  if (process.env.NODE_ENV !== 'production') {
-    // A simple hack to set the value in the test environment (has no build step).
-    // eslint-disable-next-line no-useless-concat
-    if (releaseInfo === '__RELEASE' + '_INFO__') {
-      // eslint-disable-next-line no-underscore-dangle
-      return ponyfillGlobal.__MUI_RELEASE_INFO__;
-    }
-  }
-  return releaseInfo;
-};

package/modern/models/index.d.ts

@@ -1,2 +0,0 @@
-export type { ZoomData } from '@mui/x-charts/internals';
-export * from "./seriesType/index.js";

package/modern/models/index.js

@@ -1,2 +0,0 @@
-export * from "./seriesType/index.js";
-export {};

package/modern/models/seriesType/heatmap.d.ts

@@ -1,28 +0,0 @@
-import { DefaultizedProps } from '@mui/x-internals/types';
-import { CommonDefaultizedProps, CommonSeriesType, CartesianSeriesType } from '@mui/x-charts/internals';
-export type HeatmapValueType = readonly [number, number, number];
-export interface HeatmapSeriesType extends Omit<CommonSeriesType<HeatmapValueType>, 'color'>, CartesianSeriesType {
-  type: 'heatmap';
-  /**
-   * Data associated to each bar.
-   */
-  data?: readonly HeatmapValueType[];
-  /**
-   * The key used to retrieve data from the dataset.
-   */
-  dataKey?: string;
-  /**
-   * The label to display on the tooltip or the legend. It can be a string or a function.
-   */
-  label?: string | ((location: 'tooltip' | 'legend') => string);
-}
-/**
- * An object that allows to identify a single bar.
- * Used for item interaction
- */
-export type HeatmapItemIdentifier = {
-  type: 'heatmap';
-  seriesId: DefaultizedHeatmapSeriesType['id'];
-  dataIndex: number;
-};
-export interface DefaultizedHeatmapSeriesType extends DefaultizedProps<HeatmapSeriesType, CommonDefaultizedProps> {}

package/modern/models/seriesType/heatmap.js

@@ -1 +0,0 @@
-export {};

package/modern/models/seriesType/index.d.ts

@@ -1 +0,0 @@
-export * from "./heatmap.js";

package/modern/models/seriesType/index.js

@@ -1 +0,0 @@
-export * from "./heatmap.js";

package/modern/package.json

@@ -1 +0,0 @@
-{"type":"module","sideEffects":false}

package/modern/themeAugmentation/components.d.ts

@@ -1,23 +0,0 @@
-import { ComponentsProps, ComponentsOverrides } from '@mui/material/styles';
-export interface ChartsProComponents<Theme = unknown> {
-  // BarChartPro components
-  MuiBarChartPro?: {
-    defaultProps?: ComponentsProps['MuiBarChartPro'];
-  };
-  // LineChartPro components
-  MuiLineChartPro?: {
-    defaultProps?: ComponentsProps['MuiLineChartPro'];
-  };
-  // Heatmap components
-  MuiHeatmap?: {
-    defaultProps?: ComponentsProps['MuiHeatmap'];
-    styleOverrides?: ComponentsOverrides<Theme>['MuiHeatmap'];
-  };
-  // ScatterChartPro components
-  MuiScatterChartPro?: {
-    defaultProps?: ComponentsProps['MuiScatterChartPro'];
-  };
-}
-declare module '@mui/material/styles' {
-  interface Components<Theme = unknown> extends ChartsProComponents<Theme> {}
-}

package/modern/themeAugmentation/index.d.ts

@@ -1,4 +0,0 @@
-export type * from '@mui/x-charts/themeAugmentation';
-export type * from './overrides';
-export type * from './props';
-export type * from './components';

package/modern/themeAugmentation/overrides.d.ts

@@ -1,11 +0,0 @@
-import { HeatmapClassKey } from "../Heatmap/index.js";
-export interface ChartsProComponentNameToClassKey {
-  // Heatmap components
-  MuiHeatmap: HeatmapClassKey;
-}
-declare module '@mui/material/styles' {
-  interface ComponentNameToClassKey extends ChartsProComponentNameToClassKey {}
-}
-
-// disable automatic export
-export {};

package/modern/themeAugmentation/props.d.ts

@@ -1,20 +0,0 @@
-import { ScatterChartProProps } from "../ScatterChartPro/index.js";
-import { BarChartProProps } from "../BarChartPro/index.js";
-import { HeatmapProps } from "../Heatmap/Heatmap.js";
-import { LineChartProProps } from "../LineChartPro/index.js";
-export interface ChartsProComponentsPropsList {
-  // BarChartPro components
-  MuiBarChartPro: BarChartProProps;
-  // LineChartPro components
-  MuiLineChartPro: LineChartProProps;
-  // Heatmap components
-  MuiHeatmap: HeatmapProps;
-  // ScatterChartPro components
-  MuiScatterChartPro: ScatterChartProProps;
-}
-declare module '@mui/material/styles' {
-  interface ComponentsPropsList extends ChartsProComponentsPropsList {}
-}
-
-// disable automatic export
-export {};

package/modern/typeOverloads/index.d.ts

@@ -1 +0,0 @@
-export {} from "./modules.js";

package/modern/typeOverloads/index.js

@@ -1 +0,0 @@
-export {} from "./modules.js";

package/modern/typeOverloads/modules.d.ts

@@ -1,33 +0,0 @@
-import { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
-import { AxisId, ZoomOptions } from '@mui/x-charts/internals';
-import { HeatmapItemIdentifier, HeatmapSeriesType, DefaultizedHeatmapSeriesType, HeatmapValueType } from "../models/seriesType/heatmap.js";
-import { DefaultizedFunnelSeriesType, FunnelItemIdentifier, FunnelSeriesType, FunnelValueType } from "../FunnelChart/funnel.types.js";
-declare module '@mui/x-charts/internals' {
-  interface ChartsSeriesConfig {
-    heatmap: {
-      seriesInput: DefaultizedProps<HeatmapSeriesType, 'id'>;
-      series: DefaultizedHeatmapSeriesType;
-      seriesProp: HeatmapSeriesType;
-      itemIdentifier: HeatmapItemIdentifier;
-      valueType: HeatmapValueType;
-      axisType: 'cartesian';
-    };
-    funnel: {
-      seriesInput: Omit<DefaultizedProps<FunnelSeriesType, 'id'>, 'data'> & {
-        data: MakeRequired<FunnelValueType, 'color'>[];
-      };
-      series: DefaultizedFunnelSeriesType;
-      seriesProp: FunnelSeriesType;
-      itemIdentifier: FunnelItemIdentifier;
-      valueType: MakeRequired<FunnelValueType, 'id' | 'color'>;
-      axisType: 'cartesian';
-    };
-  }
-  interface DefaultizedZoomOptions extends Required<ZoomOptions> {
-    axisId: AxisId;
-    axisDirection: 'x' | 'y';
-  }
-  interface AxisConfigExtension {
-    zoom?: boolean | ZoomOptions;
-  }
-}

package/modern/typeOverloads/modules.js

@@ -1 +0,0 @@
-export {};