@mui/x-charts-pro 8.0.0-alpha.13 → 8.0.0-alpha.14

package/FunnelChart/FunnelSection.js

@@ -0,0 +1,62 @@
+"use strict";
+'use client';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FunnelSectionPath = exports.FunnelSection = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+var React = _interopRequireWildcard(require("react"));
+var _styles = require("@mui/material/styles");
+var _internals = require("@mui/x-charts/internals");
+var _hooks = require("@mui/x-charts/hooks");
+var _clsx = _interopRequireDefault(require("clsx"));
+var _funnelSectionClasses = require("./funnelSectionClasses");
+var _jsxRuntime = require("react/jsx-runtime");
+const _excluded = ["seriesId", "dataIndex", "classes", "color", "onClick", "className"];
+const FunnelSectionPath = exports.FunnelSectionPath = (0, _styles.styled)('path')(() => ({
+  transition: 'opacity 0.2s ease-in, fill 0.2s ease-in'
+}));
+
+/**
+ * @ignore - internal component.
+ */
+const FunnelSection = exports.FunnelSection = (0, _internals.consumeSlots)('MuiFunnelSection', 'funnelSection', {
+  classesResolver: _funnelSectionClasses.useUtilityClasses
+}, function FunnelSection(props, ref) {
+  const {
+      seriesId,
+      dataIndex,
+      classes,
+      color,
+      onClick,
+      className
+    } = props,
+    other = (0, _objectWithoutPropertiesLoose2.default)(props, _excluded);
+  const getInteractionItemProps = (0, _internals.useInteractionItemProps)();
+  const {
+    isFaded,
+    isHighlighted
+  } = (0, _hooks.useItemHighlighted)({
+    seriesId,
+    dataIndex
+  });
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(FunnelSectionPath, (0, _extends2.default)({}, getInteractionItemProps({
+    type: 'funnel',
+    seriesId,
+    dataIndex
+  }), {
+    filter: isHighlighted ? 'brightness(120%)' : undefined,
+    opacity: isFaded ? 0.3 : 1,
+    fill: color,
+    stroke: "none",
+    cursor: onClick ? 'pointer' : 'unset',
+    onClick: onClick,
+    className: (0, _clsx.default)(classes?.root, className, isHighlighted && classes?.highlighted, isFaded && classes?.faded)
+  }, other, {
+    ref: ref
+  }));
+});

package/FunnelChart/categoryAxis.types.d.ts

@@ -0,0 +1,24 @@
+import { AxisConfig, ScaleName } from '@mui/x-charts/models';
+import { MakeOptional } from '@mui/x-internals/types';
+export type CategoryAxis = {
+  /**
+   * The categories to be displayed on the axis.
+   * The order of the categories is the order in which they are displayed.
+   */
+  categories?: string[];
+  /**
+   * The position of the axis.
+   * - 'left' - The axis is positioned on the left side of the chart.
+   * - 'right' - The axis is positioned on the right side of the chart.
+   * - 'top' - The axis is positioned on the top side of the chart.
+   * - 'bottom' - The axis is positioned on the bottom side of the chart.
+   * - 'none' - The axis is not displayed.
+   */
+  position?: 'left' | 'right' | 'top' | 'bottom' | 'none';
+  /**
+   * The size of the axis.
+   * - If the axis is horizontal, the size is the height of the axis.
+   * - If the axis is vertical, the size is the width of the axis.
+   */
+  size?: number;
+} & MakeOptional<Pick<AxisConfig<ScaleName, any>, 'disableLine' | 'disableTicks' | 'scaleType' | 'tickLabelStyle' | 'tickSize' | 'id'>, 'id'>;

package/FunnelChart/categoryAxis.types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/FunnelChart/funnel.types.d.ts

@@ -0,0 +1,124 @@
+import { ChartsLabelMarkProps } from '@mui/x-charts/ChartsLabel';
+import { CommonSeriesType, CartesianSeriesType, CommonDefaultizedProps, SeriesId } from '@mui/x-charts/internals';
+import { CurveType, Position } from '@mui/x-charts/models';
+import { DefaultizedProps, MakeRequired } from '@mui/x-internals/types';
+export type FunnelItemId = string | number;
+export type FunnelCurveType = Extract<CurveType, 'linear' | 'step'> | 'bump';
+export type FunnelValueType = {
+  /**
+   * A unique identifier of the funnel section.
+   */
+  id?: FunnelItemId;
+  /**
+   * The value of the funnel section.
+   */
+  value: number;
+  /**
+   * The label to display on the tooltip, funnel section, or the legend. It can be a string or a function.
+   */
+  label?: string | ((location: 'tooltip' | 'legend' | 'section') => string);
+  /**
+   * The color of the funnel section
+   */
+  color?: string;
+  /**
+   * Defines the mark type for the funnel item.
+   * @default 'square'
+   */
+  labelMarkType?: ChartsLabelMarkProps['type'];
+};
+export interface FunnelSeriesType extends Omit<CommonSeriesType<FunnelValueType>, 'color'>, CartesianSeriesType {
+  type: 'funnel';
+  /**
+   * Data associated to the funnel section.
+   */
+  data: Readonly<FunnelValueType[]>;
+  /**
+   * The label to display on the tooltip or the legend. It can be a string or a function.
+   */
+  label?: string | ((location: 'tooltip' | 'legend') => string);
+  /**
+   * Layout of the funnel.
+   * @default 'vertical'
+   */
+  layout?: 'horizontal' | 'vertical';
+  /**
+   * The type of curve to use for the line. Read more about curves at
+   * [line interpolation](https://mui.com/x/react-charts/lines/#interpolation).
+   * @default 'linear'
+   */
+  curve?: FunnelCurveType;
+  /**
+   * The label configuration for the funnel plot.
+   * Allows to customize the position and margin of the label that is displayed on the funnel sections.
+   *
+   * If set to `false`, the label will not be displayed.
+   * @default { vertical: 'middle', horizontal: 'center' }
+   */
+  sectionLabel?: FunnelLabelOptions | ((item: FunnelItem) => FunnelLabelOptions | false) | false;
+}
+/**
+ * An object that allows to identify a funnel item.
+ * Used for item interaction
+ */
+export type FunnelItemIdentifier = {
+  type: 'funnel';
+  /**
+   * The series id of the funnel.
+   */
+  seriesId: SeriesId;
+  /**
+   * The index of the data point in the series.
+   */
+  dataIndex: number;
+};
+export type FunnelItem = {
+  /**
+   * The series id of the funnel.
+   */
+  seriesId: SeriesId;
+  /**
+   * The index of the data point in the series.
+   */
+  dataIndex: number;
+  /**
+   * The value of the data point.
+   */
+  value: number;
+};
+export interface DefaultizedFunnelSeriesType extends DefaultizedProps<FunnelSeriesType, CommonDefaultizedProps | 'layout'> {
+  dataPoints: FunnelDataPoints[][];
+  data: Readonly<MakeRequired<FunnelValueType, 'id' | 'color'>[]>;
+}
+export type FunnelDataPoints = Record<'x' | 'y', number> & {
+  useBandWidth: boolean;
+  stackOffset: number;
+};
+export type FunnelLabelOptions = {
+  /**
+   * The position of the label.
+   * @default { vertical: 'middle', horizontal: 'center' }
+   */
+  position?: Position;
+  /**
+   * The text anchor of the label. Affects the horizontal alignment of the text.
+   *
+   * Default value depends on the position.
+   */
+  textAnchor?: 'start' | 'middle' | 'end';
+  /**
+   * The dominant baseline of the label. Affects the vertical alignment of the text.
+   *
+   * Default value depends on the position.
+   */
+  dominantBaseline?: 'auto' | 'baseline' | 'hanging' | 'middle' | 'central' | 'text-after-edge' | 'text-before-edge';
+  /**
+   * The offset of the label from the anchor point.
+   * If a single number is provided, the offset will be applied in both directions.
+   * @default 0
+   */
+  offset?: number | {
+    x?: number;
+    y?: number;
+  };
+};

package/FunnelChart/funnel.types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/FunnelChart/funnelPlotSlots.types.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react';
+import type { FunnelSectionProps } from './FunnelSection';
+export interface FunnelPlotSlots {
+  funnelSection?: React.ElementType<FunnelSectionProps>;
+}
+export interface FunnelPlotSlotProps {
+  funnelSection?: FunnelSectionProps;
+}
+export interface FunnelPlotSlotExtension {
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots?: FunnelPlotSlots;
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps?: FunnelPlotSlotProps;
+}

package/FunnelChart/funnelPlotSlots.types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/FunnelChart/funnelSectionClasses.d.ts

@@ -0,0 +1,13 @@
+import type { FunnelSectionProps } from './FunnelSection';
+export interface FunnelSectionClasses {
+  /** Styles applied to the root element. */
+  root: string;
+  /** Styles applied to the root element if `highlighted={true}`. */
+  highlighted: string;
+  /** Styles applied to the root element if `faded={true}`. */
+  faded: string;
+  /** Styles applied to the label element. */
+  label: string;
+}
+export declare const useUtilityClasses: (props: FunnelSectionProps) => Record<"label" | "highlighted" | "faded" | "root", string>;
+export declare const funnelSectionClasses: FunnelSectionClasses;

package/FunnelChart/funnelSectionClasses.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useUtilityClasses = exports.funnelSectionClasses = void 0;
+var _generateUtilityClass = _interopRequireDefault(require("@mui/utils/generateUtilityClass"));
+var _generateUtilityClasses = _interopRequireDefault(require("@mui/utils/generateUtilityClasses"));
+var _composeClasses = _interopRequireDefault(require("@mui/utils/composeClasses"));
+function getFunnelSectionUtilityClass(slot) {
+  return (0, _generateUtilityClass.default)('MuiFunnelSection', slot);
+}
+const useUtilityClasses = props => {
+  const {
+    classes,
+    seriesId
+  } = props;
+  const slots = {
+    root: ['root', `series-${seriesId}`],
+    highlighted: ['highlighted'],
+    faded: ['faded'],
+    label: ['label']
+  };
+  return (0, _composeClasses.default)(slots, getFunnelSectionUtilityClass, classes);
+};
+exports.useUtilityClasses = useUtilityClasses;
+const funnelSectionClasses = exports.funnelSectionClasses = (0, _generateUtilityClasses.default)('MuiFunnelSection', ['root', 'highlighted', 'faded', 'label']);

package/FunnelChart/funnelSlots.types.d.ts

@@ -0,0 +1,19 @@
+import { ChartsOverlaySlotProps, ChartsOverlaySlots } from '@mui/x-charts/ChartsOverlay';
+import { ChartsTooltipSlotProps, ChartsTooltipSlots } from '@mui/x-charts/ChartsTooltip';
+import { ChartsAxisSlotProps, ChartsAxisSlots } from '@mui/x-charts/internals';
+import { ChartsLegendSlotProps, ChartsLegendSlots } from '@mui/x-charts/ChartsLegend';
+import { FunnelPlotSlotProps, FunnelPlotSlots } from "./funnelPlotSlots.types.js";
+export interface FunnelChartSlots extends ChartsAxisSlots, FunnelPlotSlots, ChartsLegendSlots, ChartsTooltipSlots, ChartsOverlaySlots, ChartsAxisSlots {}
+export interface FunnelChartSlotProps extends ChartsAxisSlotProps, FunnelPlotSlotProps, ChartsLegendSlotProps, ChartsTooltipSlotProps, ChartsOverlaySlotProps, ChartsAxisSlotProps {}
+export interface FunnelChartSlotExtension {
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  slots?: FunnelChartSlots;
+  /**
+   * The props used for each component slot.
+   * @default {}
+   */
+  slotProps?: FunnelChartSlotProps;
+}

package/FunnelChart/funnelSlots.types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/FunnelChart/funnelStepCurve.d.ts

@@ -0,0 +1,4 @@
+import { CurveFactory } from '@mui/x-charts-vendor/d3-shape';
+declare const funnelHorizontalStepCurve: CurveFactory;
+declare const funnelVerticalStepCurve: CurveFactory;
+export { funnelHorizontalStepCurve, funnelVerticalStepCurve };

package/FunnelChart/funnelStepCurve.js

@@ -0,0 +1,74 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.funnelVerticalStepCurve = exports.funnelHorizontalStepCurve = void 0;
+/**
+ * This is a custom "step" curve generator for the funnel chart.
+ * It is used to draw the funnel using "rectangles" without having to rework the rendering logic.
+ *
+ * It is based on the d3-shape step curve generator.
+ * https://github.com/d3/d3-shape/blob/a82254af78f08799c71d7ab25df557c4872a3c51/src/curve/step.js
+ */
+class FunnelStep {
+  constructor(context, isHorizontal) {
+    this.context = void 0;
+    this.line = NaN;
+    this.x = NaN;
+    this.y = NaN;
+    this.currentPoint = 0;
+    this.isHorizontal = false;
+    this.context = context;
+    this.isHorizontal = isHorizontal;
+  }
+  areaStart() {
+    this.line = 0;
+  }
+  areaEnd() {
+    this.line = NaN;
+  }
+  lineStart() {
+    this.x = NaN;
+    this.y = NaN;
+    this.currentPoint = 0;
+  }
+  lineEnd() {
+    if (this.currentPoint === 2) {
+      this.context.lineTo(this.x, this.y);
+    }
+    if (this.line || this.line !== 0 && this.currentPoint === 1) {
+      this.context.closePath();
+    }
+    if (this.line >= 0) {
+      this.line = 1 - this.line;
+    }
+  }
+  point(x, y) {
+    x = +x;
+    y = +y;
+    if (this.currentPoint === 0) {
+      this.context.moveTo(x, y);
+    } else if (this.isHorizontal && (this.currentPoint === 2 || this.currentPoint === 1)) {
+      this.context.lineTo(x, this.y);
+      this.context.lineTo(x, y);
+    } else if (this.currentPoint === 3 && !this.isHorizontal) {
+      this.context.lineTo(x, this.y);
+      this.context.lineTo(x, y);
+    } else {
+      this.context.lineTo(this.x, y);
+      this.context.lineTo(x, y);
+    }
+    this.currentPoint += 1;
+    this.x = x;
+    this.y = y;
+  }
+}
+const funnelHorizontalStepCurve = context => {
+  return new FunnelStep(context, true);
+};
+exports.funnelHorizontalStepCurve = funnelHorizontalStepCurve;
+const funnelVerticalStepCurve = context => {
+  return new FunnelStep(context, false);
+};
+exports.funnelVerticalStepCurve = funnelVerticalStepCurve;

package/FunnelChart/index.d.ts

@@ -0,0 +1,7 @@
+export { FunnelChart as Unstable_FunnelChart } from "./FunnelChart.js";
+export type { FunnelChartProps } from './FunnelChart';
+export * from "./FunnelPlot.js";
+export * from "./funnel.types.js";
+export * from "./funnelSlots.types.js";
+export { funnelSectionClasses } from "./funnelSectionClasses.js";
+export type { FunnelSectionClasses } from './funnelSectionClasses';

package/FunnelChart/index.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  Unstable_FunnelChart: true,
+  funnelSectionClasses: true
+};
+Object.defineProperty(exports, "Unstable_FunnelChart", {
+  enumerable: true,
+  get: function () {
+    return _FunnelChart.FunnelChart;
+  }
+});
+Object.defineProperty(exports, "funnelSectionClasses", {
+  enumerable: true,
+  get: function () {
+    return _funnelSectionClasses.funnelSectionClasses;
+  }
+});
+var _FunnelChart = require("./FunnelChart");
+var _FunnelPlot = require("./FunnelPlot");
+Object.keys(_FunnelPlot).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _FunnelPlot[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _FunnelPlot[key];
+    }
+  });
+});
+var _funnel = require("./funnel.types");
+Object.keys(_funnel).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _funnel[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _funnel[key];
+    }
+  });
+});
+var _funnelSlots = require("./funnelSlots.types");
+Object.keys(_funnelSlots).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _funnelSlots[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _funnelSlots[key];
+    }
+  });
+});
+var _funnelSectionClasses = require("./funnelSectionClasses");

package/FunnelChart/labelUtils.d.ts

@@ -0,0 +1,42 @@
+import { FunnelDataPoints, FunnelLabelOptions } from "./funnel.types.js";
+/**
+ * It tries to keep the label inside the bounds of the section based on the position.
+ *
+ * @returns The text anchor and dominant baseline of the label.
+ */
+export declare const alignLabel: ({
+  position,
+  textAnchor,
+  dominantBaseline
+}: Omit<FunnelLabelOptions, "margin">) => {
+  textAnchor: string;
+  dominantBaseline: string;
+};
+/**
+ * This function calculates the position of the label based on the position and margin.
+ *
+ * It is quite complex, because it needs to calculate the position based on the position of the points of a rectangle.
+ * And we are manually calculating each possible position of the label.
+ *
+ * @returns The x and y position of the label.
+ */
+export declare const positionLabel: ({
+  position,
+  offset,
+  xPosition,
+  yPosition,
+  isHorizontal,
+  values,
+  dataIndex,
+  baseScaleData
+}: Omit<FunnelLabelOptions, "textAnchor" | "dominantBaseline"> & {
+  xPosition: (value: number, bandIndex: number, stackOffset?: number, useBand?: boolean) => number | undefined;
+  yPosition: (value: number, bandIndex: number, stackOffset?: number, useBand?: boolean) => number | undefined;
+  isHorizontal: boolean;
+  values: readonly FunnelDataPoints[];
+  dataIndex: number;
+  baseScaleData: readonly number[];
+}) => {
+  x: number;
+  y: number;
+};