@mui/x-charts
Version:
The community edition of the Charts components (MUI X).
394 lines (390 loc) • 12.3 kB
JavaScript
'use client';
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
import _extends from "@babel/runtime/helpers/esm/extends";
const _excluded = ["scale", "tickNumber", "reverse"];
import * as React from 'react';
import PropTypes from 'prop-types';
import useSlotProps from '@mui/utils/useSlotProps';
import composeClasses from '@mui/utils/composeClasses';
import { useThemeProps, useTheme, styled } from '@mui/material/styles';
import { useCartesianContext } from "../context/CartesianProvider/index.js";
import { useTicks } from "../hooks/useTicks.js";
import { getAxisUtilityClass } from "../ChartsAxis/axisClasses.js";
import { AxisRoot } from "../internals/components/AxisSharedComponents.js";
import { ChartsText } from "../ChartsText/index.js";
import { getMinXTranslation } from "../internals/geometry.js";
import { useMounted } from "../hooks/useMounted.js";
import { useDrawingArea } from "../hooks/useDrawingArea.js";
import { getWordsByLines } from "../internals/getWordsByLines.js";
import { isInfinity } from "../internals/isInfinity.js";
import { isBandScale } from "../internals/isBandScale.js";
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
const useUtilityClasses = ownerState => {
const {
classes,
position
} = ownerState;
const slots = {
root: ['root', 'directionX', position],
line: ['line'],
tickContainer: ['tickContainer'],
tick: ['tick'],
tickLabel: ['tickLabel'],
label: ['label']
};
return composeClasses(slots, getAxisUtilityClass, classes);
};
function addLabelDimension(xTicks, {
tickLabelStyle: style,
tickLabelInterval,
reverse,
isMounted
}) {
const withDimension = xTicks.map(tick => {
if (!isMounted || tick.formattedValue === undefined) {
return _extends({}, tick, {
width: 0,
height: 0
});
}
const tickSizes = getWordsByLines({
style,
needsComputation: true,
text: tick.formattedValue
});
return _extends({}, tick, {
width: Math.max(...tickSizes.map(size => size.width)),
height: Math.max(tickSizes.length * tickSizes[0].height)
});
});
if (typeof tickLabelInterval === 'function') {
return withDimension.map((item, index) => _extends({}, item, {
skipLabel: !tickLabelInterval(item.value, index)
}));
}
// Filter label to avoid overlap
let currentTextLimit = 0;
let previousTextLimit = 0;
const direction = reverse ? -1 : 1;
return withDimension.map((item, labelIndex) => {
const {
width,
offset,
labelOffset,
height
} = item;
const distance = getMinXTranslation(width, height, style?.angle);
const textPosition = offset + labelOffset;
const gapRatio = 1.2; // Ratio applied to the minimal distance to add some margin.
currentTextLimit = textPosition - direction * (gapRatio * distance) / 2;
if (labelIndex > 0 && direction * currentTextLimit < direction * previousTextLimit) {
// Except for the first label, we skip all label that overlap with the last accepted.
// Notice that the early return prevents `previousTextLimit` from being updated.
return _extends({}, item, {
skipLabel: true
});
}
previousTextLimit = textPosition + direction * (gapRatio * distance) / 2;
return item;
});
}
const XAxisRoot = styled(AxisRoot, {
name: 'MuiChartsXAxis',
slot: 'Root',
overridesResolver: (props, styles) => styles.root
})({});
const defaultProps = {
position: 'bottom',
disableLine: false,
disableTicks: false,
tickSize: 6
};
/**
* Demos:
*
* - [Axis](https://mui.com/x/react-charts/axis/)
*
* API:
*
* - [ChartsXAxis API](https://mui.com/x/api/charts/charts-x-axis/)
*/
function ChartsXAxis(inProps) {
const {
xAxisIds,
xAxis
} = useCartesianContext();
const _xAxis = xAxis[inProps.axisId ?? xAxisIds[0]],
{
scale: xScale,
tickNumber,
reverse
} = _xAxis,
settings = _objectWithoutPropertiesLoose(_xAxis, _excluded);
const isMounted = useMounted();
const themedProps = useThemeProps({
props: _extends({}, settings, inProps),
name: 'MuiChartsXAxis'
});
const defaultizedProps = _extends({}, defaultProps, themedProps);
const {
position,
disableLine,
disableTicks,
tickLabelStyle,
label,
labelStyle,
tickFontSize,
labelFontSize,
tickSize: tickSizeProp,
valueFormatter,
slots,
slotProps,
tickInterval,
tickLabelInterval,
tickPlacement,
tickLabelPlacement,
sx
} = defaultizedProps;
const theme = useTheme();
const classes = useUtilityClasses(_extends({}, defaultizedProps, {
theme
}));
const {
left,
top,
width,
height,
isPointInside
} = useDrawingArea();
const tickSize = disableTicks ? 4 : tickSizeProp;
const positionSign = position === 'bottom' ? 1 : -1;
const Line = slots?.axisLine ?? 'line';
const Tick = slots?.axisTick ?? 'line';
const TickLabel = slots?.axisTickLabel ?? ChartsText;
const Label = slots?.axisLabel ?? ChartsText;
const axisTickLabelProps = useSlotProps({
elementType: TickLabel,
externalSlotProps: slotProps?.axisTickLabel,
additionalProps: {
style: _extends({
textAnchor: 'middle',
dominantBaseline: position === 'bottom' ? 'hanging' : 'auto',
fontSize: tickFontSize ?? 12
}, tickLabelStyle)
},
className: classes.tickLabel,
ownerState: {}
});
const xTicks = useTicks({
scale: xScale,
tickNumber,
valueFormatter,
tickInterval,
tickPlacement,
tickLabelPlacement
});
const xTicksWithDimension = addLabelDimension(xTicks, {
tickLabelStyle: axisTickLabelProps.style,
tickLabelInterval,
reverse,
isMounted
});
const labelRefPoint = {
x: left + width / 2,
y: positionSign * (tickSize + 22)
};
const axisLabelProps = useSlotProps({
elementType: Label,
externalSlotProps: slotProps?.axisLabel,
additionalProps: {
style: _extends({
fontSize: labelFontSize ?? 14,
textAnchor: 'middle',
dominantBaseline: position === 'bottom' ? 'hanging' : 'auto'
}, labelStyle)
},
ownerState: {}
});
const domain = xScale.domain();
const ordinalAxis = isBandScale(xScale);
// Skip axis rendering if no data is available
// - The domain is an empty array for band/point scales.
// - The domains contains Infinity for continuous scales.
if (ordinalAxis && domain.length === 0 || !ordinalAxis && domain.some(isInfinity)) {
return null;
}
return /*#__PURE__*/_jsxs(XAxisRoot, {
transform: `translate(0, ${position === 'bottom' ? top + height : top})`,
className: classes.root,
sx: sx,
children: [!disableLine && /*#__PURE__*/_jsx(Line, _extends({
x1: left,
x2: left + width,
className: classes.line
}, slotProps?.axisLine)), xTicksWithDimension.map(({
formattedValue,
offset,
labelOffset,
skipLabel
}, index) => {
const xTickLabel = labelOffset ?? 0;
const yTickLabel = positionSign * (tickSize + 3);
const showTick = isPointInside({
x: offset,
y: -1
}, {
direction: 'x'
});
const showTickLabel = isPointInside({
x: offset + xTickLabel,
y: -1
}, {
direction: 'x'
});
return /*#__PURE__*/_jsxs("g", {
transform: `translate(${offset}, 0)`,
className: classes.tickContainer,
children: [!disableTicks && showTick && /*#__PURE__*/_jsx(Tick, _extends({
y2: positionSign * tickSize,
className: classes.tick
}, slotProps?.axisTick)), formattedValue !== undefined && !skipLabel && showTickLabel && /*#__PURE__*/_jsx(TickLabel, _extends({
x: xTickLabel,
y: yTickLabel
}, axisTickLabelProps, {
text: formattedValue.toString()
}))]
}, index);
}), label && /*#__PURE__*/_jsx("g", {
className: classes.label,
children: /*#__PURE__*/_jsx(Label, _extends({}, labelRefPoint, axisLabelProps, {
text: label
}))
})]
});
}
process.env.NODE_ENV !== "production" ? ChartsXAxis.propTypes = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit the TypeScript types and run "pnpm proptypes" |
// ----------------------------------------------------------------------
/**
* The id of the axis to render.
* If undefined, it will be the first defined axis.
*/
axisId: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
/**
* Override or extend the styles applied to the component.
*/
classes: PropTypes.object,
/**
* If true, the axis line is disabled.
* @default false
*/
disableLine: PropTypes.bool,
/**
* If true, the ticks are disabled.
* @default false
*/
disableTicks: PropTypes.bool,
/**
* The fill color of the axis text.
* @default 'currentColor'
*/
fill: PropTypes.string,
/**
* The label of the axis.
*/
label: PropTypes.string,
/**
* The font size of the axis label.
* @default 14
* @deprecated Consider using `labelStyle.fontSize` instead.
*/
labelFontSize: PropTypes.number,
/**
* The style applied to the axis label.
*/
labelStyle: PropTypes.object,
/**
* Position of the axis.
*/
position: PropTypes.oneOf(['bottom', 'top']),
/**
* The props used for each component slot.
* @default {}
*/
slotProps: PropTypes.object,
/**
* Overridable component slots.
* @default {}
*/
slots: PropTypes.object,
/**
* The stroke color of the axis line.
* @default 'currentColor'
*/
stroke: PropTypes.string,
sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
/**
* The font size of the axis ticks text.
* @default 12
* @deprecated Consider using `tickLabelStyle.fontSize` instead.
*/
tickFontSize: PropTypes.number,
/**
* Defines which ticks are displayed.
* Its value can be:
* - 'auto' In such case the ticks are computed based on axis scale and other parameters.
* - a filtering function of the form `(value, index) => boolean` which is available only if the axis has "point" scale.
* - an array containing the values where ticks should be displayed.
* @see See {@link https://mui.com/x/react-charts/axis/#fixed-tick-positions}
* @default 'auto'
*/
tickInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.array, PropTypes.func]),
/**
* Defines which ticks get its label displayed. Its value can be:
* - 'auto' In such case, labels are displayed if they do not overlap with the previous one.
* - a filtering function of the form (value, index) => boolean. Warning: the index is tick index, not data ones.
* @default 'auto'
*/
tickLabelInterval: PropTypes.oneOfType([PropTypes.oneOf(['auto']), PropTypes.func]),
/**
* The placement of ticks label. Can be the middle of the band, or the tick position.
* Only used if scale is 'band'.
* @default 'middle'
*/
tickLabelPlacement: PropTypes.oneOf(['middle', 'tick']),
/**
* The style applied to ticks text.
*/
tickLabelStyle: PropTypes.object,
/**
* Maximal step between two ticks.
* When using time data, the value is assumed to be in ms.
* Not supported by categorical axis (band, points).
*/
tickMaxStep: PropTypes.number,
/**
* Minimal step between two ticks.
* When using time data, the value is assumed to be in ms.
* Not supported by categorical axis (band, points).
*/
tickMinStep: PropTypes.number,
/**
* The number of ticks. This number is not guaranteed.
* Not supported by categorical axis (band, points).
*/
tickNumber: PropTypes.number,
/**
* The placement of ticks in regard to the band interval.
* Only used if scale is 'band'.
* @default 'extremities'
*/
tickPlacement: PropTypes.oneOf(['end', 'extremities', 'middle', 'start']),
/**
* The size of the ticks.
* @default 6
*/
tickSize: PropTypes.number
} : void 0;
export { ChartsXAxis };