fix(custom): optionally return category from value(). close #12952

[LemniscateX]

Signed-off-by: LemniscateX [email protected]

Brief Information

This pull request is in the type of:

• bug fixing

What does this PR do?

Fix value() method of parameter api in custom renderItem from returning unexpected ordinal index.

Fixed issues

Fix #12952

Details

Before: What was the problem?

RenderItem's data construction will use the ordinal index of dimension x instead of its raw value. Current value() implementation will return this ordinal index.

After: How is it fixed in this PR?

Add detect logic to value() to check if dim is dimension x. If so, return its raw value from ordinalMeta.categories.

[echarts-bot]

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.

[chfw]

First time I learnt that '&&' can be used this way!

[100pah]

@pissang @LemniscateX

I am not sure about the behavior of this API value().

Current behavior:

• If the dimension is in type of 'ordinal', and the dimension is used by an 'category' axis, value() returns the ordinal number rather than the original category string.
• Else value() returns the original category string.

If we change the behavior like the PR did:
In all cases value() returns the original category string.
The two issues need to be considered.

1. It is a break change. And in some cases that might not easy to fix that, because users might not know how to get the ordinal number.
2. As 1 mentioned, users might need to get the ordinal number, which might be used to calculate the coordinate or retrieve something as an index.

So I prefer not to modify the behavior of value().

But since 5.0 there is an extra api ordinalRawValue() provided, but not documented, but used in an test/custom-shape-morphing3.html. The behavior is:

• If the original value is 'hahaha' and the dimension type is 'ordinal', rawValue() always returns 'hahaha' whether this dimension is used by a category axis or not.
• In other cases, it is the same as value() did.

Is ordinalRawValue() it enough for this issue? Or anything else ideas?

[LemniscateX]

@pissang @LemniscateX

I am not sure about the behavior of this API value().

Current behavior:

• If the dimension is in type of 'ordinal', and the dimension is used by an 'category' axis, value() returns the ordinal number rather than the original category string.
• Else value() returns the original category string.

If we change the behavior like the PR did:
In all cases value() returns the original category string.
The two issues need to be considered.

1. It is a break change. And in some cases that might not easy to fix that, because users might not know how to get the ordinal number.
2. As 1 mentioned, users might need to get the ordinal number, which might be used to calculate the coordinate or retrieve something as an index.

So I prefer not to modify the behavior of value().

But since 5.0 there is an extra api ordinalRawValue() provided, but not documented, but used in an test/custom-shape-morphing3.html. The behavior is:

• If the original value is 'hahaha' and the dimension type is 'ordinal', rawValue() always returns 'hahaha' whether this dimension is used by a category axis or not.
• In other cases, it is the same as value() did.

Is ordinalRawValue() it enough for this issue? Or anything else ideas?

I agree with you that ordinalRawValue() can meet the demand of getting original value no matter what the data type it is, and as well as to fix the issue.

It just seems that value() is out of users' expectation when it comes to dimension x. I guess a little bit mention in document would be better. XD