Codestin Search App

Justin-ZS · 2025-12-04T09:59:32Z

Brief Information

This pull request is in the type of:

bug fixing
new feature
others

What does this PR do?

Fix matrix label formatter not working.

demo

Fixed issues

[Bug] 矩阵图matrix.y.label格式化无效？The x and y label formatting of the matrix diagram is invalid? #21403

Details

Before: What was the problem?

matrix.x.label.formatter and matrix.y.label.formatter were ignored.

After: How does it behave after the fixing?

Label formatter now works correctly for matrix axes.

Document Info

This PR doesn't relate to document changes
The document should be updated later
The document changes have been made in apache/echarts-doc#xxx

Misc

Security Checking

This PR uses security-sensitive Web APIs.

ZRender Changes

This PR depends on ZRender changes (ecomfe/zrender#xxx).

Related test cases or examples to use the new APIs

test/matrix-label-formatter.html

Merging options

Please squash the commits into a single one when merging.

Other information

echarts-bot · 2025-12-04T09:59:41Z

Thanks for your contribution!
The community will review it ASAP. In the meanwhile, please checkout the coding standard and Wiki about How to make a pull request.

Please DO NOT commit the files in dist, i18n, and ssr/client/dist folders in a non-release pull request. These folders are for release use only.

github-actions · 2025-12-04T10:05:41Z

The changes brought by this PR can be previewed at: https://echarts.apache.org/examples/editor?version=PR-21410@819208a

Copilot

Pull request overview

This pull request fixes a bug where the matrix.x.label.formatter and matrix.y.label.formatter options were being ignored. The fix adds proper formatter support for matrix axis labels by implementing both string template and function formatters.

Key Changes

Added MatrixLabelOption and MatrixLabelFormatterParams interfaces to define the formatter types
Implemented formatter logic in createMatrixCell function to handle both string and function formatters
Added comprehensive test cases covering function formatters, string template formatters, and nested structures

Reviewed changes

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

File	Description
src/coord/matrix/MatrixModel.ts	Added `MatrixLabelOption` interface extending `LabelOption` with custom formatter signature, and `MatrixLabelFormatterParams` interface defining the parameters passed to formatter functions
src/component/matrix/MatrixView.ts	Implemented formatter logic by checking for formatter configuration, creating params object, and applying either function or string template formatting to cell text values
test/matrix-label-formatter.html	Added three test cases verifying function formatters with emojis, string template formatters with heatmap series, and formatters with nested data structures

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-10T06:14:23Z

+            if (isFunction(formatter)) {
+                const formattedText = formatter(params);
+                if (formattedText != null) {
+                    text = formattedText + '';
+                }
+            }
+            else if (isString(formatter)) {
+                text = formatTplSimple(formatter, params);
+            }


[nitpick] The order of checks should be isString(formatter) first, then isFunction(formatter) to maintain consistency with the rest of the codebase. See similar patterns in src/component/axisPointer/viewHelper.ts:181-184, src/component/tooltip/TooltipView.ts:837-847, and src/component/calendar/CalendarView.ts:232-237.

Suggested change

if (isFunction(formatter)) {

const formattedText = formatter(params);

if (formattedText != null) {

text = formattedText + '';

}

}

else if (isString(formatter)) {

text = formatTplSimple(formatter, params);

}

if (isString(formatter)) {

text = formatTplSimple(formatter, params);

}

else if (isFunction(formatter)) {

const formattedText = formatter(params);

if (formattedText != null) {

text = formattedText + '';

}

}

A nice-to-have suggestion. Not a must.

Copilot · 2025-12-10T06:14:24Z

+    name: string;
+    value: unknown;
+    xyLocator: MatrixXYLocator[];
+    $vars: readonly ['name', 'value', 'xyLocator'];


[nitpick] The readonly modifier on $vars is inconsistent with other FormatterParams interfaces in the codebase. For consistency with interfaces like ToolboxTooltipFormatterParams, LegendTooltipFormatterParams, and GeoTooltipFormatterParams, this should be $vars: ['name', 'value', 'xyLocator'] without the readonly modifier.

Suggested change

$vars: readonly ['name', 'value', 'xyLocator'];

$vars: ['name', 'value', 'xyLocator'];

I see other places using readonly, although not $vars, and it's reasonable to use it here.

Copilot · 2025-12-10T06:14:24Z

+                },
+            };
+
+            var chart = testHelper.create(echarts, 'main0', {


Unused variable chart.

Suggested change

var chart = testHelper.create(echarts, 'main0', {

testHelper.create(echarts, 'main0', {

Copilot · 2025-12-10T06:14:24Z

+                }
+            };
+
+            var chart = testHelper.create(echarts, 'main1', {


Unused variable chart.

Suggested change

var chart = testHelper.create(echarts, 'main1', {

testHelper.create(echarts, 'main1', {

Copilot · 2025-12-10T06:14:25Z

+                }
+            };
+
+            var chart = testHelper.create(echarts, 'main2', {


Unused variable chart.

Suggested change

var chart = testHelper.create(echarts, 'main2', {

testHelper.create(echarts, 'main2', {

Ovilia

Checked visual tests of matrix and are all good.

Ovilia · 2025-12-10T06:18:48Z

+            if (isFunction(formatter)) {
+                const formattedText = formatter(params);
+                if (formattedText != null) {
+                    text = formattedText + '';
+                }
+            }
+            else if (isString(formatter)) {
+                text = formatTplSimple(formatter, params);
+            }


A nice-to-have suggestion. Not a must.

Ovilia · 2025-12-10T06:21:08Z

+                name: text,
+                value: textValue as unknown,
+                xyLocator: xyLocator.slice() as MatrixXYLocator[],
+                $vars: ['name', 'value', 'xyLocator'] as const


I would suggest using 'coord' instead of 'xyLocatoer' to align with MatrixBodyCornerCellOption.coord.

Ovilia · 2025-12-10T06:25:34Z

+    name: string;
+    value: unknown;
+    xyLocator: MatrixXYLocator[];
+    $vars: readonly ['name', 'value', 'xyLocator'];


I see other places using readonly, although not $vars, and it's reasonable to use it here.

echarts-bot · 2025-12-15T02:22:46Z

Congratulations! Your PR has been merged. Thanks for your contribution! 👍

pull-request-size Bot added the size/M label Dec 4, 2025

echarts-bot Bot added PR: awaiting review PR: doc unchanged labels Dec 4, 2025

Justin-ZS requested review from 100pah and Ovilia December 4, 2025 09:59

fix(matrix): label formatter not work

09c721f

Justin-ZS force-pushed the fix/21403 branch from ac2c57e to 09c721f Compare December 4, 2025 10:04

Ovilia requested a review from Copilot December 10, 2025 06:09

Copilot started reviewing on behalf of Ovilia December 10, 2025 06:09 View session

Copilot AI reviewed Dec 10, 2025

View reviewed changes

Ovilia requested changes Dec 10, 2025

View reviewed changes

echarts-bot Bot added PR: revision needed and removed PR: awaiting review labels Dec 10, 2025

fix: code review

819208a

echarts-bot Bot added PR: awaiting review and removed PR: revision needed labels Dec 10, 2025

Justin-ZS requested a review from Ovilia December 10, 2025 10:24

Ovilia approved these changes Dec 15, 2025

View reviewed changes

echarts-bot Bot removed the PR: awaiting review label Dec 15, 2025

Ovilia merged commit ba79acf into apache:master Dec 15, 2025
2 checks passed

Ovilia added this to the 6.0.1 milestone Dec 15, 2025

plainheart changed the title ~~fix(matrix): label formatter not work~~ fix(matrix): fix matrix label formatter does not work Dec 16, 2025

	$vars: readonly ['name', 'value', 'xyLocator'];
	$vars: ['name', 'value', 'xyLocator'];

	var chart = testHelper.create(echarts, 'main0', {
	testHelper.create(echarts, 'main0', {

	var chart = testHelper.create(echarts, 'main1', {
	testHelper.create(echarts, 'main1', {

	var chart = testHelper.create(echarts, 'main2', {
	testHelper.create(echarts, 'main2', {

Conversation

Justin-ZS commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Brief Information

What does this PR do?

Fixed issues

Details

Before: What was the problem?

After: How does it behave after the fixing?

Document Info

Misc

Security Checking

ZRender Changes

Related test cases or examples to use the new APIs

Merging options

Other information

Uh oh!

echarts-bot Bot commented Dec 4, 2025

Uh oh!

github-actions Bot commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Ovilia Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Justin-ZS Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Ovilia Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Ovilia left a comment

Choose a reason for hiding this comment

Uh oh!

Ovilia Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Ovilia Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Justin-ZS Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Ovilia Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

echarts-bot Bot commented Dec 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Justin-ZS commented Dec 4, 2025 •

edited

Loading

github-actions Bot commented Dec 4, 2025 •

edited

Loading