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

package/modern/Gauge/GaugeContainer.js

@@ -1,174 +0,0 @@
-'use client';
-
-import _extends from "@babel/runtime/helpers/esm/extends";
-import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["width", "height", "margin", "title", "desc", "value", "valueMin", "valueMax", "startAngle", "endAngle", "outerRadius", "innerRadius", "cornerRadius", "cx", "cy", "children"];
-import * as React from 'react';
-import PropTypes from 'prop-types';
-import { styled } from '@mui/material/styles';
-import { ChartsSurface } from "../ChartsSurface/index.js";
-import { GaugeProvider } from "./GaugeProvider.js";
-import { ChartProvider } from "../context/ChartProvider/index.js";
-import { defaultizeMargin } from "../internals/defaultizeMargin.js";
-import { jsx as _jsx } from "react/jsx-runtime";
-const GStyled = styled('g')(({
-  theme
-}) => ({
-  '& text': {
-    fill: (theme.vars || theme).palette.text.primary
-  }
-}));
-const GaugeContainer = /*#__PURE__*/React.forwardRef(function GaugeContainer(props, ref) {
-  const {
-      width: inWidth,
-      height: inHeight,
-      margin,
-      title,
-      desc,
-      value,
-      valueMin = 0,
-      valueMax = 100,
-      startAngle,
-      endAngle,
-      outerRadius,
-      innerRadius,
-      cornerRadius,
-      cx,
-      cy,
-      children
-    } = props,
-    other = _objectWithoutPropertiesLoose(props, _excluded);
-  return /*#__PURE__*/_jsx(ChartProvider, {
-    pluginParams: {
-      width: inWidth,
-      height: inHeight,
-      margin: defaultizeMargin(margin, {
-        left: 10,
-        right: 10,
-        top: 10,
-        bottom: 10
-      })
-    },
-    plugins: [],
-    children: /*#__PURE__*/_jsx(GaugeProvider, {
-      value: value,
-      valueMin: valueMin,
-      valueMax: valueMax,
-      startAngle: startAngle,
-      endAngle: endAngle,
-      outerRadius: outerRadius,
-      innerRadius: innerRadius,
-      cornerRadius: cornerRadius,
-      cx: cx,
-      cy: cy,
-      children: /*#__PURE__*/_jsx(ChartsSurface, _extends({
-        title: title,
-        desc: desc,
-        role: "meter",
-        "aria-valuenow": value === null ? undefined : value,
-        "aria-valuemin": valueMin,
-        "aria-valuemax": valueMax
-      }, other, {
-        ref: ref,
-        children: /*#__PURE__*/_jsx(GStyled, {
-          "aria-hidden": "true",
-          children: children
-        })
-      }))
-    })
-  });
-});
-process.env.NODE_ENV !== "production" ? GaugeContainer.propTypes = {
-  // ----------------------------- Warning --------------------------------
-  // | These PropTypes are generated from the TypeScript type definitions |
-  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
-  // ----------------------------------------------------------------------
-  children: PropTypes.node,
-  className: PropTypes.string,
-  /**
-   * The radius applied to arc corners (similar to border radius).
-   * Set it to '50%' to get rounded arc.
-   * @default 0
-   */
-  cornerRadius: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-  /**
-   * The x coordinate of the arc center.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the width the drawing area.
-   */
-  cx: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-  /**
-   * The y coordinate of the arc center.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the height the drawing area.
-   */
-  cy: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-  desc: PropTypes.string,
-  /**
-   * The end angle (deg).
-   * @default 360
-   */
-  endAngle: PropTypes.number,
-  /**
-   * The height of the chart in px. If not defined, it takes the height of the parent element.
-   */
-  height: PropTypes.number,
-  /**
-   * This prop is used to help implement the accessibility logic.
-   * If you don't provide this prop. It falls back to a randomly generated id.
-   */
-  id: PropTypes.string,
-  /**
-   * The radius between circle center and the beginning of the arc.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the maximal radius that fit into the drawing area.
-   * @default '80%'
-   */
-  innerRadius: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-  /**
-   * The margin between the SVG and the drawing area.
-   * It's used for leaving some space for extra information such as the x- and y-axis or legend.
-   *
-   * Accepts a `number` to be used on all sides or an object with the optional properties: `top`, `bottom`, `left`, and `right`.
-   */
-  margin: PropTypes.oneOfType([PropTypes.number, PropTypes.shape({
-    bottom: PropTypes.number,
-    left: PropTypes.number,
-    right: PropTypes.number,
-    top: PropTypes.number
-  })]),
-  /**
-   * The radius between circle center and the end of the arc.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the maximal radius that fit into the drawing area.
-   * @default '100%'
-   */
-  outerRadius: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-  /**
-   * The start angle (deg).
-   * @default 0
-   */
-  startAngle: PropTypes.number,
-  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
-  title: PropTypes.string,
-  /**
-   * The value of the gauge.
-   * Set to `null` to not display a value.
-   */
-  value: PropTypes.number,
-  /**
-   * The maximal value of the gauge.
-   * @default 100
-   */
-  valueMax: PropTypes.number,
-  /**
-   * The minimal value of the gauge.
-   * @default 0
-   */
-  valueMin: PropTypes.number,
-  /**
-   * The width of the chart in px. If not defined, it takes the width of the parent element.
-   */
-  width: PropTypes.number
-} : void 0;
-export { GaugeContainer };

package/modern/Gauge/GaugeProvider.d.ts

@@ -1,117 +0,0 @@
-import * as React from 'react';
-interface CircularConfig {
-  /**
-   * The start angle (deg).
-   * @default 0
-   */
-  startAngle?: number;
-  /**
-   * The end angle (deg).
-   * @default 360
-   */
-  endAngle?: number;
-  /**
-   * The radius between circle center and the beginning of the arc.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the maximal radius that fit into the drawing area.
-   * @default '80%'
-   */
-  innerRadius?: number | string;
-  /**
-   * The radius between circle center and the end of the arc.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the maximal radius that fit into the drawing area.
-   * @default '100%'
-   */
-  outerRadius?: number | string;
-  /**
-   * The radius applied to arc corners (similar to border radius).
-   * Set it to '50%' to get rounded arc.
-   * @default 0
-   */
-  cornerRadius?: number | string;
-  /**
-   * The x coordinate of the arc center.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the width the drawing area.
-   */
-  cx?: number | string;
-  /**
-   * The y coordinate of the arc center.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the height the drawing area.
-   */
-  cy?: number | string;
-}
-interface ProcessedCircularConfig {
-  /**
-   * The start angle (rad).
-   */
-  startAngle: number;
-  /**
-   * The end angle (rad).
-   */
-  endAngle: number;
-  /**
-   * The radius between circle center and the beginning of the arc.
-   */
-  innerRadius: number;
-  /**
-   * The radius between circle center and the end of the arc.
-   */
-  outerRadius: number;
-  /**
-   * The radius applied to arc corners (similar to border radius).
-   */
-  cornerRadius: number;
-  /**
-   * The x coordinate of the pie center.
-   */
-  cx: number;
-  /**
-   * The y coordinate of the pie center.
-   */
-  cy: number;
-}
-interface GaugeConfig {
-  /**
-   * The value of the gauge.
-   * Set to `null` to not display a value.
-   */
-  value?: number | null;
-  /**
-   * The minimal value of the gauge.
-   * @default 0
-   */
-  valueMin?: number;
-  /**
-   * The maximal value of the gauge.
-   * @default 100
-   */
-  valueMax?: number;
-}
-export declare const GaugeContext: React.Context<Required<GaugeConfig> & ProcessedCircularConfig & {
-  /**
-   * The maximal radius from (cx, cy) that fits the arc in the drawing area.
-   */
-  maxRadius: number;
-  /**
-   * The angle (rad) associated to the current value.
-   */
-  valueAngle: null | number;
-}>;
-export interface GaugeProviderProps extends GaugeConfig, CircularConfig {
-  children: React.ReactNode;
-}
-export declare function GaugeProvider(props: GaugeProviderProps): React.JSX.Element;
-export declare function useGaugeState(): Required<GaugeConfig> & ProcessedCircularConfig & {
-  /**
-   * The maximal radius from (cx, cy) that fits the arc in the drawing area.
-   */
-  maxRadius: number;
-  /**
-   * The angle (rad) associated to the current value.
-   */
-  valueAngle: null | number;
-};
-export {};

package/modern/Gauge/GaugeProvider.js

@@ -1,91 +0,0 @@
-// @ignore - do not document.
-'use client';
-
-import * as React from 'react';
-import { getPercentageValue } from "../internals/getPercentageValue.js";
-import { getArcRatios, getAvailableRadius } from "./utils.js";
-import { useDrawingArea } from "../hooks/useDrawingArea.js";
-import { deg2rad } from "../internals/angleConversion.js";
-import { jsx as _jsx } from "react/jsx-runtime";
-export const GaugeContext = /*#__PURE__*/React.createContext({
-  value: null,
-  valueMin: 0,
-  valueMax: 0,
-  startAngle: 0,
-  endAngle: 0,
-  innerRadius: 0,
-  outerRadius: 0,
-  cornerRadius: 0,
-  cx: 0,
-  cy: 0,
-  maxRadius: 0,
-  valueAngle: null
-});
-if (process.env.NODE_ENV !== 'production') {
-  GaugeContext.displayName = 'GaugeContext';
-}
-export function GaugeProvider(props) {
-  const {
-    value = null,
-    valueMin = 0,
-    valueMax = 100,
-    startAngle = 0,
-    endAngle = 360,
-    outerRadius: outerRadiusParam,
-    innerRadius: innerRadiusParam,
-    cornerRadius: cornerRadiusParam,
-    cx: cxParam,
-    cy: cyParam,
-    children
-  } = props;
-  const {
-    left,
-    top,
-    width,
-    height
-  } = useDrawingArea();
-  const ratios = getArcRatios(startAngle, endAngle);
-  const innerCx = cxParam ? getPercentageValue(cxParam, width) : ratios.cx * width;
-  const innerCy = cyParam ? getPercentageValue(cyParam, height) : ratios.cy * height;
-  let cx = left + innerCx;
-  let cy = top + innerCy;
-  const maxRadius = getAvailableRadius(innerCx, innerCy, width, height, ratios);
-
-  // If the center is not defined, after computation of the available radius, update the center to use the remaining space.
-  if (cxParam === undefined) {
-    const usedWidth = maxRadius * (ratios.maxX - ratios.minX);
-    cx = left + (width - usedWidth) / 2 + ratios.cx * usedWidth;
-  }
-  if (cyParam === undefined) {
-    const usedHeight = maxRadius * (ratios.maxY - ratios.minY);
-    cy = top + (height - usedHeight) / 2 + ratios.cy * usedHeight;
-  }
-  const outerRadius = getPercentageValue(outerRadiusParam ?? maxRadius, maxRadius);
-  const innerRadius = getPercentageValue(innerRadiusParam ?? '80%', maxRadius);
-  const cornerRadius = getPercentageValue(cornerRadiusParam ?? 0, outerRadius - innerRadius);
-  const contextValue = React.useMemo(() => {
-    const startAngleRad = deg2rad(startAngle);
-    const endAngleRad = deg2rad(endAngle);
-    return {
-      value,
-      valueMin,
-      valueMax,
-      startAngle: startAngleRad,
-      endAngle: endAngleRad,
-      outerRadius,
-      innerRadius,
-      cornerRadius,
-      cx,
-      cy,
-      maxRadius,
-      valueAngle: value === null ? null : startAngleRad + (endAngleRad - startAngleRad) * (value - valueMin) / (valueMax - valueMin)
-    };
-  }, [value, valueMin, valueMax, startAngle, endAngle, outerRadius, innerRadius, cornerRadius, cx, cy, maxRadius]);
-  return /*#__PURE__*/_jsx(GaugeContext.Provider, {
-    value: contextValue,
-    children: children
-  });
-}
-export function useGaugeState() {
-  return React.useContext(GaugeContext);
-}

package/modern/Gauge/GaugeReferenceArc.d.ts

@@ -1,2 +0,0 @@
-import * as React from 'react';
-export declare function GaugeReferenceArc(props: React.ComponentProps<'path'>): React.JSX.Element;

package/modern/Gauge/GaugeReferenceArc.js

@@ -1,37 +0,0 @@
-'use client';
-
-import _extends from "@babel/runtime/helpers/esm/extends";
-import * as React from 'react';
-import { arc as d3Arc } from '@mui/x-charts-vendor/d3-shape';
-import { styled } from '@mui/material/styles';
-import { useGaugeState } from "./GaugeProvider.js";
-import { jsx as _jsx } from "react/jsx-runtime";
-const StyledPath = styled('path', {
-  name: 'MuiGauge',
-  slot: 'ReferenceArc',
-  overridesResolver: (props, styles) => styles.referenceArc
-})(({
-  theme
-}) => ({
-  fill: (theme.vars || theme).palette.divider
-}));
-export function GaugeReferenceArc(props) {
-  const {
-    startAngle,
-    endAngle,
-    outerRadius,
-    innerRadius,
-    cornerRadius,
-    cx,
-    cy
-  } = useGaugeState();
-  return /*#__PURE__*/_jsx(StyledPath, _extends({
-    transform: `translate(${cx}, ${cy})`,
-    d: d3Arc().cornerRadius(cornerRadius)({
-      startAngle,
-      endAngle,
-      innerRadius,
-      outerRadius
-    })
-  }, props));
-}

package/modern/Gauge/GaugeValueArc.d.ts

@@ -1,2 +0,0 @@
-import * as React from 'react';
-export declare function GaugeValueArc(props: React.ComponentProps<'path'>): React.JSX.Element | null;

package/modern/Gauge/GaugeValueArc.js

@@ -1,44 +0,0 @@
-'use client';
-
-import _extends from "@babel/runtime/helpers/esm/extends";
-import * as React from 'react';
-import { arc as d3Arc } from '@mui/x-charts-vendor/d3-shape';
-import { styled } from '@mui/material/styles';
-import { useGaugeState } from "./GaugeProvider.js";
-import { jsx as _jsx } from "react/jsx-runtime";
-const StyledPath = styled('path', {
-  name: 'MuiGauge',
-  slot: 'ReferenceArc',
-  overridesResolver: (props, styles) => styles.referenceArc
-})(({
-  theme
-}) => ({
-  fill: (theme.vars || theme).palette.primary.main
-}));
-export function GaugeValueArc(props) {
-  const {
-    value,
-    valueMin,
-    valueMax,
-    startAngle,
-    endAngle,
-    outerRadius,
-    innerRadius,
-    cornerRadius,
-    cx,
-    cy
-  } = useGaugeState();
-  if (value === null) {
-    return null;
-  }
-  const valueAngle = startAngle + (value - valueMin) / (valueMax - valueMin) * (endAngle - startAngle);
-  return /*#__PURE__*/_jsx(StyledPath, _extends({
-    transform: `translate(${cx}, ${cy})`,
-    d: d3Arc().cornerRadius(cornerRadius)({
-      startAngle,
-      endAngle: valueAngle,
-      innerRadius,
-      outerRadius
-    })
-  }, props));
-}

package/modern/Gauge/GaugeValueText.d.ts

@@ -1,15 +0,0 @@
-import * as React from 'react';
-import { ChartsTextProps } from "../ChartsText/index.js";
-export interface GaugeFormatterParams {
-  value: number | null;
-  valueMin: number;
-  valueMax: number;
-}
-export interface GaugeValueTextProps extends Omit<ChartsTextProps, 'text'> {
-  text?: string | ((params: GaugeFormatterParams) => string | null);
-}
-declare function GaugeValueText(props: GaugeValueTextProps): React.JSX.Element | null;
-declare namespace GaugeValueText {
-  var propTypes: any;
-}
-export { GaugeValueText };

package/modern/Gauge/GaugeValueText.js

@@ -1,71 +0,0 @@
-'use client';
-
-import _extends from "@babel/runtime/helpers/esm/extends";
-import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["text", "className"];
-import * as React from 'react';
-import PropTypes from 'prop-types';
-import { useGaugeState } from "./GaugeProvider.js";
-import { ChartsText } from "../ChartsText/index.js";
-import { jsx as _jsx } from "react/jsx-runtime";
-function defaultFormatter({
-  value
-}) {
-  return value === null ? null : value.toLocaleString();
-}
-function GaugeValueText(props) {
-  const {
-      text = defaultFormatter,
-      className
-    } = props,
-    other = _objectWithoutPropertiesLoose(props, _excluded);
-  const {
-    value,
-    valueMin,
-    valueMax,
-    cx,
-    cy
-  } = useGaugeState();
-  const formattedText = typeof text === 'function' ? text({
-    value,
-    valueMin,
-    valueMax
-  }) : text;
-  if (formattedText === null) {
-    return null;
-  }
-  return /*#__PURE__*/_jsx("g", {
-    className: className,
-    children: /*#__PURE__*/_jsx(ChartsText, _extends({
-      x: cx,
-      y: cy,
-      text: formattedText,
-      style: {
-        textAnchor: 'middle',
-        dominantBaseline: 'central'
-      }
-    }, other))
-  });
-}
-process.env.NODE_ENV !== "production" ? GaugeValueText.propTypes = {
-  // ----------------------------- Warning --------------------------------
-  // | These PropTypes are generated from the TypeScript type definitions |
-  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
-  // ----------------------------------------------------------------------
-  /**
-   * Height of a text line (in `em`).
-   */
-  lineHeight: PropTypes.number,
-  /**
-   * If `true`, the line width is computed.
-   * @default false
-   */
-  needsComputation: PropTypes.bool,
-  ownerState: PropTypes.any,
-  /**
-   * Style applied to text elements.
-   */
-  style: PropTypes.object,
-  text: PropTypes.oneOfType([PropTypes.func, PropTypes.string])
-} : void 0;
-export { GaugeValueText };

package/modern/Gauge/gaugeClasses.d.ts

@@ -1,14 +0,0 @@
-export interface GaugeClasses {
-  /** Styles applied to the root element. */
-  root: string;
-  /** Styles applied to the arc displaying the value. */
-  valueArc: string;
-  /** Styles applied to the arc displaying the range of available values. */
-  referenceArc: string;
-  /** Styles applied to the value text. */
-  valueText: string;
-}
-export type GaugeClassKey = keyof GaugeClasses;
-export declare function getGaugeUtilityClass(slot: string): string;
-export declare const gaugeClasses: GaugeClasses;
-export default gaugeClasses;

package/modern/Gauge/gaugeClasses.js

@@ -1,7 +0,0 @@
-import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
-import generateUtilityClass from '@mui/utils/generateUtilityClass';
-export function getGaugeUtilityClass(slot) {
-  return generateUtilityClass('MuiGauge', slot);
-}
-export const gaugeClasses = generateUtilityClasses('MuiGauge', ['root', 'valueArc', 'referenceArc', 'valueText']);
-export default gaugeClasses;

package/modern/Gauge/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./Gauge.js";
-export * from "./GaugeContainer.js";
-export * from "./GaugeValueText.js";
-export * from "./GaugeValueArc.js";
-export * from "./GaugeReferenceArc.js";
-export * from "./gaugeClasses.js";
-export { useGaugeState } from "./GaugeProvider.js";

package/modern/Gauge/index.js

@@ -1,7 +0,0 @@
-export * from "./Gauge.js";
-export * from "./GaugeContainer.js";
-export * from "./GaugeValueText.js";
-export * from "./GaugeValueArc.js";
-export * from "./GaugeReferenceArc.js";
-export * from "./gaugeClasses.js";
-export { useGaugeState } from "./GaugeProvider.js";

package/modern/Gauge/utils.d.ts

@@ -1,24 +0,0 @@
-/**
- * Returns the ratio of the arc bounding box and its center.
- * @param startAngle The start angle (in deg)
- * @param endAngle The end angle (in deg)
- */
-export declare function getArcRatios(startAngle: number, endAngle: number): {
-  cx: number;
-  cy: number;
-  minX: number;
-  maxX: number;
-  minY: number;
-  maxY: number;
-};
-export declare function getAvailableRadius(cx: number, cy: number, width: number, height: number, {
-  minX,
-  maxX,
-  minY,
-  maxY
-}: {
-  minX: number;
-  maxX: number;
-  minY: number;
-  maxY: number;
-}): number;

package/modern/Gauge/utils.js

@@ -1,66 +0,0 @@
-import { deg2rad } from "../internals/angleConversion.js";
-function getPoint(angle) {
-  const radAngle = deg2rad(angle);
-  return [Math.sin(radAngle), -Math.cos(radAngle)];
-}
-
-/**
- * Returns the ratio of the arc bounding box and its center.
- * @param startAngle The start angle (in deg)
- * @param endAngle The end angle (in deg)
- */
-export function getArcRatios(startAngle, endAngle) {
-  // Set the start, end and center point.
-  const points = [[0, 0], getPoint(startAngle), getPoint(endAngle)];
-
-  // Add cardinal points included in the arc
-  const minAngle = Math.min(startAngle, endAngle);
-  const maxAngle = Math.max(startAngle, endAngle);
-  const initialAngle = Math.floor(minAngle / 90) * 90;
-  for (let step = 1; step <= 4; step += 1) {
-    const cardinalAngle = initialAngle + step * 90;
-    if (cardinalAngle < maxAngle) {
-      points.push(getPoint(cardinalAngle));
-    }
-  }
-  const minX = Math.min(...points.map(([x]) => x));
-  const maxX = Math.max(...points.map(([x]) => x));
-  const minY = Math.min(...points.map(([, y]) => y));
-  const maxY = Math.max(...points.map(([, y]) => y));
-  return {
-    cx: -minX / (maxX - minX),
-    cy: -minY / (maxY - minY),
-    minX,
-    maxX,
-    minY,
-    maxY
-  };
-}
-export function getAvailableRadius(cx, cy, width, height, {
-  minX,
-  maxX,
-  minY,
-  maxY
-}) {
-  return Math.min(...[{
-    ratio: Math.abs(minX),
-    space: cx
-  }, {
-    ratio: Math.abs(maxX),
-    space: width - cx
-  }, {
-    ratio: Math.abs(minY),
-    space: cy
-  }, {
-    ratio: Math.abs(maxY),
-    space: height - cy
-  }].map(({
-    ratio,
-    space
-  }) => {
-    if (ratio < 0.00001) {
-      return Infinity;
-    }
-    return space / ratio;
-  }));
-}