@mui/x-charts 8.0.0-alpha.5 → 8.0.0-alpha.7

package/ChartsLegend/DefaultChartsLegend.js

@@ -1,112 +0,0 @@
-'use client';
-
-import _extends from "@babel/runtime/helpers/esm/extends";
-import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["seriesToDisplay", "hidden", "onItemClick"];
-import * as React from 'react';
-import PropTypes from 'prop-types';
-import { LegendPerItem } from "./LegendPerItem.js";
-import { jsx as _jsx } from "react/jsx-runtime";
-const seriesContextBuilder = context => ({
-  type: 'series',
-  color: context.color,
-  label: context.label,
-  seriesId: context.seriesId,
-  itemId: context.itemId
-});
-function DefaultChartsLegend(props) {
-  const {
-      seriesToDisplay,
-      hidden,
-      onItemClick
-    } = props,
-    other = _objectWithoutPropertiesLoose(props, _excluded);
-  if (hidden) {
-    return null;
-  }
-  return /*#__PURE__*/_jsx(LegendPerItem, _extends({}, other, {
-    itemsToDisplay: seriesToDisplay,
-    onItemClick: onItemClick ? (event, i) => onItemClick(event, seriesContextBuilder(seriesToDisplay[i]), i) : undefined
-  }));
-}
-process.env.NODE_ENV !== "production" ? DefaultChartsLegend.propTypes = {
-  // ----------------------------- Warning --------------------------------
-  // | These PropTypes are generated from the TypeScript type definitions |
-  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
-  // ----------------------------------------------------------------------
-  /**
-   * Override or extend the styles applied to the component.
-   */
-  classes: PropTypes.object,
-  /**
-   * The direction of the legend layout.
-   * The default depends on the chart.
-   */
-  direction: PropTypes.oneOf(['column', 'row']).isRequired,
-  /**
-   * Set to true to hide the legend.
-   * @default false
-   */
-  hidden: PropTypes.bool,
-  /**
-   * Space between two legend items (in px).
-   * @default 10
-   */
-  itemGap: PropTypes.number,
-  /**
-   * Height of the item mark (in px).
-   * @default 20
-   */
-  itemMarkHeight: PropTypes.number,
-  /**
-   * Width of the item mark (in px).
-   * @default 20
-   */
-  itemMarkWidth: PropTypes.number,
-  /**
-   * Style applied to legend labels.
-   * @default theme.typography.subtitle1
-   */
-  labelStyle: PropTypes.object,
-  /**
-   * Space between the mark and the label (in px).
-   * @default 5
-   */
-  markGap: PropTypes.number,
-  /**
-   * Callback fired when a legend item is clicked.
-   * @param {React.MouseEvent<SVGRectElement, MouseEvent>} event The click event.
-   * @param {SeriesLegendItemContext} legendItem The legend item data.
-   * @param {number} index The index of the clicked legend item.
-   */
-  onItemClick: PropTypes.func,
-  /**
-   * Legend padding (in px).
-   * Can either be a single number, or an object with top, left, bottom, right properties.
-   * @default 10
-   */
-  padding: PropTypes.oneOfType([PropTypes.number, PropTypes.shape({
-    bottom: PropTypes.number,
-    left: PropTypes.number,
-    right: PropTypes.number,
-    top: PropTypes.number
-  })]),
-  /**
-   * The position of the legend.
-   */
-  position: PropTypes.shape({
-    horizontal: PropTypes.oneOf(['left', 'middle', 'right']).isRequired,
-    vertical: PropTypes.oneOf(['bottom', 'middle', 'top']).isRequired
-  }).isRequired,
-  series: PropTypes.object.isRequired,
-  seriesToDisplay: PropTypes.arrayOf(PropTypes.shape({
-    color: PropTypes.string.isRequired,
-    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]).isRequired,
-    itemId: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-    label: PropTypes.string.isRequired,
-    maxValue: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-    minValue: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-    seriesId: PropTypes.oneOfType([PropTypes.number, PropTypes.string])
-  })).isRequired
-} : void 0;
-export { DefaultChartsLegend };

package/ChartsLegend/LegendPerItem.d.ts

@@ -1,65 +0,0 @@
-import * as React from 'react';
-import { DefaultizedProps } from '@mui/x-internals/types';
-import { DrawingAreaState } from '../context/DrawingAreaProvider';
-import { ChartsTextStyle } from '../ChartsText';
-import { CardinalDirections } from '../models/layout';
-import { LegendItemParams } from './chartsLegend.types';
-import { AnchorPosition, Direction, LegendPlacement } from './legend.types';
-import { ChartsLegendClasses } from './chartsLegendClasses';
-export type ChartsLegendRootOwnerState = {
-    position: AnchorPosition;
-    direction: Direction;
-    drawingArea: DrawingAreaState;
-    offsetX?: number;
-    offsetY?: number;
-    seriesNumber: number;
-};
-export declare const ChartsLegendRoot: import("@emotion/styled").StyledComponent<import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme>, Pick<React.SVGProps<SVGGElement>, keyof React.SVGProps<SVGGElement>>, {}>;
-export interface LegendPerItemProps extends DefaultizedProps<LegendPlacement, keyof LegendPlacement> {
-    /**
-     * The ordered array of item to display in the legend.
-     */
-    itemsToDisplay: LegendItemParams[];
-    /**
-     * Override or extend the styles applied to the component.
-     */
-    classes?: Partial<ChartsLegendClasses>;
-    /**
-     * Style applied to legend labels.
-     * @default theme.typography.subtitle1
-     */
-    labelStyle?: ChartsTextStyle;
-    /**
-     * Width of the item mark (in px).
-     * @default 20
-     */
-    itemMarkWidth?: number;
-    /**
-     * Height of the item mark (in px).
-     * @default 20
-     */
-    itemMarkHeight?: number;
-    /**
-     * Space between the mark and the label (in px).
-     * @default 5
-     */
-    markGap?: number;
-    /**
-     * Space between two legend items (in px).
-     * @default 10
-     */
-    itemGap?: number;
-    /**
-     * Legend padding (in px).
-     * Can either be a single number, or an object with top, left, bottom, right properties.
-     * @default 10
-     */
-    padding?: number | Partial<CardinalDirections<number>>;
-    onItemClick?: (event: React.MouseEvent<SVGRectElement, MouseEvent>, index: number) => void;
-}
-/**
- * Internal component to display an array of items as a legend.
- * Used for series legend, and threshold color legend.
- * @ignore - Do not document
- */
-export declare function LegendPerItem(props: LegendPerItemProps): React.JSX.Element;

package/ChartsLegend/LegendPerItem.js

@@ -1,129 +0,0 @@
-'use client';
-
-import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-import _extends from "@babel/runtime/helpers/esm/extends";
-const _excluded = ["rotate", "dominantBaseline"];
-import * as React from 'react';
-import NoSsr from '@mui/material/NoSsr';
-import { useTheme, styled } from '@mui/material/styles';
-import { getWordsByLines } from "../internals/getWordsByLines.js";
-import { legendItemPlacements } from "./legendItemsPlacement.js";
-import { useDrawingArea } from "../hooks/useDrawingArea.js";
-import { ChartsLegendItem } from "./ChartsLegendItem.js";
-import { createElement as _createElement } from "react";
-import { jsx as _jsx } from "react/jsx-runtime";
-export const ChartsLegendRoot = styled('g', {
-  name: 'MuiChartsLegend',
-  slot: 'Root',
-  overridesResolver: (props, styles) => styles.root
-})({});
-/**
- * Transforms number or partial padding object to a defaultized padding object.
- */
-const getStandardizedPadding = padding => {
-  if (typeof padding === 'number') {
-    return {
-      left: padding,
-      right: padding,
-      top: padding,
-      bottom: padding
-    };
-  }
-  return _extends({
-    left: 0,
-    right: 0,
-    top: 0,
-    bottom: 0
-  }, padding);
-};
-
-/**
- * Internal component to display an array of items as a legend.
- * Used for series legend, and threshold color legend.
- * @ignore - Do not document
- */
-export function LegendPerItem(props) {
-  const {
-    position,
-    direction,
-    itemsToDisplay,
-    classes,
-    itemMarkWidth = 20,
-    itemMarkHeight = 20,
-    markGap = 5,
-    itemGap = 10,
-    padding: paddingProps = 10,
-    labelStyle: inLabelStyle,
-    onItemClick
-  } = props;
-  const theme = useTheme();
-  const drawingArea = useDrawingArea();
-  const labelStyle = React.useMemo(() => _extends({}, theme.typography.subtitle1, {
-    color: 'inherit',
-    dominantBaseline: 'central',
-    textAnchor: 'start',
-    fill: (theme.vars || theme).palette.text.primary,
-    lineHeight: 1
-  }, inLabelStyle),
-  // To say to TS that the dominantBaseline and textAnchor are correct
-  [inLabelStyle, theme]);
-  const padding = React.useMemo(() => getStandardizedPadding(paddingProps), [paddingProps]);
-  const getItemSpace = React.useCallback((label, inStyle = {}) => {
-    const style = _objectWithoutPropertiesLoose(inStyle, _excluded);
-    const linesSize = getWordsByLines({
-      style,
-      needsComputation: true,
-      text: label
-    });
-    const innerSize = {
-      innerWidth: itemMarkWidth + markGap + Math.max(...linesSize.map(size => size.width)),
-      innerHeight: Math.max(itemMarkHeight, linesSize.length * linesSize[0].height)
-    };
-    return _extends({}, innerSize, {
-      outerWidth: innerSize.innerWidth + itemGap,
-      outerHeight: innerSize.innerHeight + itemGap
-    });
-  }, [itemGap, itemMarkHeight, itemMarkWidth, markGap]);
-  const totalWidth = drawingArea.left + drawingArea.width + drawingArea.right;
-  const totalHeight = drawingArea.top + drawingArea.height + drawingArea.bottom;
-  const availableWidth = totalWidth - padding.left - padding.right;
-  const availableHeight = totalHeight - padding.top - padding.bottom;
-  const [itemsWithPosition, legendWidth, legendHeight] = React.useMemo(() => legendItemPlacements(itemsToDisplay, getItemSpace, labelStyle, direction, availableWidth, availableHeight, itemGap), [itemsToDisplay, getItemSpace, labelStyle, direction, availableWidth, availableHeight, itemGap]);
-  const gapX = React.useMemo(() => {
-    switch (position.horizontal) {
-      case 'left':
-        return padding.left;
-      case 'right':
-        return totalWidth - padding.right - legendWidth;
-      default:
-        return (totalWidth - legendWidth) / 2;
-    }
-  }, [position.horizontal, padding.left, padding.right, totalWidth, legendWidth]);
-  const gapY = React.useMemo(() => {
-    switch (position.vertical) {
-      case 'top':
-        return padding.top;
-      case 'bottom':
-        return totalHeight - padding.bottom - legendHeight;
-      default:
-        return (totalHeight - legendHeight) / 2;
-    }
-  }, [position.vertical, padding.top, padding.bottom, totalHeight, legendHeight]);
-  return /*#__PURE__*/_jsx(NoSsr, {
-    children: /*#__PURE__*/_jsx(ChartsLegendRoot, {
-      className: classes?.root,
-      children: itemsWithPosition.map((item, i) => /*#__PURE__*/_createElement(ChartsLegendItem, _extends({}, item, {
-        key: item.id,
-        gapX: gapX,
-        gapY: gapY,
-        legendWidth: legendWidth,
-        itemMarkHeight: itemMarkHeight,
-        itemMarkWidth: itemMarkWidth,
-        markGap: markGap,
-        labelStyle: labelStyle,
-        classes: classes,
-        onClick: onItemClick ? event => onItemClick(event, i) : undefined
-      })))
-    })
-  });
-}

package/ChartsLegend/legendItemsPlacement.d.ts

@@ -1,3 +0,0 @@
-import { ChartsTextStyle } from '../ChartsText';
-import { GetItemSpaceType, LegendItemParams, LegendItemWithPosition } from './chartsLegend.types';
-export declare function legendItemPlacements(itemsToDisplay: LegendItemParams[], getItemSpace: GetItemSpaceType, labelStyle: ChartsTextStyle, direction: string, availableWidth: number, availableHeight: number, itemGap: number): [LegendItemWithPosition[], number, number];

package/ChartsLegend/legendItemsPlacement.js

@@ -1,72 +0,0 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
-import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["label"];
-export function legendItemPlacements(itemsToDisplay, getItemSpace, labelStyle, direction, availableWidth, availableHeight, itemGap) {
-  // Start at 0, 0. Will be modified later by padding and position.
-  let x = 0;
-  let y = 0;
-
-  // total values used to align legend later.
-  let totalWidthUsed = 0;
-  let totalHeightUsed = 0;
-  let rowIndex = 0;
-  const rowMaxHeight = [0];
-  const seriesWithRawPosition = itemsToDisplay.map(_ref => {
-    let {
-        label
-      } = _ref,
-      other = _objectWithoutPropertiesLoose(_ref, _excluded);
-    const itemSpace = getItemSpace(label, labelStyle);
-    const rep = _extends({}, other, {
-      label,
-      positionX: x,
-      positionY: y,
-      innerHeight: itemSpace.innerHeight,
-      innerWidth: itemSpace.innerWidth,
-      outerHeight: itemSpace.outerHeight,
-      outerWidth: itemSpace.outerWidth,
-      rowIndex
-    });
-    if (direction === 'row') {
-      if (x + itemSpace.innerWidth > availableWidth) {
-        // This legend item would create overflow along the x-axis, so we start a new row.
-        x = 0;
-        y += rowMaxHeight[rowIndex];
-        rowIndex += 1;
-        if (rowMaxHeight.length <= rowIndex) {
-          rowMaxHeight.push(0);
-        }
-        rep.positionX = x;
-        rep.positionY = y;
-        rep.rowIndex = rowIndex;
-      }
-      totalWidthUsed = Math.max(totalWidthUsed, x + itemSpace.outerWidth);
-      totalHeightUsed = Math.max(totalHeightUsed, y + itemSpace.outerHeight);
-      rowMaxHeight[rowIndex] = Math.max(rowMaxHeight[rowIndex], itemSpace.outerHeight);
-      x += itemSpace.outerWidth;
-    }
-    if (direction === 'column') {
-      if (y + itemSpace.innerHeight > availableHeight) {
-        // This legend item would create overflow along the y-axis, so we start a new column.
-        x = totalWidthUsed + itemGap;
-        y = 0;
-        rowIndex = 0;
-        rep.positionX = x;
-        rep.positionY = y;
-        rep.rowIndex = rowIndex;
-      }
-      if (rowMaxHeight.length <= rowIndex) {
-        rowMaxHeight.push(0);
-      }
-      totalWidthUsed = Math.max(totalWidthUsed, x + itemSpace.outerWidth);
-      totalHeightUsed = Math.max(totalHeightUsed, y + itemSpace.outerHeight);
-      rowIndex += 1;
-      y += itemSpace.outerHeight;
-    }
-    return rep;
-  });
-  return [seriesWithRawPosition.map(item => _extends({}, item, {
-    positionY: item.positionY + (direction === 'row' ? rowMaxHeight[item.rowIndex] / 2 // Get the center of the entire row
-    : item.outerHeight / 2) // Get the center of the item
-  })), totalWidthUsed, totalHeightUsed];
-}

package/ChartsLegend/utils.d.ts

@@ -1,2 +0,0 @@
-import { FormattedSeries } from '../context/SeriesProvider';
-export declare function getSeriesToDisplay(series: FormattedSeries): import("./chartsLegend.types").LegendItemParams[];

package/modern/ChartsLegend/ChartsLegendItem.js

@@ -1,65 +0,0 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
-import * as React from 'react';
-import clsx from 'clsx';
-import { useRtl } from '@mui/system/RtlProvider';
-import { ChartsText } from "../ChartsText/index.js";
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-/**
- * @ignore - internal component.
- */
-function ChartsLegendItem(props) {
-  const isRTL = useRtl();
-  const {
-    id,
-    positionY,
-    label,
-    positionX,
-    innerHeight,
-    innerWidth,
-    legendWidth,
-    color,
-    gapX,
-    gapY,
-    itemMarkHeight,
-    itemMarkWidth,
-    markGap,
-    labelStyle,
-    classes,
-    onClick
-  } = props;
-  return /*#__PURE__*/_jsxs("g", {
-    className: clsx(classes?.series, `${classes?.series}-${id}`),
-    transform: `translate(${gapX + (isRTL ? legendWidth - positionX : positionX)} ${gapY + positionY})`,
-    children: [/*#__PURE__*/_jsx("rect", {
-      x: isRTL ? -(innerWidth + 2) : -2,
-      y: -itemMarkHeight / 2 - 2,
-      width: innerWidth + 4,
-      height: innerHeight + 4,
-      fill: "transparent",
-      className: classes?.itemBackground,
-      onClick: onClick,
-      style: {
-        pointerEvents: onClick ? 'all' : 'none',
-        cursor: onClick ? 'pointer' : 'unset'
-      }
-    }), /*#__PURE__*/_jsx("rect", {
-      className: classes?.mark,
-      x: isRTL ? -itemMarkWidth : 0,
-      y: -itemMarkHeight / 2,
-      width: itemMarkWidth,
-      height: itemMarkHeight,
-      fill: color,
-      style: {
-        pointerEvents: 'none'
-      }
-    }), /*#__PURE__*/_jsx(ChartsText, {
-      style: _extends({
-        pointerEvents: 'none'
-      }, labelStyle),
-      text: label,
-      x: (isRTL ? -1 : 1) * (itemMarkWidth + markGap),
-      y: 0
-    })]
-  });
-}
-export { ChartsLegendItem };

package/modern/ChartsLegend/DefaultChartsLegend.js

@@ -1,112 +0,0 @@
-'use client';
-
-import _extends from "@babel/runtime/helpers/esm/extends";
-import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["seriesToDisplay", "hidden", "onItemClick"];
-import * as React from 'react';
-import PropTypes from 'prop-types';
-import { LegendPerItem } from "./LegendPerItem.js";
-import { jsx as _jsx } from "react/jsx-runtime";
-const seriesContextBuilder = context => ({
-  type: 'series',
-  color: context.color,
-  label: context.label,
-  seriesId: context.seriesId,
-  itemId: context.itemId
-});
-function DefaultChartsLegend(props) {
-  const {
-      seriesToDisplay,
-      hidden,
-      onItemClick
-    } = props,
-    other = _objectWithoutPropertiesLoose(props, _excluded);
-  if (hidden) {
-    return null;
-  }
-  return /*#__PURE__*/_jsx(LegendPerItem, _extends({}, other, {
-    itemsToDisplay: seriesToDisplay,
-    onItemClick: onItemClick ? (event, i) => onItemClick(event, seriesContextBuilder(seriesToDisplay[i]), i) : undefined
-  }));
-}
-process.env.NODE_ENV !== "production" ? DefaultChartsLegend.propTypes = {
-  // ----------------------------- Warning --------------------------------
-  // | These PropTypes are generated from the TypeScript type definitions |
-  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
-  // ----------------------------------------------------------------------
-  /**
-   * Override or extend the styles applied to the component.
-   */
-  classes: PropTypes.object,
-  /**
-   * The direction of the legend layout.
-   * The default depends on the chart.
-   */
-  direction: PropTypes.oneOf(['column', 'row']).isRequired,
-  /**
-   * Set to true to hide the legend.
-   * @default false
-   */
-  hidden: PropTypes.bool,
-  /**
-   * Space between two legend items (in px).
-   * @default 10
-   */
-  itemGap: PropTypes.number,
-  /**
-   * Height of the item mark (in px).
-   * @default 20
-   */
-  itemMarkHeight: PropTypes.number,
-  /**
-   * Width of the item mark (in px).
-   * @default 20
-   */
-  itemMarkWidth: PropTypes.number,
-  /**
-   * Style applied to legend labels.
-   * @default theme.typography.subtitle1
-   */
-  labelStyle: PropTypes.object,
-  /**
-   * Space between the mark and the label (in px).
-   * @default 5
-   */
-  markGap: PropTypes.number,
-  /**
-   * Callback fired when a legend item is clicked.
-   * @param {React.MouseEvent<SVGRectElement, MouseEvent>} event The click event.
-   * @param {SeriesLegendItemContext} legendItem The legend item data.
-   * @param {number} index The index of the clicked legend item.
-   */
-  onItemClick: PropTypes.func,
-  /**
-   * Legend padding (in px).
-   * Can either be a single number, or an object with top, left, bottom, right properties.
-   * @default 10
-   */
-  padding: PropTypes.oneOfType([PropTypes.number, PropTypes.shape({
-    bottom: PropTypes.number,
-    left: PropTypes.number,
-    right: PropTypes.number,
-    top: PropTypes.number
-  })]),
-  /**
-   * The position of the legend.
-   */
-  position: PropTypes.shape({
-    horizontal: PropTypes.oneOf(['left', 'middle', 'right']).isRequired,
-    vertical: PropTypes.oneOf(['bottom', 'middle', 'top']).isRequired
-  }).isRequired,
-  series: PropTypes.object.isRequired,
-  seriesToDisplay: PropTypes.arrayOf(PropTypes.shape({
-    color: PropTypes.string.isRequired,
-    id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]).isRequired,
-    itemId: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-    label: PropTypes.string.isRequired,
-    maxValue: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-    minValue: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
-    seriesId: PropTypes.oneOfType([PropTypes.number, PropTypes.string])
-  })).isRequired
-} : void 0;
-export { DefaultChartsLegend };