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

package/modern/models/colorMapping.d.ts

@@ -1,46 +0,0 @@
-export interface ContinuousColorConfig<Value = number | Date> {
-  type: 'continuous';
-  /**
-   * The minimal value of the color scale.
-   * @default 0
-   */
-  min?: Value;
-  /**
-   * The maximal value of the color scale.
-   * @default 100
-   */
-  max?: Value;
-  /**
-   * The colors to render. It can be an array with the extremum colors, or an interpolation function.
-   */
-  color: readonly [string, string] | ((t: number) => string);
-}
-export interface PiecewiseColorConfig<Value = number | Date> {
-  type: 'piecewise';
-  /**
-   * The thresholds where color should change from one category to another.
-   */
-  thresholds: Value[];
-  /**
-   * The colors used for each band defined by `thresholds`.
-   * Should contain N+1 colors, where N is the number of thresholds.
-   */
-  colors: string[];
-}
-export interface OrdinalColorConfig<Value = number | Date | string> {
-  type: 'ordinal';
-  /**
-   * The value to map.
-   * If undefined, it will be integers from 0 to the number of colors.
-   */
-  values?: readonly Value[];
-  /**
-   * The color palette.
-   * Items equal to `values[k]` will get the color of `colors[k]`.
-   */
-  colors: string[];
-  /**
-   * The color to use when an element is not part of the values.
-   */
-  unknownColor?: string;
-}

package/modern/models/colorMapping.js

@@ -1 +0,0 @@
-export {};

package/modern/models/curve.d.ts

@@ -1,6 +0,0 @@
-/**
- * The type of curve to use for the line.
- * Read more about curves at
- * [line interpolation](https://mui.com/x/react-charts/lines/#interpolation).
- */
-export type CurveType = 'catmullRom' | 'linear' | 'monotoneX' | 'monotoneY' | 'natural' | 'step' | 'stepBefore' | 'stepAfter' | 'bumpY' | 'bumpX';

package/modern/models/curve.js

@@ -1 +0,0 @@
-export {};

package/modern/models/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./seriesType/index.js";
-export * from "./stacking.js";
-export type { AxisConfig, ChartsYAxisProps, ChartsXAxisProps, ScaleName, ContinuousScaleName, ChartsAxisData } from './axis';
-export type { PropsFromSlot } from '@mui/x-internals/slots';
-export type { Position } from './position';
-export type { CurveType } from './curve';

package/modern/models/index.js

@@ -1,5 +0,0 @@
-export * from "./seriesType/index.js";
-export * from "./stacking.js";
-
-// Utils shared across the X packages
-export {};

package/modern/models/position.d.ts

@@ -1,10 +0,0 @@
-export type Position = {
-  /**
-   * The vertical position.
-   */
-  vertical?: 'top' | 'middle' | 'bottom';
-  /**
-   * The horizontal position.
-   */
-  horizontal?: 'start' | 'center' | 'end';
-};

package/modern/models/position.js

@@ -1 +0,0 @@
-export {};

package/modern/models/seriesType/bar.d.ts

@@ -1,38 +0,0 @@
-import { DefaultizedProps } from '@mui/x-internals/types';
-import type { StackOffsetType } from '../stacking';
-import { CartesianSeriesType, CommonSeriesType, CommonDefaultizedProps, StackableSeriesType } from "./common.js";
-export interface BarSeriesType extends CommonSeriesType<number | null>, CartesianSeriesType, StackableSeriesType {
-  type: 'bar';
-  /**
-   * Data associated to each bar.
-   */
-  data?: readonly (number | null)[];
-  /**
-   * The key used to retrieve data from the dataset.
-   */
-  dataKey?: string;
-  /**
-   * 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 bars. All bar should have the same layout.
-   * @default 'vertical'
-   */
-  layout?: 'horizontal' | 'vertical';
-  /**
-   * Defines how stacked series handle negative values.
-   * @default 'diverging'
-   */
-  stackOffset?: StackOffsetType;
-}
-/**
- * An object that allows to identify a single bar.
- * Used for item interaction
- */
-export type BarItemIdentifier = {
-  type: 'bar';
-  seriesId: DefaultizedBarSeriesType['id'];
-  dataIndex: number;
-};
-export interface DefaultizedBarSeriesType extends DefaultizedProps<BarSeriesType, CommonDefaultizedProps | 'color' | 'layout'> {}

package/modern/models/seriesType/bar.js

@@ -1 +0,0 @@
-export {};

package/modern/models/seriesType/common.d.ts

@@ -1,60 +0,0 @@
-import type { ChartsLabelMarkProps } from '../../ChartsLabel';
-import { HighlightScope } from "../../internals/plugins/featurePlugins/useChartHighlight/highlightConfig.types.js";
-import type { StackOffsetType, StackOrderType } from '../stacking';
-export type SeriesId = number | string;
-export type SeriesValueFormatterContext = {
-  /**
-   * The index of the value in the data array.
-   */
-  dataIndex: number;
-};
-export type SeriesValueFormatter<TValue> = (value: TValue, context: SeriesValueFormatterContext) => string | null;
-export type CommonSeriesType<TValue> = {
-  id?: SeriesId;
-  color?: string;
-  /**
-   * Formatter used to render values in tooltip or other data display.
-   * @param {TValue} value The series' value to render.
-   * @param {SeriesValueFormatterContext} context The rendering context of the value.
-   * @returns {string | null} The string to display or null if the value should not be shown.
-   */
-  valueFormatter?: SeriesValueFormatter<TValue>;
-  /**
-   * The scope to apply when the series is highlighted.
-   */
-  highlightScope?: Partial<HighlightScope>;
-  /**
-   * Defines the mark type for the series.
-   *
-   * There is a default mark type for each series type.
-   */
-  labelMarkType?: ChartsLabelMarkProps['type'];
-};
-export type CommonDefaultizedProps = 'id' | 'valueFormatter' | 'data';
-export type CartesianSeriesType = {
-  /**
-   * The id of the x-axis used to render the series.
-   */
-  xAxisId?: string;
-  /**
-   * The id of the y-axis used to render the series.
-   */
-  yAxisId?: string;
-};
-export type StackableSeriesType = {
-  /**
-   * The key that identifies the stacking group.
-   * Series with the same `stack` property will be stacked together.
-   */
-  stack?: string;
-  /**
-   * Defines how stacked series handle negative values.
-   */
-  stackOffset?: StackOffsetType;
-  /**
-   * The order in which series' of the same group are stacked together.
-   * @default 'none'
-   */
-  stackOrder?: StackOrderType;
-};
-export type DefaultizedCartesianSeriesType = Required<CartesianSeriesType>;

package/modern/models/seriesType/common.js

@@ -1 +0,0 @@
-export {};

package/modern/models/seriesType/config.d.ts

@@ -1,91 +0,0 @@
-import { DefaultizedProps, MakeOptional } from '@mui/x-internals/types';
-import { ScatterSeriesType, DefaultizedScatterSeriesType, ScatterItemIdentifier, ScatterValueType } from "./scatter.js";
-import { LineSeriesType, DefaultizedLineSeriesType, LineItemIdentifier } from "./line.js";
-import { BarItemIdentifier, BarSeriesType, DefaultizedBarSeriesType } from "./bar.js";
-import { PieSeriesType, DefaultizedPieSeriesType, PieItemIdentifier, PieValueType, DefaultizedPieValueType } from "./pie.js";
-import { DefaultizedRadarSeriesType, RadarItemIdentifier, RadarSeriesType } from "./radar.js";
-export interface ChartsSeriesConfig {
-  bar: {
-    /**
-     * Series type when passed to the formatter (some ids are given default values to simplify the DX)
-     */
-    seriesInput: DefaultizedProps<BarSeriesType, 'id'> & {
-      color: string;
-    };
-    /**
-     * Series type when stored in the context (with all the preprocessing added))
-     */
-    series: DefaultizedBarSeriesType;
-    /**
-     * Series typing such that the one user need to provide
-     */
-    seriesProp: BarSeriesType;
-    itemIdentifier: BarItemIdentifier;
-    valueType: number | null;
-    canBeStacked: true;
-    axisType: 'cartesian';
-  };
-  line: {
-    seriesInput: DefaultizedProps<LineSeriesType, 'id'> & {
-      color: string;
-    };
-    series: DefaultizedLineSeriesType;
-    seriesProp: LineSeriesType;
-    itemIdentifier: LineItemIdentifier;
-    valueType: number | null;
-    canBeStacked: true;
-    axisType: 'cartesian';
-  };
-  scatter: {
-    seriesInput: DefaultizedProps<ScatterSeriesType, 'id'> & {
-      color: string;
-    };
-    series: DefaultizedScatterSeriesType;
-    seriesProp: ScatterSeriesType;
-    valueType: ScatterValueType;
-    itemIdentifier: ScatterItemIdentifier;
-    axisType: 'cartesian';
-  };
-  pie: {
-    seriesInput: Omit<DefaultizedProps<PieSeriesType, 'id'>, 'data'> & {
-      data: (MakeOptional<PieValueType, 'id'> & {
-        color: string;
-      })[];
-    };
-    series: DefaultizedPieSeriesType;
-    seriesProp: PieSeriesType<MakeOptional<PieValueType, 'id'>>;
-    itemIdentifier: PieItemIdentifier;
-    valueType: DefaultizedPieValueType;
-  };
-  radar: {
-    seriesInput: DefaultizedProps<RadarSeriesType, 'id'> & {
-      color: string;
-    };
-    series: DefaultizedRadarSeriesType;
-    seriesProp: RadarSeriesType;
-    itemIdentifier: RadarItemIdentifier;
-    valueType: number;
-    axisType: 'polar';
-  };
-}
-export type ChartSeriesType = keyof ChartsSeriesConfig;
-export type CartesianChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
-  axisType: 'cartesian';
-} ? Key : never }[ChartSeriesType]>;
-export type PolarChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
-  axisType: 'polar';
-} ? Key : never }[ChartSeriesType]>;
-export type StackableChartSeriesType = keyof Pick<ChartsSeriesConfig, { [Key in ChartSeriesType]: ChartsSeriesConfig[Key] extends {
-  canBeStacked: true;
-} ? Key : never }[ChartSeriesType]>;
-export type ChartSeries<T extends ChartSeriesType> = ChartsSeriesConfig[T]['seriesInput'];
-export type ChartSeriesDefaultized<T extends ChartSeriesType> = ChartsSeriesConfig[T] extends {
-  canBeStacked: true;
-} ? ChartsSeriesConfig[T]['series'] & {
-  stackedData: [number, number][];
-} : ChartsSeriesConfig[T]['series'];
-export type ChartItemIdentifier<T extends ChartSeriesType> = ChartsSeriesConfig[T]['itemIdentifier'];
-export type DatasetElementType<T> = {
-  [key: string]: Readonly<T>;
-};
-export type DatasetType<T = number | string | Date | null | undefined> = DatasetElementType<T>[];

package/modern/models/seriesType/config.js

@@ -1 +0,0 @@
-export {};

package/modern/models/seriesType/index.d.ts

@@ -1,16 +0,0 @@
-import { BarSeriesType, DefaultizedBarSeriesType } from "./bar.js";
-import { CartesianChartSeriesType, ChartSeriesType, ChartsSeriesConfig, StackableChartSeriesType } from "./config.js";
-type AllSeriesType<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['seriesProp'];
-type CartesianSeriesType = AllSeriesType<CartesianChartSeriesType>;
-type DefaultizedSeriesType<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['series'];
-type DefaultizedCartesianSeriesType = DefaultizedSeriesType<CartesianChartSeriesType>;
-type StackableSeriesType = DefaultizedSeriesType<StackableChartSeriesType>;
-export type SeriesItemIdentifier<T extends ChartSeriesType = ChartSeriesType> = ChartsSeriesConfig[T]['itemIdentifier'];
-export * from "./line.js";
-export * from "./bar.js";
-export * from "./scatter.js";
-export * from "./pie.js";
-export * from "./radar.js";
-export type { AllSeriesType, CartesianSeriesType, DefaultizedSeriesType, DefaultizedCartesianSeriesType, StackableSeriesType };
-export declare function isDefaultizedBarSeries(series: DefaultizedSeriesType): series is DefaultizedBarSeriesType;
-export declare function isBarSeries(series: AllSeriesType): series is BarSeriesType;

package/modern/models/seriesType/index.js

@@ -1,17 +0,0 @@
-// Series definition
-
-// item identifier
-
-export * from "./line.js";
-export * from "./bar.js";
-export * from "./scatter.js";
-export * from "./pie.js";
-export * from "./radar.js";
-// Helpers
-
-export function isDefaultizedBarSeries(series) {
-  return series.type === 'bar';
-}
-export function isBarSeries(series) {
-  return series.type === 'bar';
-}

package/modern/models/seriesType/line.d.ts

@@ -1,104 +0,0 @@
-import { DefaultizedProps } from '@mui/x-internals/types';
-import type { StackOffsetType } from '../stacking';
-import { CartesianSeriesType, CommonDefaultizedProps, CommonSeriesType, SeriesId, StackableSeriesType } from "./common.js";
-import { CurveType } from "../curve.js";
-export interface ShowMarkParams<AxisValue = number | Date> {
-  /**
-   * The item index.
-   */
-  index: number;
-  /**
-   * The x coordinate in the SVG.
-   */
-  x: number;
-  /**
-   * The y coordinate in the SVG.
-   */
-  y: number;
-  /**
-   * The item position value. It likely comes from the axis `data` property.
-   */
-  position: AxisValue;
-  /**
-   * The item value. It comes from the series `data` property.
-   */
-  value: number;
-}
-export interface LineSeriesType extends CommonSeriesType<number | null>, CartesianSeriesType, StackableSeriesType {
-  type: 'line';
-  /**
-   * Data associated to the line.
-   */
-  data?: readonly (number | null)[];
-  /**
-   * The key used to retrieve data from the dataset.
-   */
-  dataKey?: string;
-  stack?: string;
-  area?: boolean;
-  /**
-   * The label to display on the tooltip or the legend. It can be a string or a function.
-   */
-  label?: string | ((location: 'tooltip' | 'legend') => string);
-  /**
-   * 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 'monotoneX'
-   */
-  curve?: CurveType;
-  /**
-   * If `true`, step curve starts and end at the first and last point.
-   * By default the line is extended to fill the space before and after.
-   */
-  strictStepCurve?: boolean;
-  /**
-   * Define which items of the series should display a mark.
-   * If can be a boolean that applies to all items.
-   * Or a callback that gets some item properties and returns true if the item should be displayed.
-   */
-  showMark?: boolean | ((params: ShowMarkParams) => boolean);
-  /**
-   * The shape of the mark elements.
-   * Using 'circle' renders a `<circle />` element, while all other options render a `<path />` instead. The path causes a small decrease in performance.
-   * @default 'circle'
-   */
-  shape?: 'circle' | 'cross' | 'diamond' | 'square' | 'star' | 'triangle' | 'wye';
-  /**
-   * Do not render the line highlight item if set to `true`.
-   * @default false
-   */
-  disableHighlight?: boolean;
-  /**
-   * If `true`, line and area connect points separated by `null` values.
-   * @default false
-   */
-  connectNulls?: boolean;
-  /**
-   * Defines how stacked series handle negative values.
-   * @default 'none'
-   */
-  stackOffset?: StackOffsetType;
-  /**
-   * The value of the line at the base of the series area.
-   *
-   * - `'min'` the area will fill the space **under** the line.
-   * - `'max'` the area will fill the space **above** the line.
-   * - `number` the area will fill the space between this value and the line
-   *
-   * @default 0
-   */
-  baseline?: number | 'min' | 'max';
-}
-/**
- * An object that allows to identify a single line.
- * Used for item interaction
- */
-export type LineItemIdentifier = {
-  type: 'line';
-  seriesId: SeriesId;
-  /**
-   * `dataIndex` can be `undefined` if the mouse is over the area and not a specific item.
-   */
-  dataIndex?: number;
-};
-export interface DefaultizedLineSeriesType extends DefaultizedProps<LineSeriesType, CommonDefaultizedProps | 'color'> {}

package/modern/models/seriesType/line.js

@@ -1 +0,0 @@
-export {};

package/modern/models/seriesType/pie.d.ts

@@ -1,166 +0,0 @@
-import { PieArcDatum as D3PieArcDatum } from '@mui/x-charts-vendor/d3-shape';
-import { DefaultizedProps } from '@mui/x-internals/types';
-import { CommonDefaultizedProps, CommonSeriesType, SeriesId } from "./common.js";
-import type { ChartsLabelMarkProps } from '../../ChartsLabel';
-export type PieItemId = string | number;
-export type PieValueType = {
-  /**
-   * A unique identifier of the pie slice.
-   */
-  id?: PieItemId;
-  value: number;
-  /**
-   * The label to display on the tooltip, arc, or the legend. It can be a string or a function.
-   */
-  label?: string | ((location: 'tooltip' | 'legend' | 'arc') => string);
-  color?: string;
-  /**
-   * Defines the mark type for the pie item.
-   * @default 'circle'
-   */
-  labelMarkType?: ChartsLabelMarkProps['type'];
-};
-export type DefaultizedPieValueType = PieValueType & Omit<D3PieArcDatum<any>, 'data'> & {
-  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: Readonly<TData[]>;
-  /**
-   * 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 0
-   */
-  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 between circle center and the arc label.
-   * 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 (innerRadius - outerRadius) / 2
-   */
-  arcLabelRadius?: number | string;
-  /**
-   * 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;
-  /**
-   * The sorting strategy used to order pie slices.
-   * Can be 'none', 'asc', 'desc', or a sorting function.
-   * @default 'none'
-   */
-  sortingValues?: ChartsPieSorting;
-  /**
-   * The label displayed into the arc.
-   */
-  arcLabel?: 'formattedValue' | 'label' | 'value' | ((item: Omit<DefaultizedPieValueType, 'label'> & {
-    label?: string;
-  }) => string);
-  /**
-   * The minimal angle required to display the arc label.
-   * @default 0
-   */
-  arcLabelMinAngle?: number;
-  /**
-   * The x coordinate of the pie center.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the width the drawing area.
-   * @default '50%'
-   */
-  cx?: number | string;
-  /**
-   * The y coordinate of the pie center.
-   * Can be a number (in px) or a string with a percentage such as '50%'.
-   * The '100%' is the height the drawing area.
-   * @default '50%'
-   */
-  cy?: number | string;
-  /**
-   * Override the arc attributes when it is highlighted.
-   */
-  highlighted?: {
-    /**
-     * Value added to the default `outerRadius`.
-     * Can be negative. It is ignored if you provide a `highlighted.outerRadius` value.
-     */
-    additionalRadius?: number;
-    innerRadius?: number;
-    outerRadius?: number;
-    cornerRadius?: number;
-    paddingAngle?: number;
-    arcLabelRadius?: number;
-    color?: string;
-  };
-  /**
-   * Override the arc attributes when it is faded.
-   */
-  faded?: {
-    /**
-     * Value added to the default `outerRadius`.
-     * Can be negative. It is ignored if you provide a `faded.outerRadius` value.
-     */
-    additionalRadius?: number;
-    innerRadius?: number;
-    outerRadius?: number;
-    cornerRadius?: number;
-    paddingAngle?: number;
-    arcLabelRadius?: number;
-    color?: string;
-  };
-}
-/**
- * An object that allows to identify a single pie slice.
- * Used for item interaction
- */
-export type PieItemIdentifier = {
-  type: 'pie';
-  seriesId: SeriesId;
-  dataIndex: number;
-};
-export interface DefaultizedPieSeriesType extends DefaultizedProps<PieSeriesType, CommonDefaultizedProps> {
-  data: DefaultizedPieValueType[];
-}
-/**
- * Props received when the parent components has done the percentage conversion.
- */
-export interface ComputedPieRadius {
-  /**
-   * The radius between circle center and the beginning of the arc.
-   * @default 0
-   */
-  innerRadius?: number;
-  /**
-   * The radius between circle center and the end of the arc.
-   */
-  outerRadius: number;
-  /**
-   * The radius between circle center and the arc label in px.
-   * @default (innerRadius - outerRadius) / 2
-   */
-  arcLabelRadius?: number;
-}

package/modern/models/seriesType/pie.js

@@ -1 +0,0 @@
-export {};

package/modern/models/seriesType/radar.d.ts

@@ -1,24 +0,0 @@
-import { DefaultizedProps } from '@mui/x-internals/types';
-import { CommonDefaultizedProps, CommonSeriesType, SeriesId } from "./common.js";
-export interface RadarSeriesType extends CommonSeriesType<number> {
-  type: 'radar';
-  data: number[];
-  /**
-   * The label to display on the tooltip or the legend. It can be a string or a function.
-   */
-  label?: string | ((location: 'tooltip' | 'legend') => string);
-  /**
-   * If `true` show marks at value position.
-   */
-  showMark?: boolean;
-}
-/**
- * An object that allows to identify either a radar series or a radar point (if dataIndex is defined).
- * Used for item interaction
- */
-export type RadarItemIdentifier = {
-  type: 'radar';
-  seriesId: SeriesId;
-  dataIndex?: number;
-};
-export interface DefaultizedRadarSeriesType extends DefaultizedProps<RadarSeriesType, CommonDefaultizedProps | 'color'> {}

package/modern/models/seriesType/radar.js

@@ -1 +0,0 @@
-export {};