Skip to content

[charts] Fix infinite tick number when zoom range is zero #17750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions packages/x-charts/src/hooks/useTicks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,24 +46,6 @@ export interface TickParams {
tickLabelPlacement?: 'middle' | 'tick';
}

export function getTickNumber(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to ticks

params: TickParams & {
range: number[];
domain: any[];
},
) {
const { tickMaxStep, tickMinStep, tickNumber, range, domain } = params;

const maxTicks =
tickMinStep === undefined ? 999 : Math.floor(Math.abs(domain[1] - domain[0]) / tickMinStep);
const minTicks =
tickMaxStep === undefined ? 2 : Math.ceil(Math.abs(domain[1] - domain[0]) / tickMaxStep);

const defaultizedTickNumber = tickNumber ?? Math.floor(Math.abs(range[1] - range[0]) / 50);

return Math.min(maxTicks, Math.max(minTicks, defaultizedTickNumber));
}

const offsetRatio = {
start: 0,
extremities: 0,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
} from '../../../../models/axis';
import { CartesianChartSeriesType, ChartSeriesType } from '../../../../models/seriesType/config';
import { getColorScale, getOrdinalColorScale } from '../../../colorScale';
import { getTickNumber } from '../../../../hooks/useTicks';
import { getTickNumber, scaleTickNumberByRange } from '../../../ticks';
import { getScale } from '../../../getScale';
import { zoomScaleRange } from './zoom';
import { getAxisExtremum } from './getAxisExtremum';
Expand Down Expand Up @@ -200,7 +200,7 @@ export function computeAxisValue<T extends ChartSeriesType>({
}

const rawTickNumber = getTickNumber({ ...axis, range, domain: axisExtremums });
const tickNumber = rawTickNumber / ((zoomRange[1] - zoomRange[0]) / 100);
const tickNumber = scaleTickNumberByRange(rawTickNumber, zoomRange);

const zoomedRange = zoomScaleRange(range, zoomRange);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
} from '../../../../models/axis';
import { ChartSeriesType, PolarChartSeriesType } from '../../../../models/seriesType/config';
import { getColorScale, getOrdinalColorScale } from '../../../colorScale';
import { getTickNumber } from '../../../../hooks/useTicks';
import { getTickNumber, scaleTickNumberByRange } from '../../../ticks';
import { getScale } from '../../../getScale';
import { getAxisExtremum } from './getAxisExtremum';
import type { ChartDrawingArea } from '../../../../hooks';
Expand Down Expand Up @@ -200,7 +200,7 @@ export function computeAxisValue<T extends ChartSeriesType>({
}

const rawTickNumber = getTickNumber({ ...axis, range, domain: axisExtremums });
const tickNumber = rawTickNumber / ((range[1] - range[0]) / 100);
const tickNumber = scaleTickNumberByRange(rawTickNumber, range);

const scale = getScale(scaleType, axisExtremums, range);
const finalScale = domainLimit === 'nice' ? scale.nice(rawTickNumber) : scale;
Expand Down
14 changes: 14 additions & 0 deletions packages/x-charts/src/internals/ticks.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { expect } from 'chai';
import { scaleTickNumberByRange } from './ticks';

describe('scaleTickNumberByRange', () => {
it('should return 1 when rangeGap is 0 (range start and end are the same)', () => {
const result = scaleTickNumberByRange(10, [50, 50]);
expect(result).to.equal(1);
});

it('should correctly scale tickNumber based on range', () => {
const result = scaleTickNumberByRange(100, [0, 50]);
expect(result).to.equal(200);
});
});
30 changes: 30 additions & 0 deletions packages/x-charts/src/internals/ticks.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import type { TickParams } from '../hooks/useTicks';

export function getTickNumber(
params: TickParams & {
range: number[];
domain: any[];
},
) {
const { tickMaxStep, tickMinStep, tickNumber, range, domain } = params;

const maxTicks =
tickMinStep === undefined ? 999 : Math.floor(Math.abs(domain[1] - domain[0]) / tickMinStep);
const minTicks =
tickMaxStep === undefined ? 2 : Math.ceil(Math.abs(domain[1] - domain[0]) / tickMaxStep);

const defaultizedTickNumber = tickNumber ?? Math.floor(Math.abs(range[1] - range[0]) / 50);

return Math.min(maxTicks, Math.max(minTicks, defaultizedTickNumber));
}

export function scaleTickNumberByRange(tickNumber: number, range: number[]) {
const rangeGap = range[1] - range[0];

/* If the range start and end are the same, `tickNumber` will become infinity, so we default to 1. */
if (rangeGap === 0) {
return 1;
}

return tickNumber / ((range[1] - range[0]) / 100);
}