@mui/x-charts
Version:
The community edition of MUI X Charts components.
25 lines • 1.15 kB
TypeScript
import { Series } from '@mui/x-charts-vendor/d3-shape';
import type { StackOffsetType, StackOrderType } from "../models/stacking.js";
import { SeriesId, StackableSeriesType } from "../models/seriesType/common.js";
type FormatterParams<T> = {
series: Record<SeriesId, T>;
seriesOrder: SeriesId[];
defaultStrategy?: {
stackOrder?: StackOrderType;
stackOffset?: StackOffsetType;
};
};
export type StackingGroupsType = {
ids: SeriesId[];
stackingOrder: (series: Series<any, any>) => number[];
stackingOffset: (series: Series<any, any>, order: Iterable<number>) => void;
}[];
export declare const StackOrder: { [key in StackOrderType]: (series: Series<any, any>) => number[] };
export declare const StackOffset: { [key in StackOffsetType]: (series: Series<any, any>, order: Iterable<number>) => void };
/**
* Takes a set of series and groups their ids
* @param series the object of all bars series
* @returns an array of groups, including the ids, the stacking order, and the stacking offset.
*/
export declare const getStackingGroups: <T extends StackableSeriesType>(params: FormatterParams<T>) => StackingGroupsType;
export {};