Skip to content
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

feat(MCDA): 19032 Append units to custom axis labels in MCDA dropdown #805

Merged
Merged
Show file tree
Hide file tree
Changes from 3 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
9 changes: 7 additions & 2 deletions src/utils/bivariate/helpers/converters/axisDTOtoAxis.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
import { formatBivariateAxisLabel } from '~utils/bivariate/labelFormatters';
import {
formatBivariateAxisLabel,
formatCustomLabelForBivariateAxis,
} from '~utils/bivariate/labelFormatters';
import type { AxisDTO } from '~core/resources/bivariateStatisticsResource/types';
import type { Axis } from '~utils/bivariate/types/stat.types';

export function axisDTOtoAxis(dto: AxisDTO): Axis {
return {
...dto,
id: dto.quotient.join('|'),
label: dto.label || formatBivariateAxisLabel(dto.quotients),
label: dto.label
? formatCustomLabelForBivariateAxis(dto.label, dto.quotients)
: formatBivariateAxisLabel(dto.quotients),
albaranau marked this conversation as resolved.
Show resolved Hide resolved
};
}
66 changes: 65 additions & 1 deletion src/utils/bivariate/labelFormatters.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { expect, describe, it } from 'vitest';
import { hasUnits, formatBivariateAxisLabel } from './labelFormatters';
import {
hasUnits,
formatBivariateAxisLabel,
formatCustomLabelForBivariateAxis,
} from './labelFormatters';
import type { Axis } from '~utils/bivariate';

describe('BivariateLegend labels formatting', () => {
Expand Down Expand Up @@ -118,4 +122,64 @@ describe('BivariateLegend labels formatting', () => {
);
});
});

describe('formatCustomLabelForBivariateAxis', () => {
it('must return customLabel with units from quotients', () => {
const quotients: Axis['quotients'] = [
{
name: 'total_road_length',
label: 'Total road length',
direction: [['unimportant'], ['important']],
unit: {
id: 'km',
shortName: 'km',
longName: 'kilometers',
},
},
{
name: 'population',
label: 'Population',
direction: [['unimportant'], ['important']],
unit: {
id: 'ppl',
shortName: 'ppl',
longName: 'people',
},
},
];
const customLabel = 'Custom man-distance label';
expect(formatCustomLabelForBivariateAxis(customLabel, quotients)).toEqual(
'Custom man-distance label (km/ppl)',
);
});

it('must return customLabel without units if numerator has no unit', () => {
const quotients: Axis['quotients'] = [
{
name: 'total_road_length',
label: 'Total road length',
direction: [['unimportant'], ['important']],
unit: {
id: null,
shortName: null,
longName: null,
},
},
{
name: 'population',
label: 'Population',
direction: [['unimportant'], ['important']],
unit: {
id: 'ppl',
shortName: 'ppl',
longName: 'people',
},
},
];
const customLabel = 'Custom man-distance label';
expect(formatCustomLabelForBivariateAxis(customLabel, quotients)).toEqual(
'Custom man-distance label',
);
});
});
});
11 changes: 11 additions & 0 deletions src/utils/bivariate/labelFormatters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ export const convertDirectionsArrayToLabel = (directions: string[][]) => {
return `${formatSentimentDirection(from)} → ${formatSentimentDirection(to)}`;
};

export const formatCustomLabelForBivariateAxis = (
customLabel: string,
quotients: Axis['quotients'],
): string => {
const units = formatBivariateAxisUnit(quotients);
albaranau marked this conversation as resolved.
Show resolved Hide resolved
if (units) {
return `${customLabel} (${units})`;
}
return customLabel;
};

export const formatBivariateAxisLabel = (quotients: Axis['quotients']): string => {
if (!quotients) return '';
const [numerator, denominator] = quotients;
Expand Down
Loading