fix(option): avoid incorrectly requiring TimelineComponent when media is used without timeline#21694
Open
Raman-Katiyar wants to merge 1 commit into
Open
fix(option): avoid incorrectly requiring TimelineComponent when media is used without timeline#21694Raman-Katiyar wants to merge 1 commit into
Raman-Katiyar wants to merge 1 commit into
Conversation
… is used without timeline
|
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. |
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?
It fixes a bug where
TimelineComponentis incorrectly required when responsivemediaoptions are specified, even if no timeline is actually used in the chart configuration. This happens becausebaseOption.timelinewas being assignedtimelineOnRooteven when it wasundefined, causing the core component loader to falsely detect timeline usage.Fixed issues
Details
Before: What was the problem?
When developers used modular imports (without importing the
TimelineComponent) alongside responsivemediaqueries, ECharts threw the following error:Error: Component timeline is used but not imported.This issue occurred in
OptionManager.ts. The code was assigning the value oftimelineOnRoottobaseOption.timelineeven whentimelineOnRootwasundefined. In JavaScript, explicitly assigningundefinedto an object property still registers the key on that object. Consequently, when the core component loader performed a property existence check (usinginorhasOwnProperty), it detected the presence of'timeline'on the option object and assumed a timeline was in use, resulting in an error because the component hadn't been imported.After: How does it behave after the fixing?
With this change,
baseOption.timelineis only assigned iftimelineOnRootis defined. This prevents the'timeline'key from being incorrectly registered on thebaseOptionwhen no timeline is actively configured. As a result, responsive media queries now render successfully without triggering the incorrectTimelineComponentdependency error.Document Info
One of the following should be checked.
Misc
Security Checking
ZRender Changes
Related test cases or examples to use the new APIs
N.A.
Merging options
Other information
This is a clean logical fix for the bug reported in #21686. It does not introduce any breaking changes or require modifications to the documentation. Thanks to the maintainers for reviewing!