-
Notifications
You must be signed in to change notification settings - Fork 13
refactor(charts): remove deprecated method #1313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
BREAKING CHANGE: Removed deprecated `SiChartBaseComponent.resetChart` method as it should not be directly used by the consumer.
Summary of ChangesHello @akashsonune, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refactors the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request aims to refactor the chart component by removing the deprecated resetChart method. The removal is correctly reflected in the public API documentation. However, the replacement of resetChart() with themeSwitch() in ngOnChanges introduces a critical regression. The themeSwitch method does not handle changes to the renderer input, as this requires re-initializing the chart. My review includes a critical comment with a suggested fix to properly handle renderer changes by re-introducing the logic from the now-removed resetChart method for that specific case, while using the more efficient themeSwitch for theme-only changes.
| if (changes.theme || changes.renderer) { | ||
| // need to completely redo the chart for the theme change to take effect | ||
| return this.resetChart(); | ||
| return this.themeSwitch(); | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change introduces a regression. While themeSwitch() is the correct, more efficient approach for theme changes, it does not handle renderer changes. The chart's renderer can only be set during initialization (echarts.init). The themeSwitch() method does not re-initialize the chart, so changing the renderer input will have no effect.
The previous implementation using resetChart() was correct for renderer changes because it disposed and re-created the chart instance. The logic from resetChart() is still needed for this case.
I suggest splitting the condition to handle renderer changes by re-creating the chart (using the logic from the old resetChart method), and theme-only changes by calling themeSwitch().
if (changes.renderer) {
// Re-create the chart to apply the new renderer
this.applyTheme();
if (!this.actualOptions) {
return;
}
this.disposeChart();
this.applyPalette();
const addOpts = this.additionalOptions();
if (addOpts?.palette) {
echarts.util.merge(this.actualOptions.palette, addOpts.palette, true);
}
this.themeChanged();
this.applyStyles();
this.applyTitles();
this.ngAfterViewInit(true);
this.cdRef.markForCheck();
} else if (changes.theme) {
this.themeSwitch();
}|
Documentation. Coverage Reports: |
BREAKING CHANGE: Removed deprecated
SiChartBaseComponent.resetChartmethod as it should not be directly used by the consumer.