@mui/x-charts
Version:
The community edition of the charts components (MUI X).
421 lines (420 loc) • 15.8 kB
JavaScript
import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
import _extends from "@babel/runtime/helpers/esm/extends";
import * as React from 'react';
import PropTypes from 'prop-types';
import { ResponsiveChartContainer } from '../ResponsiveChartContainer';
import { ChartsAxis } from '../ChartsAxis/ChartsAxis';
import { DEFAULT_X_AXIS_KEY } from '../constants';
import { ChartsTooltip } from '../ChartsTooltip';
import { ChartsLegend } from '../ChartsLegend';
import { ChartsAxisHighlight } from '../ChartsAxisHighlight';
import { PiePlot } from './PiePlot';
import { jsx as _jsx } from "react/jsx-runtime";
import { jsxs as _jsxs } from "react/jsx-runtime";
var defaultMargin = {
top: 5,
bottom: 5,
left: 5,
right: 100
};
/**
* Demos:
*
* - [Pie](https://mui.com/x/react-charts/pie/)
* - [Pie demonstration](https://mui.com/x/react-charts/pie-demo/)
*
* API:
*
* - [PieChart API](https://mui.com/x/api/charts/pie-chart/)
*/
function PieChart(props) {
var xAxis = props.xAxis,
yAxis = props.yAxis,
series = props.series,
width = props.width,
height = props.height,
marginProps = props.margin,
colors = props.colors,
sx = props.sx,
_props$tooltip = props.tooltip,
tooltip = _props$tooltip === void 0 ? {
trigger: 'item'
} : _props$tooltip,
_props$axisHighlight = props.axisHighlight,
axisHighlight = _props$axisHighlight === void 0 ? {
x: 'none',
y: 'none'
} : _props$axisHighlight,
skipAnimation = props.skipAnimation,
_props$legend = props.legend,
legend = _props$legend === void 0 ? {
direction: 'column',
position: {
vertical: 'middle',
horizontal: 'right'
}
} : _props$legend,
_props$topAxis = props.topAxis,
topAxis = _props$topAxis === void 0 ? null : _props$topAxis,
_props$leftAxis = props.leftAxis,
leftAxis = _props$leftAxis === void 0 ? null : _props$leftAxis,
_props$rightAxis = props.rightAxis,
rightAxis = _props$rightAxis === void 0 ? null : _props$rightAxis,
_props$bottomAxis = props.bottomAxis,
bottomAxis = _props$bottomAxis === void 0 ? null : _props$bottomAxis,
children = props.children,
slots = props.slots,
slotProps = props.slotProps,
onClick = props.onClick;
var margin = _extends({}, defaultMargin, marginProps);
return /*#__PURE__*/_jsxs(ResponsiveChartContainer, {
series: series.map(function (s) {
return _extends({
type: 'pie'
}, s);
}),
width: width,
height: height,
margin: margin,
xAxis: xAxis != null ? xAxis : [{
id: DEFAULT_X_AXIS_KEY,
scaleType: 'point',
data: _toConsumableArray(new Array(Math.max.apply(Math, _toConsumableArray(series.map(function (s) {
return s.data.length;
}))))).map(function (_, index) {
return index;
})
}],
yAxis: yAxis,
colors: colors,
sx: sx,
disableAxisListener: (tooltip == null ? void 0 : tooltip.trigger) !== 'axis' && (axisHighlight == null ? void 0 : axisHighlight.x) === 'none' && (axisHighlight == null ? void 0 : axisHighlight.y) === 'none',
children: [/*#__PURE__*/_jsx(ChartsAxis, {
topAxis: topAxis,
leftAxis: leftAxis,
rightAxis: rightAxis,
bottomAxis: bottomAxis,
slots: slots,
slotProps: slotProps
}), /*#__PURE__*/_jsx(PiePlot, {
slots: slots,
slotProps: slotProps,
onClick: onClick,
skipAnimation: skipAnimation
}), /*#__PURE__*/_jsx(ChartsLegend, _extends({}, legend, {
slots: slots,
slotProps: slotProps
})), /*#__PURE__*/_jsx(ChartsAxisHighlight, _extends({}, axisHighlight)), /*#__PURE__*/_jsx(ChartsTooltip, _extends({}, tooltip)), children]
});
}
process.env.NODE_ENV !== "production" ? PieChart.propTypes = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit the TypeScript types and run "yarn proptypes" |
// ----------------------------------------------------------------------
axisHighlight: PropTypes.shape({
x: PropTypes.oneOf(['band', 'line', 'none']),
y: PropTypes.oneOf(['band', 'line', 'none'])
}),
/**
* Indicate which axis to display the bottom of the charts.
* Can be a string (the id of the axis) or an object `ChartsXAxisProps`.
* @default xAxisIds[0] The id of the first provided axis
*/
bottomAxis: PropTypes.oneOfType([PropTypes.shape({
axisId: PropTypes.string,
classes: PropTypes.object,
disableLine: PropTypes.bool,
disableTicks: PropTypes.bool,
fill: PropTypes.string,
label: PropTypes.string,
labelFontSize: PropTypes.number,
labelStyle: PropTypes.object,
position: PropTypes.oneOf(['bottom', 'top']),
slotProps: PropTypes.object,
slots: PropTypes.object,
stroke: PropTypes.string,
tickFontSize: PropTypes.number,
tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
tickLabelStyle: PropTypes.object,
tickMaxStep: PropTypes.number,
tickMinStep: PropTypes.number,
tickNumber: PropTypes.number,
tickSize: PropTypes.number
}), PropTypes.string]),
children: PropTypes.node,
className: PropTypes.string,
/**
* Color palette used to colorize multiple series.
*/
colors: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.func]),
/**
* An array of objects that can be used to populate series and axes data using their `dataKey` property.
*/
dataset: PropTypes.arrayOf(PropTypes.object),
desc: PropTypes.string,
/**
* If `true`, the charts will not listen to the mouse move event.
* It might break interactive features, but will improve performance.
* @default false
*/
disableAxisListener: PropTypes.bool,
/**
* The height of the chart in px. If not defined, it takes the height of the parent element.
* @default undefined
*/
height: PropTypes.number,
/**
* Indicate which axis to display the left of the charts.
* Can be a string (the id of the axis) or an object `ChartsYAxisProps`.
* @default yAxisIds[0] The id of the first provided axis
*/
leftAxis: PropTypes.oneOfType([PropTypes.shape({
axisId: PropTypes.string,
classes: PropTypes.object,
disableLine: PropTypes.bool,
disableTicks: PropTypes.bool,
fill: PropTypes.string,
label: PropTypes.string,
labelFontSize: PropTypes.number,
labelStyle: PropTypes.object,
position: PropTypes.oneOf(['left', 'right']),
slotProps: PropTypes.object,
slots: PropTypes.object,
stroke: PropTypes.string,
tickFontSize: PropTypes.number,
tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
tickLabelStyle: PropTypes.object,
tickMaxStep: PropTypes.number,
tickMinStep: PropTypes.number,
tickNumber: PropTypes.number,
tickSize: PropTypes.number
}), PropTypes.string]),
/**
* @deprecated Consider using `slotProps.legend` instead.
*/
legend: PropTypes.shape({
classes: PropTypes.object,
direction: PropTypes.oneOf(['column', 'row']),
hidden: PropTypes.bool,
position: PropTypes.shape({
horizontal: PropTypes.oneOf(['left', 'middle', 'right']).isRequired,
vertical: PropTypes.oneOf(['bottom', 'middle', 'top']).isRequired
}),
slotProps: PropTypes.object,
slots: PropTypes.object
}),
/**
* 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 an object with the optional properties: `top`, `bottom`, `left`, and `right`.
* @default object Depends on the charts type.
*/
margin: PropTypes.shape({
bottom: PropTypes.number,
left: PropTypes.number,
right: PropTypes.number,
top: PropTypes.number
}),
onClick: PropTypes.func,
/**
* Indicate which axis to display the right of the charts.
* Can be a string (the id of the axis) or an object `ChartsYAxisProps`.
* @default null
*/
rightAxis: PropTypes.oneOfType([PropTypes.shape({
axisId: PropTypes.string,
classes: PropTypes.object,
disableLine: PropTypes.bool,
disableTicks: PropTypes.bool,
fill: PropTypes.string,
label: PropTypes.string,
labelFontSize: PropTypes.number,
labelStyle: PropTypes.object,
position: PropTypes.oneOf(['left', 'right']),
slotProps: PropTypes.object,
slots: PropTypes.object,
stroke: PropTypes.string,
tickFontSize: PropTypes.number,
tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
tickLabelStyle: PropTypes.object,
tickMaxStep: PropTypes.number,
tickMinStep: PropTypes.number,
tickNumber: PropTypes.number,
tickSize: PropTypes.number
}), PropTypes.string]),
series: PropTypes.arrayOf(PropTypes.shape({
arcLabel: PropTypes.oneOfType([PropTypes.oneOf(['formattedValue', 'label', 'value']), PropTypes.func]),
arcLabelMinAngle: PropTypes.number,
color: PropTypes.string,
cornerRadius: PropTypes.number,
cx: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
cy: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
data: PropTypes.arrayOf(PropTypes.shape({
color: PropTypes.string,
id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
label: PropTypes.string,
value: PropTypes.number.isRequired
})).isRequired,
endAngle: PropTypes.number,
faded: PropTypes.shape({
additionalRadius: PropTypes.number,
color: PropTypes.string,
cornerRadius: PropTypes.number,
innerRadius: PropTypes.number,
outerRadius: PropTypes.number,
paddingAngle: PropTypes.number
}),
highlighted: PropTypes.shape({
additionalRadius: PropTypes.number,
color: PropTypes.string,
cornerRadius: PropTypes.number,
innerRadius: PropTypes.number,
outerRadius: PropTypes.number,
paddingAngle: PropTypes.number
}),
highlightScope: PropTypes.shape({
faded: PropTypes.oneOf(['global', 'none', 'series']),
highlighted: PropTypes.oneOf(['item', 'none', 'series'])
}),
id: PropTypes.string,
innerRadius: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
outerRadius: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
paddingAngle: PropTypes.number,
sortingValues: PropTypes.oneOfType([PropTypes.oneOf(['asc', 'desc', 'none']), PropTypes.func]),
startAngle: PropTypes.number,
type: PropTypes.oneOf(['pie']),
valueFormatter: PropTypes.func
})).isRequired,
/**
* If `true`, animations are skiped.
* @default false
*/
skipAnimation: PropTypes.bool,
/**
* The props used for each component slot.
* @default {}
*/
slotProps: PropTypes.object,
slots: PropTypes.object,
sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
title: PropTypes.string,
tooltip: PropTypes.shape({
axisContent: PropTypes.elementType,
classes: PropTypes.object,
itemContent: PropTypes.elementType,
slotProps: PropTypes.object,
slots: PropTypes.object,
trigger: PropTypes.oneOf(['axis', 'item', 'none'])
}),
/**
* Indicate which axis to display the top of the charts.
* Can be a string (the id of the axis) or an object `ChartsXAxisProps`.
* @default null
*/
topAxis: PropTypes.oneOfType([PropTypes.shape({
axisId: PropTypes.string,
classes: PropTypes.object,
disableLine: PropTypes.bool,
disableTicks: PropTypes.bool,
fill: PropTypes.string,
label: PropTypes.string,
labelFontSize: PropTypes.number,
labelStyle: PropTypes.object,
position: PropTypes.oneOf(['bottom', 'top']),
slotProps: PropTypes.object,
slots: PropTypes.object,
stroke: PropTypes.string,
tickFontSize: PropTypes.number,
tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
tickLabelStyle: PropTypes.object,
tickMaxStep: PropTypes.number,
tickMinStep: PropTypes.number,
tickNumber: PropTypes.number,
tickSize: PropTypes.number
}), PropTypes.string]),
viewBox: PropTypes.shape({
height: PropTypes.number,
width: PropTypes.number,
x: PropTypes.number,
y: PropTypes.number
}),
/**
* The width of the chart in px. If not defined, it takes the width of the parent element.
* @default undefined
*/
width: PropTypes.number,
/**
* The configuration of the x-axes.
* If not provided, a default axis config is used with id set to `DEFAULT_X_AXIS_KEY`.
*/
xAxis: PropTypes.arrayOf(PropTypes.shape({
axisId: PropTypes.string,
classes: PropTypes.object,
data: PropTypes.array,
dataKey: PropTypes.string,
disableLine: PropTypes.bool,
disableTicks: PropTypes.bool,
fill: PropTypes.string,
hideTooltip: PropTypes.bool,
id: PropTypes.string,
label: PropTypes.string,
labelFontSize: PropTypes.number,
labelStyle: PropTypes.object,
max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
position: PropTypes.oneOf(['bottom', 'left', 'right', 'top']),
scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
slotProps: PropTypes.object,
slots: PropTypes.object,
stroke: PropTypes.string,
tickFontSize: PropTypes.number,
tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
tickLabelStyle: PropTypes.object,
tickMaxStep: PropTypes.number,
tickMinStep: PropTypes.number,
tickNumber: PropTypes.number,
tickSize: PropTypes.number,
valueFormatter: PropTypes.func
})),
/**
* The configuration of the y-axes.
* If not provided, a default axis config is used with id set to `DEFAULT_Y_AXIS_KEY`.
*/
yAxis: PropTypes.arrayOf(PropTypes.shape({
axisId: PropTypes.string,
classes: PropTypes.object,
data: PropTypes.array,
dataKey: PropTypes.string,
disableLine: PropTypes.bool,
disableTicks: PropTypes.bool,
fill: PropTypes.string,
hideTooltip: PropTypes.bool,
id: PropTypes.string,
label: PropTypes.string,
labelFontSize: PropTypes.number,
labelStyle: PropTypes.object,
max: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
min: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.number]),
position: PropTypes.oneOf(['bottom', 'left', 'right', 'top']),
scaleType: PropTypes.oneOf(['band', 'linear', 'log', 'point', 'pow', 'sqrt', 'time', 'utc']),
slotProps: PropTypes.object,
slots: PropTypes.object,
stroke: PropTypes.string,
tickFontSize: PropTypes.number,
tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
tickLabelStyle: PropTypes.object,
tickMaxStep: PropTypes.number,
tickMinStep: PropTypes.number,
tickNumber: PropTypes.number,
tickSize: PropTypes.number,
valueFormatter: PropTypes.func
}))
} : void 0;
export { PieChart };