@mui/x-charts 8.0.0-alpha.0 → 8.0.0-alpha.10

package/ChartsLegend/legend.types.d.ts

@@ -1,62 +1,9 @@
-import { ChartsTextBaseline, ChartsTextStyle } from '../internals/getWordsByLines';
-import { AxisId } from '../models/axis';
-export type AnchorX = 'left' | 'right' | 'middle';
-export type AnchorY = 'top' | 'bottom' | 'middle';
-export type AnchorPosition = {
-    horizontal: AnchorX;
-    vertical: AnchorY;
-};
-export type Direction = 'row' | 'column';
-export interface ColorLegendSelector {
-    /**
-     * The axis direction containing the color configuration to represent.
-     * @default 'z'
-     */
-    axisDirection?: 'x' | 'y' | 'z';
-    /**
-     * The id of the axis item with the color configuration to represent.
-     * @default The first axis item.
-     */
-    axisId?: AxisId;
-}
-export interface LegendPlacement {
-    /**
-     * The position of the legend.
-     */
-    position?: AnchorPosition;
-    /**
-     * The direction of the legend layout.
-     * The default depends on the chart.
-     */
-    direction?: Direction;
-}
-export type BoundingBox = {
-    width: number;
-    height: number;
-};
-export interface Position {
-    x: number;
-    y: number;
-}
-export interface TextPosition extends Position {
-    dominantBaseline: ChartsTextBaseline;
-    textAnchor: ChartsTextStyle['textAnchor'];
-}
-export type PiecewiseLabelFormatterParams = {
-    /**
-     * The min value of the piece. `null` is infinite.
-     */
-    min: number | Date | null;
-    /**
-     * The max value of the piece. `null` is infinite.
-     */
-    max: number | Date | null;
-    /**
-     * The formatted min value of the piece. `null` is infinite.
-     */
-    formattedMin: string | null;
+import { Position } from '../models/position';
+export type ChartsLegendPosition = {
     /**
-     * The formatted max value of the piece. `null` is infinite.
+     * The position of the legend in relation to the chart.
+     * This property is only passed to the Chart components, e.g. `ScatterChart`, and not the slots themselves.
+     * If customization is needed, simply use the composition pattern.
      */
-    formattedMax: string | null;
+    position?: Position;
 };

package/ChartsLegend/legendContext.types.d.ts

@@ -0,0 +1,55 @@
+import { ChartsLabelMarkProps } from '../ChartsLabel/ChartsLabelMark';
+import { PieItemId } from '../models';
+import { SeriesId } from '../models/seriesType/common';
+interface LegendItemContextBase {
+    /**
+     * The color used in the legend
+     */
+    color: string;
+    /**
+     * The label displayed in the legend
+     */
+    label: string;
+}
+export interface LegendItemParams extends Partial<Omit<SeriesLegendItemContext, 'type' | keyof LegendItemContextBase>>, Partial<Omit<PiecewiseColorLegendItemContext, 'type' | keyof LegendItemContextBase>>, LegendItemContextBase {
+    /**
+     * The identifier of the legend element.
+     * Used for internal purpose such as `key` props
+     */
+    id: number | string;
+    markType: ChartsLabelMarkProps['type'];
+}
+export interface SeriesLegendItemContext extends LegendItemContextBase {
+    /**
+     * The type of the legend item
+     * - `series` is used for series legend item
+     * - `piecewiseColor` is used for piecewise color legend item
+     */
+    type: 'series';
+    /**
+     * The identifier of the series
+     */
+    seriesId: SeriesId;
+    /**
+     * The identifier of the pie item
+     */
+    itemId?: PieItemId;
+}
+export interface PiecewiseColorLegendItemContext extends LegendItemContextBase {
+    /**
+     * The type of the legend item
+     * - `series` is used for series legend item
+     * - `piecewiseColor` is used for piecewise color legend item
+     */
+    type: 'piecewiseColor';
+    /**
+     * The minimum value of the category
+     */
+    minValue: number | Date | null;
+    /**
+     * The maximum value of the category
+     */
+    maxValue: number | Date | null;
+}
+export type LegendItemContext = SeriesLegendItemContext | PiecewiseColorLegendItemContext;
+export {};

package/ChartsLegend/onClickContextBuilder.d.ts

@@ -0,0 +1,2 @@
+import { LegendItemParams, SeriesLegendItemContext } from './legendContext.types';
+export declare const seriesContextBuilder: (context: LegendItemParams) => SeriesLegendItemContext;

package/ChartsLegend/onClickContextBuilder.js

@@ -0,0 +1,7 @@
+export const seriesContextBuilder = context => ({
+  type: 'series',
+  color: context.color,
+  label: context.label,
+  seriesId: context.seriesId,
+  itemId: context.itemId
+});

package/ChartsLegend/piecewiseColorDefaultLabelFormatter.d.ts

@@ -0,0 +1,2 @@
+import { PiecewiseLabelFormatterParams } from './piecewiseColorLegend.types';
+export declare function piecewiseColorDefaultLabelFormatter(params: PiecewiseLabelFormatterParams): string;

package/ChartsLegend/piecewiseColorDefaultLabelFormatter.js

@@ -0,0 +1,9 @@
+export function piecewiseColorDefaultLabelFormatter(params) {
+  if (params.min === null) {
+    return `<${params.formattedMax}`;
+  }
+  if (params.max === null) {
+    return `>${params.formattedMin}`;
+  }
+  return `${params.formattedMin}-${params.formattedMax}`;
+}

package/ChartsLegend/piecewiseColorLegend.types.d.ts

@@ -0,0 +1,26 @@
+export type PiecewiseLabelFormatterParams = {
+    /**
+     * The index of the entry.
+     */
+    index: number;
+    /**
+     * The length of the entries array.
+     */
+    length: number;
+    /**
+     * The min value of the piece. `null` is infinite.
+     */
+    min: number | Date | null;
+    /**
+     * The max value of the piece. `null` is infinite.
+     */
+    max: number | Date | null;
+    /**
+     * The formatted min value of the piece. `null` is infinite.
+     */
+    formattedMin: string | null;
+    /**
+     * The formatted max value of the piece. `null` is infinite.
+     */
+    formattedMax: string | null;
+};

package/ChartsLegend/piecewiseColorLegendClasses.d.ts

@@ -0,0 +1,28 @@
+import type { PiecewiseColorLegendProps } from './PiecewiseColorLegend';
+import type { ChartsLegendSlotExtension } from './chartsLegend.types';
+export interface PiecewiseColorLegendClasses {
+    /** Styles applied to the root element. */
+    root: string;
+    /** Styles applied to the list item that renders the `minLabel`. */
+    minLabel: string;
+    /** Styles applied to the list item that renders the `maxLabel`. */
+    maxLabel: string;
+    /** Styles applied to the list items. */
+    item: string;
+    /** Styles applied to the legend in column layout. */
+    vertical: string;
+    /** Styles applied to the legend in row layout. */
+    horizontal: string;
+    /** Styles applied to the legend with the labels before the color marks. */
+    start: string;
+    /** Styles applied to the legend with the labels after the color marks. */
+    end: string;
+    /** Styles applied to the legend with the labels on the extremes of the color marks. */
+    extremes: string;
+    /** Styles applied to the marks. */
+    mark: string;
+    /** Styles applied to the series label. */
+    label: string;
+}
+export declare const useUtilityClasses: (props: PiecewiseColorLegendProps & ChartsLegendSlotExtension) => Record<"label" | "mark" | "root" | "item" | "minLabel" | "maxLabel", string>;
+export declare const piecewiseColorLegendClasses: PiecewiseColorLegendClasses;

package/ChartsLegend/piecewiseColorLegendClasses.js

@@ -0,0 +1,23 @@
+import generateUtilityClass from '@mui/utils/generateUtilityClass';
+import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
+import composeClasses from '@mui/utils/composeClasses';
+function getLegendUtilityClass(slot) {
+  return generateUtilityClass('MuiPiecewiseColorLegendClasses', slot);
+}
+export const useUtilityClasses = props => {
+  const {
+    classes,
+    direction,
+    labelPosition
+  } = props;
+  const slots = {
+    root: ['root', direction, labelPosition],
+    minLabel: ['minLabel'],
+    maxLabel: ['maxLabel'],
+    item: ['item'],
+    mark: ['mark'],
+    label: ['label']
+  };
+  return composeClasses(slots, getLegendUtilityClass, classes);
+};
+export const piecewiseColorLegendClasses = generateUtilityClasses('MuiPiecewiseColorLegendClasses', ['root', 'minLabel', 'maxLabel', 'item', 'vertical', 'horizontal', 'start', 'end', 'extremes', 'mark', 'label']);

package/ChartsLegend/useAxis.d.ts

@@ -1,6 +1,6 @@
 import { AxisDefaultized } from '../models/axis';
 import { ZAxisDefaultized } from '../models/z-axis';
-import { ColorLegendSelector } from './legend.types';
+import { ColorLegendSelector } from './colorLegend.types';
 /**
  * Helper to select an axis definition according to its direction and id.
  */

package/ChartsLegend/useAxis.js

@@ -1,8 +1,7 @@
 'use client';
 
-import * as React from 'react';
-import { ZAxisContext } from "../context/ZAxisContextProvider.js";
-import { useCartesianContext } from "../context/CartesianProvider/useCartesianContext.js";
+import { useZAxes } from "../hooks/useZAxis.js";
+import { useXAxes, useYAxes } from "../hooks/useAxis.js";
 /**
  * Helper to select an axis definition according to its direction and id.
  */
@@ -12,14 +11,16 @@ export function useAxis({
 }) {
   const {
     xAxis,
-    xAxisIds,
+    xAxisIds
+  } = useXAxes();
+  const {
     yAxis,
     yAxisIds
-  } = useCartesianContext();
+  } = useYAxes();
   const {
     zAxis,
     zAxisIds
-  } = React.useContext(ZAxisContext);
+  } = useZAxes();
   switch (axisDirection) {
     case 'x':
       {

package/ChartsOnAxisClickHandler/ChartsOnAxisClickHandler.js

@@ -2,10 +2,9 @@
 
 import * as React from 'react';
 import PropTypes from 'prop-types';
-import { InteractionContext } from "../context/InteractionProvider.js";
 import { useSeries } from "../hooks/useSeries.js";
-import { useSvgRef } from "../hooks/index.js";
-import { useCartesianContext } from "../context/CartesianProvider/index.js";
+import { useSvgRef, useXAxes, useYAxes } from "../hooks/index.js";
+import { useStore } from "../internals/store/useStore.js";
 import { jsx as _jsx } from "react/jsx-runtime";
 function ChartsOnAxisClickHandler(props) {
   const {
@@ -13,15 +12,15 @@ function ChartsOnAxisClickHandler(props) {
   } = props;
   const svgRef = useSvgRef();
   const series = useSeries();
+  const store = useStore();
   const {
-    axis
-  } = React.useContext(InteractionContext);
-  const {
-    xAxisIds,
     xAxis,
-    yAxisIds,
-    yAxis
-  } = useCartesianContext();
+    xAxisIds
+  } = useXAxes();
+  const {
+    yAxis,
+    yAxisIds
+  } = useYAxes();
   React.useEffect(() => {
     const element = svgRef.current;
     if (element === null || !onAxisClick) {
@@ -29,9 +28,13 @@ function ChartsOnAxisClickHandler(props) {
     }
     const handleMouseClick = event => {
       event.preventDefault();
-      const isXaxis = axis.x && axis.x.index !== -1;
+      const {
+        x: axisX,
+        y: axisY
+      } = store.value.interaction.axis;
+      const isXaxis = axisX && axisX.index !== -1;
       const USED_AXIS_ID = isXaxis ? xAxisIds[0] : yAxisIds[0];
-      const dataIndex = isXaxis ? axis.x && axis.x.index : axis.y && axis.y.index;
+      const dataIndex = isXaxis ? axisX && axisX.index : axisY && axisY.index;
       if (dataIndex == null) {
         return;
       }
@@ -58,7 +61,7 @@ function ChartsOnAxisClickHandler(props) {
     return () => {
       element.removeEventListener('click', handleMouseClick);
     };
-  }, [axis.x, axis.y, onAxisClick, series, svgRef, xAxis, xAxisIds, yAxis, yAxisIds]);
+  }, [onAxisClick, series, store, svgRef, xAxis, xAxisIds, yAxis, yAxisIds]);
 
   // eslint-disable-next-line react/jsx-no-useless-fragment
   return /*#__PURE__*/_jsx(React.Fragment, {});

package/ChartsReferenceLine/ChartsXReferenceLine.d.ts

@@ -8,6 +8,6 @@ export type ChartsXReferenceLineProps<TValue extends string | number | Date = st
      */
     x: TValue;
 };
-export declare function getXReferenceLineClasses(classes?: Partial<ChartsReferenceLineClasses>): Record<"label" | "line" | "root", string>;
+export declare function getXReferenceLineClasses(classes?: Partial<ChartsReferenceLineClasses>): Record<"line" | "label" | "root", string>;
 declare function ChartsXReferenceLine(props: ChartsXReferenceLineProps): React.JSX.Element | null;
 export { ChartsXReferenceLine };

package/ChartsReferenceLine/ChartsYReferenceLine.d.ts

@@ -8,6 +8,6 @@ export type ChartsYReferenceLineProps<TValue extends string | number | Date = st
      */
     y: TValue;
 };
-export declare function getYReferenceLineClasses(classes?: Partial<ChartsReferenceLineClasses>): Record<"label" | "line" | "root", string>;
+export declare function getYReferenceLineClasses(classes?: Partial<ChartsReferenceLineClasses>): Record<"line" | "label" | "root", string>;
 declare function ChartsYReferenceLine(props: ChartsYReferenceLineProps): React.JSX.Element | null;
 export { ChartsYReferenceLine };

package/ChartsSurface/ChartsSurface.d.ts

@@ -1,21 +1,6 @@
 import { SxProps, Theme } from '@mui/material/styles';
 import * as React from 'react';
-type ViewBox = {
-    x?: number;
-    y?: number;
-    width?: number;
-    height?: number;
-};
 export interface ChartsSurfaceProps {
-    /**
-     * The width of the chart in px.
-     */
-    width: number;
-    /**
-     * The height of the chart in px.
-     */
-    height: number;
-    viewBox?: ViewBox;
     className?: string;
     title?: string;
     desc?: string;
@@ -28,5 +13,19 @@ export interface ChartsSurfaceProps {
      */
     disableAxisListener?: boolean;
 }
+/**
+ * It provides the drawing area for the chart elements.
+ * It is the root `<svg>` of all the chart elements.
+ *
+ * It also provides the `title` and `desc` elements for the chart.
+ *
+ * Demos:
+ *
+ * - [Composition](https://mui.com/x/api/charts/composition/)
+ *
+ * API:
+ *
+ * - [ChartsSurface API](https://mui.com/x/api/charts/charts-surface/)
+ */
 declare const ChartsSurface: React.ForwardRefExoticComponent<ChartsSurfaceProps & React.RefAttributes<SVGSVGElement>>;
 export { ChartsSurface };

package/ChartsSurface/ChartsSurface.js

@@ -2,55 +2,91 @@
 
 import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["children", "width", "height", "viewBox", "disableAxisListener", "className", "title", "desc"];
+const _excluded = ["children", "disableAxisListener", "className", "title", "desc"];
 import { styled, useThemeProps } from '@mui/material/styles';
 import PropTypes from 'prop-types';
 import * as React from 'react';
+import useForkRef from '@mui/utils/useForkRef';
 import { useAxisEvents } from "../hooks/useAxisEvents.js";
+import { ChartsAxesGradients } from "../internals/components/ChartsAxesGradients/index.js";
+import { useSvgRef } from "../hooks/useSvgRef.js";
+import { useSelector } from "../internals/store/useSelector.js";
+import { useStore } from "../internals/store/useStore.js";
+import { selectorChartContainerSize, selectorChartPropsSize } from "../internals/plugins/corePlugins/useChartDimensions/useChartDimensions.selectors.js";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-const ChartChartsSurfaceStyles = styled('svg', {
+const ChartsSurfaceStyles = styled('svg', {
   name: 'MuiChartsSurface',
   slot: 'Root'
-})(() => ({
+})(({
+  ownerState
+}) => ({
+  width: ownerState.width ?? '100%',
+  height: ownerState.height ?? '100%',
+  display: 'flex',
+  position: 'relative',
+  flexDirection: 'column',
+  alignItems: 'center',
+  justifyContent: 'center',
+  overflow: 'hidden',
   // This prevents default touch actions when using the svg on mobile devices.
   // For example, prevent page scroll & zoom.
   touchAction: 'none'
 }));
+
+/**
+ * It provides the drawing area for the chart elements.
+ * It is the root `<svg>` of all the chart elements.
+ *
+ * It also provides the `title` and `desc` elements for the chart.
+ *
+ * Demos:
+ *
+ * - [Composition](https://mui.com/x/api/charts/composition/)
+ *
+ * API:
+ *
+ * - [ChartsSurface API](https://mui.com/x/api/charts/charts-surface/)
+ */
 const ChartsSurface = /*#__PURE__*/React.forwardRef(function ChartsSurface(inProps, ref) {
-  const props = useThemeProps({
+  const store = useStore();
+  const {
+    width: svgWidth,
+    height: svgHeight
+  } = useSelector(store, selectorChartContainerSize);
+  const {
+    width: propsWidth,
+    height: propsHeight
+  } = useSelector(store, selectorChartPropsSize);
+  const svgRef = useSvgRef();
+  const handleRef = useForkRef(svgRef, ref);
+  const themeProps = useThemeProps({
     props: inProps,
     name: 'MuiChartsSurface'
   });
   const {
       children,
-      width,
-      height,
-      viewBox,
       disableAxisListener = false,
       className,
       title,
       desc
-    } = props,
-    other = _objectWithoutPropertiesLoose(props, _excluded);
-  const svgView = _extends({
-    width,
-    height,
-    x: 0,
-    y: 0
-  }, viewBox);
+    } = themeProps,
+    other = _objectWithoutPropertiesLoose(themeProps, _excluded);
+  const hasIntrinsicSize = svgHeight > 0 && svgWidth > 0;
   useAxisEvents(disableAxisListener);
-  return /*#__PURE__*/_jsxs(ChartChartsSurfaceStyles, _extends({
-    width: width,
-    height: height,
-    viewBox: `${svgView.x} ${svgView.y} ${svgView.width} ${svgView.height}`,
-    ref: ref,
+  return /*#__PURE__*/_jsxs(ChartsSurfaceStyles, _extends({
+    ownerState: {
+      width: propsWidth,
+      height: propsHeight
+    },
+    viewBox: `${0} ${0} ${svgWidth} ${svgHeight}`,
     className: className
   }, other, {
-    children: [/*#__PURE__*/_jsx("title", {
+    ref: handleRef,
+    children: [title && /*#__PURE__*/_jsx("title", {
       children: title
-    }), /*#__PURE__*/_jsx("desc", {
+    }), desc && /*#__PURE__*/_jsx("desc", {
       children: desc
-    }), children]
+    }), /*#__PURE__*/_jsx(ChartsAxesGradients, {}), hasIntrinsicSize && children]
   }));
 });
 process.env.NODE_ENV !== "production" ? ChartsSurface.propTypes = {
@@ -67,21 +103,7 @@ process.env.NODE_ENV !== "production" ? ChartsSurface.propTypes = {
    * @default false
    */
   disableAxisListener: PropTypes.bool,
-  /**
-   * The height of the chart in px.
-   */
-  height: PropTypes.number.isRequired,
   sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
-  title: PropTypes.string,
-  viewBox: PropTypes.shape({
-    height: PropTypes.number,
-    width: PropTypes.number,
-    x: PropTypes.number,
-    y: PropTypes.number
-  }),
-  /**
-   * The width of the chart in px.
-   */
-  width: PropTypes.number.isRequired
+  title: PropTypes.string
 } : void 0;
 export { ChartsSurface };

package/ChartsTooltip/ChartTooltip.types.d.ts

@@ -0,0 +1,15 @@
+import { ChartsTooltipProps } from './ChartsTooltip';
+export interface ChartsTooltipSlots {
+    /**
+     * Custom component for the tooltip popper.
+     * @default ChartsTooltipRoot
+     */
+    tooltip?: React.ElementType<ChartsTooltipProps>;
+}
+export interface ChartsTooltipSlotProps {
+    /**
+     * Custom component for the tooltip popper.
+     * @default ChartsTooltipRoot
+     */
+    tooltip?: Partial<ChartsTooltipProps>;
+}

package/ChartsTooltip/ChartsAxisTooltipContent.d.ts

@@ -1,47 +1,15 @@
 import * as React from 'react';
 import { SxProps, Theme } from '@mui/material/styles';
-import { AxisInteractionData } from '../context/InteractionProvider';
-import { ChartSeriesDefaultized, ChartSeriesType } from '../models/seriesType/config';
-import { AxisDefaultized } from '../models/axis';
 import { ChartsTooltipClasses } from './chartsTooltipClasses';
-type ChartSeriesDefaultizedWithColorGetter = ChartSeriesDefaultized<ChartSeriesType> & {
-    getColor: (dataIndex: number) => string;
-};
-export type ChartsAxisContentProps = {
-    /**
-     * Data identifying the triggered axis.
-     */
-    axisData: AxisInteractionData;
-    /**
-     * The series linked to the triggered axis.
-     */
-    series: ChartSeriesDefaultizedWithColorGetter[];
-    /**
-     * The properties of the triggered axis.
-     */
-    axis: AxisDefaultized;
-    /**
-     * The index of the data item triggered.
-     */
-    dataIndex?: null | number;
-    /**
-     * The value associated to the current mouse position.
-     */
-    axisValue: string | number | Date | null;
+export interface ChartsAxisTooltipContentProps {
     /**
      * Override or extend the styles applied to the component.
      */
-    classes: ChartsTooltipClasses;
-    sx?: SxProps<Theme>;
-};
-/**
- * @ignore - internal component.
- */
-declare function ChartsAxisTooltipContent(props: {
-    axisData: AxisInteractionData;
-    content?: React.ElementType<ChartsAxisContentProps>;
-    contentProps?: Partial<ChartsAxisContentProps>;
+    classes?: Partial<ChartsTooltipClasses>;
     sx?: SxProps<Theme>;
-    classes: ChartsAxisContentProps['classes'];
-}): React.JSX.Element;
+}
+declare function ChartsAxisTooltipContent(props: ChartsAxisTooltipContentProps): React.JSX.Element | null;
+declare namespace ChartsAxisTooltipContent {
+    var propTypes: any;
+}
 export { ChartsAxisTooltipContent };