fix(heatmap): y-axis sorts in order by sfirke · Pull Request #36302 · apache/superset

sfirke · 2025-11-27T04:31:05Z

SUMMARY

Fixes #33245. Replaces the attempt in #34547.

Note: I leaned heavily on AI coding assistance for this PR since I'm still new to TypeScript. The logic makes sense to me and I verified the desired behaviors in my test environment, but someone familiar with TypeScript should review with care.

I left the addition to .gitignore in, it seems like a developer pattern that might help others.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

BEFORE - 6.0.0rc3

The y-axis is out of order:

AFTER

Y-axis order is correct:

TESTING INSTRUCTIONS

Tests included. I deployed to my test environment and checked ascending and descending for y- and x-axes of numeric and categorical variables.

ADDITIONAL INFORMATION

Has associated issue: fixes Order of secondary heatmap axis varies based on data (started in 4.1) #33245

ECharts automatically creates axis categories from data in order of first appearance, ignoring SQL ORDER BY. This causes axes to display in incorrect order when some data combinations are missing. Fix by: - Extracting unique axis values from the dataset - Sorting them according to user's sort configuration (sortXAxis/sortYAxis) - Explicitly providing sorted arrays to ECharts via xAxis.data and yAxis.data Supports all sort options: - alpha_asc/alpha_desc: Lexicographic sorting - value_asc/value_desc: Sort by aggregated metric values Fixes apache#33245

Fixes two critical issues with heatmap axis sorting: 1. Series data now uses axis indices instead of raw values - ECharts requires [xIndex, yIndex, value] format when explicit axis data is provided - Previously used [xValue, yValue, value] causing blank rows 2. Numeric values now sort numerically instead of alphabetically - Detects numeric values and sorts them as numbers (1, 2, 10) - Previously sorted as strings resulting in wrong order (1, 10, 2) - Falls back to locale-aware string sorting for non-numeric values Added tests for: - Numeric sorting validation - Axis index conversion - Mixed numeric/string value handling Related to apache#33245

- Import and use DataRecordValue type for better type safety - Add comprehensive JSDoc comments to helper functions - Add explicit Map<DataRecordValue, number> typing - Remove unnecessary type assertions with proper Map typing - Improve code comments for clarity

- Remove superset.code-workspace (should not be committed) - Add *.code-workspace pattern to .gitignore - Consolidate 16 tests down to 8 focused tests: - Merged 4 alphabetical sorting tests into 1 comprehensive test - Removed redundant 'preserve axis data structure' test - Kept all critical tests for bug fixes (numeric sorting, indices) - All 8 tests passing

bito-code-review · 2025-11-27T04:31:15Z

Code Review Agent Run #439ea5

Actionable Suggestions - 0

Review Details

Files reviewed - 2 · Commit Range: eb98140..d5a5438
- superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/transformProps.ts
- superset-frontend/plugins/plugin-chart-echarts/test/Heatmap/transformProps.test.ts
Files skipped - 1
- .gitignore - Reason: Filter setting
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.
/pause - Pauses automatic reviews on this pull request.
/resume - Resumes automatic reviews.
/resolve - Marks all Bito-posted review comments as resolved.
/abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Default Agent You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by

Copilot

Pull request overview

This PR fixes the heatmap y-axis sorting issue (#33245) by implementing proper sorting logic for both x and y axes. The implementation introduces two new helper functions to extract unique axis values and sort them based on user-specified options (alphabetical or by metric value), with special handling for numeric values to ensure they sort numerically rather than lexicographically.

Key Changes:

Added extractUniqueValues() and sortAxisValues() functions to handle axis sorting with support for alphabetical (numeric-aware) and value-based sorting
Modified series data to use axis indices instead of raw values, enabling proper sorted axis display in ECharts
Added comprehensive test coverage with 8 test cases covering various sorting scenarios and edge cases

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

File	Description
superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/transformProps.ts	Core implementation of axis sorting logic and index-based data transformation
superset-frontend/plugins/plugin-chart-echarts/test/Heatmap/transformProps.test.ts	Comprehensive test suite covering sorting scenarios, null handling, and numeric vs alphabetical sorting
.gitignore	Added VS Code workspace files to gitignore

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

…nsformProps.ts

…nsformProps.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

codeant-ai-for-open-source · 2025-12-02T20:39:47Z

CodeAnt AI is reviewing your PR.

codeant-ai-for-open-source · 2025-12-02T20:40:06Z

CodeAnt AI finished reviewing your PR.

…nsformProps.ts

Co-authored-by: Evan Rusackas <evan@preset.io> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> (cherry picked from commit 3345eb3)

Co-authored-by: Evan Rusackas <evan@preset.io> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

sfirke added 4 commits November 26, 2025 14:21

pull-request-size Bot added the size/L label Nov 27, 2025

github-actions Bot added the plugins label Nov 27, 2025

dosubot Bot added the viz:charts:heatmap Related to the Heatmap chart label Nov 27, 2025

tweak .code-workspace exclusion

67ab607

sfirke requested review from Copilot and rusackas December 1, 2025 14:16

Copilot started reviewing on behalf of sfirke December 1, 2025 14:17 View session

Copilot finished reviewing on behalf of sfirke December 1, 2025 14:21

Copilot AI reviewed Dec 1, 2025

View reviewed changes

rusackas requested a review from sadpandajoe December 1, 2025 18:33

rusackas reviewed Dec 1, 2025

View reviewed changes

Comment thread superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/transformProps.ts Outdated

rusackas reviewed Dec 1, 2025

View reviewed changes

Comment thread superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/transformProps.ts Outdated

rusackas and others added 3 commits December 1, 2025 11:11

Update superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/tra…

26478f5

…nsformProps.ts

Update superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/tra…

f6535a6

…nsformProps.ts

Update superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/tra…

879d36c

…nsformProps.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

using logging rather than console

8d2d883

rusackas reviewed Dec 2, 2025

View reviewed changes

Comment thread superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/transformProps.ts Outdated

Update superset-frontend/plugins/plugin-chart-echarts/src/Heatmap/tra…

6e840d2

…nsformProps.ts

rusackas approved these changes Dec 4, 2025

View reviewed changes

rusackas merged commit 3345eb3 into apache:master Dec 4, 2025
63 checks passed

sadpandajoe added the v6.0 Label added by the release manager to track PRs to be included in the 6.0 branch label Dec 4, 2025

sfirke deleted the heatmap_y_axis_sort branch December 4, 2025 21:29

sadpandajoe pushed a commit that referenced this pull request Dec 8, 2025

fix(heatmap): y-axis sorts in order (#36302)

789e7d4

Co-authored-by: Evan Rusackas <evan@preset.io> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> (cherry picked from commit 3345eb3)

sadpandajoe pushed a commit that referenced this pull request Dec 9, 2025

fix(heatmap): y-axis sorts in order (#36302)

1236a85

Co-authored-by: Evan Rusackas <evan@preset.io> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> (cherry picked from commit 3345eb3)

rusackas mentioned this pull request Dec 16, 2025

fix(heatmap): preserve axis order when data combinations are missing #34547

Closed

Facyla pushed a commit to Facyla/superset-contrib that referenced this pull request Dec 16, 2025

fix(heatmap): y-axis sorts in order (apache#36302)

25f30ef

Co-authored-by: Evan Rusackas <evan@preset.io> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

sfirke mentioned this pull request Feb 18, 2026

Echarts Heatmap y-axis sorting logic is not correct when there are empty cells #32591

Closed

3 tasks

This was referenced Mar 7, 2026

fix(heatmap): correct tooltip display to show axis values instead of indices #38487

Merged

fix(heatmap): correct tooltip axis value lookup and percentage calculations and add tests #38522

Closed

dosubot Bot mentioned this pull request Apr 9, 2026

Incorrect behavior in a heatmap when sorting Y axis by metric #39228

Closed

3 tasks

qfcwell pushed a commit to qfcwell/superset that referenced this pull request May 12, 2026

fix(heatmap): y-axis sorts in order (apache#36302)

f531053

Co-authored-by: Evan Rusackas <evan@preset.io> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

yousoph mentioned this pull request Jul 7, 2026

fix(heatmap): correct tooltip axis value lookup and percentage calculations and add tests #41864

Merged

Navigation Menu

Uh oh!

fix(heatmap): y-axis sorts in order - #36302

fix(heatmap): y-axis sorts in order#36302
rusackas merged 10 commits into
apache:masterfrom
sfirke:heatmap_y_axis_sort

sfirke commented Nov 27, 2025 •

edited

Loading

Uh oh!

bito-code-review Bot commented Nov 27, 2025 •

edited

Loading

Code Review Agent Run #439ea5

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codeant-ai-for-open-source Bot commented Dec 2, 2025

Uh oh!

codeant-ai-for-open-source Bot commented Dec 2, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

sfirke commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

Uh oh!

bito-code-review Bot commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #439ea5

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codeant-ai-for-open-source Bot commented Dec 2, 2025

Uh oh!

codeant-ai-for-open-source Bot commented Dec 2, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sfirke commented Nov 27, 2025 •

edited

Loading

bito-code-review Bot commented Nov 27, 2025 •

edited

Loading