Skip to content

Commit 5a4ec1e

Browse files
Update docs
1 parent 43ed4ac commit 5a4ec1e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

packages/x-charts-pro/src/internals/plugins/useChartProZoom/calculateZoom.ts

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ import { DefaultizedZoomOptions, ZoomData } from '@mui/x-charts/internals';
22

33
/**
44
* Calculates the new zoom range based on the current zoom, step, and constraints.
5+
*
6+
* A step of 0.1 or -0.1 means that 10% of the current range will be subtracted/added, respectively, and assuming no
7+
* constraints (e.g., minSpan, maxEnd) are faced.
8+
*
59
* @param zoom Current zoom range with start and end values.
610
* @param step Percentage of the current zoom range to adjust (positive to zoom in, negative to zoom out). Ranges from 0 to 1.
711
* @param minSpan Minimum allowed span between start and end values.

0 commit comments

Comments
 (0)