fix(type): allow null/undefined for axis min and max option - #21747
Merged
plainheart merged 1 commit intoSep 4, 2026
Conversation
|
Thanks for your contribution! 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. |
plainheart
requested changes
Sep 4, 2026
plainheart
left a comment
Member
There was a problem hiding this comment.
Hi, the change looks good to me. Can you change the target branch to the release branch?
hannnnxiiii
force-pushed
the
fix-axis-min-max-nullable-type
branch
from
September 4, 2026 02:40
1aba2ce to
7d8ad6b
Compare
Author
|
Thanks! I've changed the target branch to release and rebased the changes onto it. |
plainheart
approved these changes
Sep 4, 2026
|
Congratulations! Your PR has been merged. Thanks for your contribution! 👍 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brief Information
This pull request is in the type of:
What does this PR do?
Allow
null/undefinedto be passed as direct values of the axismin/maxoption in the TypeScript type definitions, since they are already supported at runtime and documented.Fixed issues
min/maxoption does not acceptnull/undefinedas direct value in TypeScript #21746Details
Before: What was the problem?
Setting
xAxis/yAxismin/maxdirectly tonull/undefinedfailed TypeScript compilation (withstrictNullChecksenabled):#21313 added
NullUndefinedonly to the function return type ofmin/max, but not to the direct value union. SinceScaleDataValue(number | string | Date) does not includenull, passing it directly still failed the type check, although the JSDoc above the option documentsnull/undefined: auto decide min valueand it works at runtime.After: How does it behave after the fixing?
Added
NullUndefinedto the direct value union of themin/maxoption type insrc/coord/axisCommonTypes.ts:null/undefinednow type-check both as direct values and as function return values, matching the documented behavior (https://echarts.apache.org/en/option.html#yAxis.max).Document Info
One of the following should be checked.
Misc
Security Checking
ZRender Changes
Related test cases or examples to use the new APIs
Added a type test case
test/types/esm/axisMinMaxNullable.ts, which covers both the direct value form (min: null,max: undefined) and the function form (min: () => null,max: () => undefined), verified withnpm run test:dts:fastunder strict mode across TypeScript 3.5 – 5.9.Merging options
Other information