@mui/x-charts 6.0.0-alpha.1 → 6.0.0-alpha.2

package/legacy/internals/defaultizeColor.js

@@ -2,6 +2,15 @@ import _extends from "@babel/runtime/helpers/esm/extends";
 var DEFAULT_COLORS = ['#1f77b4', '#ff7f0e', '#2ca02c', '#d62728', '#9467bd', '#8c564b', '#e377c2', '#7f7f7f', '#bcbd22', '#17becf'];
 export function defaultizeColor(series, seriesIndex) {
   var colors = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_COLORS;
+  if (series.type === 'pie') {
+    return _extends({}, series, {
+      data: series.data.map(function (d, index) {
+        return _extends({
+          color: colors[index % colors.length]
+        }, d);
+      })
+    });
+  }
   return _extends({
     color: colors[seriesIndex % colors.length]
   }, series);

package/legacy/models/seriesType/index.js

@@ -1,12 +1,5 @@
-// import { PieSeriesType } from './pie';
-
-// | PieSeriesType;
-
-// | PieSeriesType;
-
-// | PieSeriesType
-
 export * from './line';
 export * from './bar';
 export * from './scatter';
+export * from './pie';
 export {};

package/models/seriesType/bar.d.ts

@@ -14,5 +14,5 @@ export type BarItemIdentifier = {
     seriesId: DefaultizedBarSeriesType['id'];
     dataIndex: number;
 };
-export interface DefaultizedBarSeriesType extends DefaultizedProps<BarSeriesType, CommonDefaultizedProps> {
+export interface DefaultizedBarSeriesType extends DefaultizedProps<BarSeriesType, CommonDefaultizedProps | 'color'> {
 }

package/models/seriesType/common.d.ts

@@ -11,7 +11,7 @@ export type CommonSeriesType<TValue> = {
     valueFormatter?: (value: TValue) => string;
     highlightScope?: Partial<HighlightScope>;
 };
-export type CommonDefaultizedProps = 'id' | 'color' | 'valueFormatter';
+export type CommonDefaultizedProps = 'id' | 'valueFormatter';
 export type CartesianSeriesType = {
     xAxisKey?: string;
     yAxisKey?: string;

package/models/seriesType/config.d.ts

@@ -1,8 +1,9 @@
 import { ScatterSeriesType, DefaultizedScatterSeriesType, ScatterItemIdentifier } from './scatter';
 import { LineSeriesType, DefaultizedLineSeriesType, LineItemIdentifier } from './line';
 import { BarItemIdentifier, BarSeriesType, DefaultizedBarSeriesType } from './bar';
+import { PieSeriesType, DefaultizedPieSeriesType, PieItemIdentifier, PieValueType } from './pie';
 import { AxisConfig } from '../axis';
-import { DefaultizedProps } from '../helpers';
+import { DefaultizedProps, MakeOptional } from '../helpers';
 import { StackingGroupsType } from '../../internals/stackSeries';
 interface ChartsSeriesConfig {
     bar: {
@@ -28,8 +29,18 @@ interface ChartsSeriesConfig {
         series: DefaultizedScatterSeriesType;
         itemIdentifier: ScatterItemIdentifier;
     };
+    pie: {
+        seriesInput: Omit<DefaultizedProps<PieSeriesType, 'id'>, 'data'> & {
+            data: (MakeOptional<PieValueType, 'id'> & {
+                color: string;
+            })[];
+        };
+        series: DefaultizedPieSeriesType;
+        itemIdentifier: PieItemIdentifier;
+    };
 }
-export type ChartSeriesType = 'bar' | 'line' | 'scatter';
+export type CartesianChartSeriesType = 'bar' | 'line' | 'scatter';
+export type ChartSeriesType = 'bar' | 'line' | 'scatter' | 'pie';
 export type ChartSeries<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends {
     canBeStacked: true;
 } ? ChartsSeriesConfig[T]['seriesInput'] & {
@@ -63,4 +74,20 @@ export type FormatterResult<T extends ChartSeriesType> = {
     stackingGroups: StackingGroupsType;
 } : {});
 export type Formatter<T extends ChartSeriesType> = (params: FormatterParams<T>) => FormatterResult<T>;
+export type LegendParams = {
+    /**
+     * The color used in the legend
+     */
+    color: string;
+    /**
+     * The label displayed in the legend
+     */
+    label: string;
+    /**
+     * The identifier of the legend element.
+     * Used for internal purpose such as `key` props
+     */
+    id: string;
+};
+export type LegendGetter<T extends ChartSeriesType> = (series: FormatterResult<T>) => LegendParams[];
 export {};

package/models/seriesType/index.d.ts

@@ -1,13 +1,17 @@
 import { BarItemIdentifier, BarSeriesType, DefaultizedBarSeriesType } from './bar';
 import { DefaultizedLineSeriesType, LineItemIdentifier, LineSeriesType } from './line';
 import { DefaultizedScatterSeriesType, ScatterItemIdentifier, ScatterSeriesType } from './scatter';
-type AllSeriesType = BarSeriesType | LineSeriesType | ScatterSeriesType;
+import { DefaultizedPieSeriesType, PieSeriesType, PieItemIdentifier, PieValueType } from './pie';
+import { MakeOptional } from '../helpers';
+type AllSeriesType = BarSeriesType | LineSeriesType | ScatterSeriesType | PieSeriesType<MakeOptional<PieValueType, 'id'>>;
 type CartesianSeriesType = BarSeriesType | LineSeriesType | ScatterSeriesType;
 type DefaultizedCartesianSeriesType = DefaultizedBarSeriesType | DefaultizedLineSeriesType | DefaultizedScatterSeriesType;
+type DefaultizedSeriesType = DefaultizedCartesianSeriesType | DefaultizedPieSeriesType;
 type StackableSeriesType = DefaultizedBarSeriesType | DefaultizedLineSeriesType;
-export type SeriesItemIdentifier = BarItemIdentifier | LineItemIdentifier | ScatterItemIdentifier;
+export type SeriesItemIdentifier = BarItemIdentifier | LineItemIdentifier | ScatterItemIdentifier | PieItemIdentifier;
 export * from './line';
 export * from './bar';
 export * from './scatter';
+export * from './pie';
 export type { StackOrderType, StackOffsetType } from './common';
-export type { AllSeriesType, CartesianSeriesType, DefaultizedCartesianSeriesType, StackableSeriesType, };
+export type { AllSeriesType, CartesianSeriesType, DefaultizedSeriesType, DefaultizedCartesianSeriesType, StackableSeriesType, };

package/models/seriesType/index.js

@@ -35,4 +35,15 @@ Object.keys(_scatter).forEach(function (key) {
       return _scatter[key];
     }
   });
+});
+var _pie = require("./pie");
+Object.keys(_pie).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _pie[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _pie[key];
+    }
+  });
 });

package/models/seriesType/line.d.ts

@@ -21,5 +21,5 @@ export type LineItemIdentifier = {
      */
     dataIndex?: number;
 };
-export interface DefaultizedLineSeriesType extends DefaultizedProps<LineSeriesType, CommonDefaultizedProps> {
+export interface DefaultizedLineSeriesType extends DefaultizedProps<LineSeriesType, CommonDefaultizedProps | 'color'> {
 }

package/models/seriesType/pie.d.ts

@@ -1,5 +1,105 @@
-import { CartesianSeriesType, CommonSeriesType } from './common';
-export interface PieSeriesType extends CommonSeriesType<number>, CartesianSeriesType {
+import { PieArcDatum as D3PieArcDatum } from 'd3-shape';
+import { DefaultizedProps } from '../helpers';
+import { CommonDefaultizedProps, CommonSeriesType } from './common';
+export type PieValueType = {
+    id: string | number;
+    value: number;
+    label?: string;
+    color?: string;
+};
+export type DefaultizedPieValueType = PieValueType & D3PieArcDatum<any> & {
+    color: string;
+    formattedValue: string;
+};
+export type ChartsPieSorting = 'none' | 'asc' | 'desc' | ((a: number, b: number) => number);
+export interface PieSeriesType<Tdata = PieValueType> extends CommonSeriesType<Tdata> {
     type: 'pie';
-    data: number[];
+    data: Tdata[];
+    /**
+     * The radius between circle center and the begining of the arc.
+     * @default 0
+     */
+    innerRadius?: number;
+    /**
+     * The radius between circle center and the end of the arc.
+     * @default R_max The maximal radius that fit into the drawing area.
+     */
+    outerRadius?: number;
+    /**
+     * The radius applied to arc corners (similar to border radius).
+     * @default 0
+     */
+    cornerRadius?: number;
+    /**
+     * The start angle (deg) of the first item.
+     * @default 0
+     */
+    startAngle?: number;
+    /**
+     * The end angle (deg) of the last item.
+     * @default 360
+     */
+    endAngle?: number;
+    /**
+     * The padding angle (deg) between two arcs.
+     * @default 0
+     */
+    paddingAngle?: number;
+    sortingValues?: ChartsPieSorting;
+    /**
+     * The label displayed into the arc.
+     */
+    arcLabel?: 'formattedValue' | 'label' | 'value' | ((item: DefaultizedPieValueType) => string);
+    /**
+     * The minimal angle required to display the arc label.
+     */
+    arcLabelMinAngle?: number;
+    /**
+     * The x coordinate of the pie center.
+     * @default width/2 the center of the drawing area.
+     */
+    cx?: number;
+    /**
+     * The y coordinate of the pie center.
+     * @default height/2 the center of the drawing area.
+     */
+    cy?: number;
+    /**
+     * Override the arc attibutes when it is highlighted.
+     */
+    highlighted?: {
+        /**
+         * Value added to the default `outerRadius`.
+         * Can be negative. ANd is ignored if you provide a `highlighted.outerRadius` value.
+         */
+        additionalRadius?: number;
+        innerRadius?: number;
+        outerRadius?: number;
+        cornerRadius?: number;
+    };
+    /**
+     * Override the arc attibutes when it is faded.
+     */
+    faded?: {
+        /**
+         * Value added to the default `outerRadius`.
+         * Can be negative. ANd is ignored if you provide a `faded.outerRadius` value.
+         */
+        additionalRadius?: number;
+        innerRadius?: number;
+        outerRadius?: number;
+        cornerRadius?: number;
+    };
+}
+/**
+ * An object that allows to identify a single pie slice.
+ * Used for item interaction
+ */
+export type PieItemIdentifier = {
+    type: 'pie';
+    seriesId: DefaultizedPieSeriesType['id'];
+    dataIndex: number;
+};
+export interface DefaultizedPieSeriesType extends DefaultizedProps<PieSeriesType, CommonDefaultizedProps> {
+    data: DefaultizedPieValueType[];
 }

package/models/seriesType/scatter.d.ts

@@ -12,7 +12,7 @@ export interface ScatterSeriesType extends CommonSeriesType<ScatterValueType>, C
     label?: string;
 }
 /**
- * An object that allows to identify a single line.
+ * An object that allows to identify a single scatter item.
  * Used for item interaction
  */
 export type ScatterItemIdentifier = {

package/modern/BarChart/BarChart.js

@@ -123,6 +123,7 @@ process.env.NODE_ENV !== "production" ? BarChart.propTypes = {
   legend: PropTypes.shape({
     classes: PropTypes.object,
     direction: PropTypes.oneOf(['column', 'row']),
+    hidden: PropTypes.bool,
     itemWidth: PropTypes.number,
     markSize: PropTypes.number,
     offset: PropTypes.shape({

package/modern/BarChart/legend.js

@@ -0,0 +1,13 @@
+const legendGetter = params => {
+  const {
+    seriesOrder,
+    series
+  } = params;
+  const data = seriesOrder.map(seriesId => ({
+    color: series[seriesId].color,
+    label: series[seriesId].label,
+    id: seriesId
+  }));
+  return data.filter(item => item.label !== undefined);
+};
+export default legendGetter;

package/modern/ChartsLegend/ChartsLegend.js

@@ -146,7 +146,8 @@ export function ChartsLegend(inProps) {
   const {
     position,
     direction,
-    offset
+    offset,
+    hidden
   } = props;
   const theme = useTheme();
   const classes = useUtilityClasses(_extends({}, props, {
@@ -154,6 +155,9 @@ export function ChartsLegend(inProps) {
   }));
   const drawingArea = React.useContext(DrawingContext);
   const series = React.useContext(SeriesContext);
+  if (hidden) {
+    return null;
+  }
   const seriesToDisplay = getSeriesToDisplay(series);
   return /*#__PURE__*/_jsx(ChartsLegendRoot, {
     ownerState: {

package/modern/ChartsLegend/utils.js

@@ -1,3 +1,13 @@
+import getBarLegend from '../BarChart/legend';
+import getScatterLegend from '../ScatterChart/legend';
+import getLineLegend from '../LineChart/legend';
+import getPieLegend from '../PieChart/legend';
+const legendGetter = {
+  bar: getBarLegend,
+  scatter: getScatterLegend,
+  line: getLineLegend,
+  pie: getPieLegend
+};
 export function getSeriesToDisplay(series) {
-  return Object.values(series).flatMap(s => s.seriesOrder.map(seriesId => s.series[seriesId])).filter(s => s.label !== undefined);
+  return Object.keys(series).flatMap(seriesType => legendGetter[seriesType](series[seriesType]));
 }

package/modern/ChartsTooltip/ChartsAxisTooltipContent.js

@@ -81,7 +81,7 @@ export function ChartsAxisTooltipContent(props) {
   const USED_X_AXIS_ID = xAxisIds[0];
   const relevantSeries = React.useMemo(() => {
     const rep = [];
-    Object.keys(series).forEach(seriesType => {
+    Object.keys(series).filter(seriesType => ['bar', 'line', 'scatter'].includes(seriesType)).forEach(seriesType => {
       series[seriesType].seriesOrder.forEach(seriesId => {
         const axisKey = series[seriesType].series[seriesId].xAxisKey;
         if (axisKey === undefined || axisKey === USED_X_AXIS_ID) {

package/modern/ChartsTooltip/ChartsItemTooltipContent.js

@@ -13,8 +13,17 @@ export function DefaultChartsItemContent(props) {
   if (itemData.dataIndex === undefined) {
     return null;
   }
-  const displayedLabel = series.label ?? null;
-  const color = series.color;
+  const {
+    displayedLabel,
+    color
+  } = series.type === 'pie' ? {
+    color: series.data[itemData.dataIndex].color,
+    displayedLabel: series.data[itemData.dataIndex].label
+  } : {
+    color: series.color,
+    displayedLabel: series.label
+  };
+
   // TODO: Manage to let TS understand series.data and series.valueFormatter are coherent
   // @ts-ignore
   const formattedValue = series.valueFormatter(series.data[itemData.dataIndex]);

package/modern/LineChart/LineChart.js

@@ -125,6 +125,7 @@ process.env.NODE_ENV !== "production" ? LineChart.propTypes = {
   legend: PropTypes.shape({
     classes: PropTypes.object,
     direction: PropTypes.oneOf(['column', 'row']),
+    hidden: PropTypes.bool,
     itemWidth: PropTypes.number,
     markSize: PropTypes.number,
     offset: PropTypes.shape({

package/modern/LineChart/legend.js

@@ -0,0 +1,13 @@
+const legendGetter = params => {
+  const {
+    seriesOrder,
+    series
+  } = params;
+  const data = seriesOrder.map(seriesId => ({
+    color: series[seriesId].color,
+    label: series[seriesId].label,
+    id: seriesId
+  }));
+  return data.filter(item => item.label !== undefined);
+};
+export default legendGetter;

package/modern/PieChart/PieArc.js

@@ -0,0 +1,116 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["id", "dataIndex", "classes", "color", "highlightScope", "innerRadius", "outerRadius", "cornerRadius", "highlighted", "faded"];
+import * as React from 'react';
+import { arc as d3Arc } from 'd3-shape';
+import PropTypes from 'prop-types';
+import composeClasses from '@mui/utils/composeClasses';
+import generateUtilityClass from '@mui/utils/generateUtilityClass';
+import { styled } from '@mui/material/styles';
+import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
+import { InteractionContext } from '../context/InteractionProvider';
+import { getIsFaded, getIsHighlighted, useInteractionItemProps } from '../hooks/useInteractionItemProps';
+import { jsx as _jsx } from "react/jsx-runtime";
+export function getPieArcUtilityClass(slot) {
+  return generateUtilityClass('MuiPieArc', slot);
+}
+export const pieArcClasses = generateUtilityClasses('MuiPieArc', ['root', 'highlighted', 'faded']);
+const useUtilityClasses = ownerState => {
+  const {
+    classes,
+    id,
+    isFaded,
+    isHighlighted
+  } = ownerState;
+  const slots = {
+    root: ['root', `series-${id}`, isHighlighted && 'highlighted', isFaded && 'faded']
+  };
+  return composeClasses(slots, getPieArcUtilityClass, classes);
+};
+const PieArcRoot = styled('path', {
+  name: 'MuiPieArc',
+  slot: 'Root',
+  overridesResolver: (_, styles) => styles.arc
+})(({
+  ownerState,
+  theme
+}) => ({
+  stroke: theme.palette.background.paper,
+  strokeWidth: 1,
+  strokeLinejoin: 'round',
+  fill: ownerState.color,
+  opacity: ownerState.isFaded ? 0.3 : 1
+}));
+export default function PieArc(props) {
+  const {
+      id,
+      dataIndex,
+      classes: innerClasses,
+      color,
+      highlightScope,
+      innerRadius: baseInnerRadius = 0,
+      outerRadius: baseOuterRadius,
+      cornerRadius: baseCornerRadius = 0,
+      highlighted,
+      faded = {
+        additionalRadius: -5
+      }
+    } = props,
+    other = _objectWithoutPropertiesLoose(props, _excluded);
+  const getInteractionItemProps = useInteractionItemProps(highlightScope);
+  const {
+    item
+  } = React.useContext(InteractionContext);
+  const isHighlighted = getIsHighlighted(item, {
+    type: 'pie',
+    seriesId: id,
+    dataIndex
+  }, highlightScope);
+  const isFaded = !isHighlighted && getIsFaded(item, {
+    type: 'pie',
+    seriesId: id,
+    dataIndex
+  }, highlightScope);
+  const ownerState = {
+    id,
+    dataIndex,
+    classes: innerClasses,
+    color,
+    isFaded,
+    isHighlighted
+  };
+  const classes = useUtilityClasses(ownerState);
+  const attibuesOverride = _extends({
+    additionalRadius: 0
+  }, isFaded && faded || isHighlighted && highlighted || {});
+  const innerRadius = Math.max(0, attibuesOverride.innerRadius ?? baseInnerRadius);
+  const outerRadius = Math.max(0, attibuesOverride.outerRadius ?? baseOuterRadius + attibuesOverride.additionalRadius);
+  const cornerRadius = attibuesOverride.cornerRadius ?? baseCornerRadius;
+  return /*#__PURE__*/_jsx(PieArcRoot, _extends({
+    d: d3Arc().cornerRadius(cornerRadius)(_extends({}, other, {
+      innerRadius,
+      outerRadius
+    })),
+    ownerState: ownerState,
+    className: classes.root
+  }, getInteractionItemProps({
+    type: 'pie',
+    seriesId: id,
+    dataIndex
+  })));
+}
+process.env.NODE_ENV !== "production" ? PieArc.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  classes: PropTypes.object,
+  cornerRadius: PropTypes.number,
+  dataIndex: PropTypes.number.isRequired,
+  highlightScope: PropTypes.shape({
+    faded: PropTypes.oneOf(['global', 'none', 'series']),
+    highlighted: PropTypes.oneOf(['item', 'none', 'series'])
+  }),
+  innerRadius: PropTypes.number,
+  outerRadius: PropTypes.number.isRequired
+} : void 0;

package/modern/PieChart/PieArcLabel.js

@@ -0,0 +1,101 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["id", "dataIndex", "classes", "color", "highlightScope", "innerRadius", "outerRadius", "cornerRadius", "formattedArcLabel"];
+import * as React from 'react';
+import { arc as d3Arc } from 'd3-shape';
+import PropTypes from 'prop-types';
+import composeClasses from '@mui/utils/composeClasses';
+import generateUtilityClass from '@mui/utils/generateUtilityClass';
+import { styled } from '@mui/material/styles';
+import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
+import { InteractionContext } from '../context/InteractionProvider';
+import { getIsFaded, getIsHighlighted } from '../hooks/useInteractionItemProps';
+import { jsx as _jsx } from "react/jsx-runtime";
+export function getPieArcLabelUtilityClass(slot) {
+  return generateUtilityClass('MuiPieArcLabel', slot);
+}
+export const pieArcLabelClasses = generateUtilityClasses('MuiPieArcLabel', ['root', 'highlighted', 'faded']);
+const useUtilityClasses = ownerState => {
+  const {
+    classes,
+    id,
+    isFaded,
+    isHighlighted
+  } = ownerState;
+  const slots = {
+    root: ['root', `series-${id}`, isHighlighted && 'highlighted', isFaded && 'faded']
+  };
+  return composeClasses(slots, getPieArcLabelUtilityClass, classes);
+};
+const PieArcLabelRoot = styled('text', {
+  name: 'MuiPieArcLabel',
+  slot: 'Root',
+  overridesResolver: (_, styles) => styles.root
+})(({
+  theme
+}) => ({
+  fill: theme.palette.text.primary,
+  alignmentBaseline: 'baseline',
+  textAnchor: 'middle'
+}));
+export default function PieArcLabel(props) {
+  const {
+      id,
+      dataIndex,
+      classes: innerClasses,
+      color,
+      highlightScope,
+      innerRadius = 0,
+      outerRadius,
+      cornerRadius = 0,
+      formattedArcLabel
+    } = props,
+    other = _objectWithoutPropertiesLoose(props, _excluded);
+  const {
+    item
+  } = React.useContext(InteractionContext);
+  const isHighlighted = getIsHighlighted(item, {
+    type: 'pie',
+    seriesId: id,
+    dataIndex
+  }, highlightScope);
+  const isFaded = !isHighlighted && getIsFaded(item, {
+    type: 'pie',
+    seriesId: id,
+    dataIndex
+  }, highlightScope);
+  const ownerState = {
+    id,
+    dataIndex,
+    classes: innerClasses,
+    color,
+    isFaded,
+    isHighlighted
+  };
+  const classes = useUtilityClasses(ownerState);
+  const arcLabelPosition = formattedArcLabel ? d3Arc().cornerRadius(cornerRadius).centroid(_extends({}, other, {
+    innerRadius,
+    outerRadius
+  })) : [0, 0];
+  return /*#__PURE__*/_jsx(PieArcLabelRoot, {
+    className: classes.root,
+    x: arcLabelPosition[0],
+    y: arcLabelPosition[1],
+    children: formattedArcLabel
+  });
+}
+process.env.NODE_ENV !== "production" ? PieArcLabel.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  classes: PropTypes.object,
+  cornerRadius: PropTypes.number,
+  dataIndex: PropTypes.number.isRequired,
+  highlightScope: PropTypes.shape({
+    faded: PropTypes.oneOf(['global', 'none', 'series']),
+    highlighted: PropTypes.oneOf(['item', 'none', 'series'])
+  }),
+  innerRadius: PropTypes.number,
+  outerRadius: PropTypes.number.isRequired
+} : void 0;