Skip to content

fix: maintain pagination state on long echarts legends. #33728

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.

Sign up for GitHub

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

Closed
rusackas wants to merge 1 commit into from
Closed

fix: maintain pagination state on long echarts legends. #33728

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions superset-frontend/plugins/plugin-chart-echarts/src/Timeseries/EchartsTimeseries.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ export default function EchartsTimeseries({
const clickTimer = useRef<ReturnType<typeof setTimeout>>();
const extraControlRef = useRef<HTMLDivElement>(null);
const [extraControlHeight, setExtraControlHeight] = useState(0);
// Track the current legend page index
const [currentLegendPage, setCurrentLegendPage] = useState(0);
useEffect(() => {
const updatedHeight = extraControlRef.current?.offsetHeight || 0;
setExtraControlHeight(updatedHeight);
Expand Down Expand Up @@ -139,6 +141,20 @@ export default function EchartsTimeseries({
[emitCrossFilters, setDataMask, getCrossFilterDataMask],
);

// Helper function to restore legend page position
const restoreLegendPagePosition = useCallback(() => {
// Use requestAnimationFrame instead of setTimeout for better alignment with the browser's rendering cycle
requestAnimationFrame(() => {
const echartInstance = echartRef.current?.getEchartInstance();
if (echartInstance) {
echartInstance.dispatchAction({
type: 'legendScroll',
scrollDataIndex: currentLegendPage,
});
}
});
Comment on lines +146 to +155

This comment was marked as resolved.

Sign in to view

Comment thread
rusackas marked this conversation as resolved.
Resolved
}, [currentLegendPage]);

const eventHandlers: EventHandlers = {
click: props => {
if (!hasDimensions) {
Expand All @@ -161,12 +177,21 @@ export default function EchartsTimeseries({
},
legendselectchanged: payload => {
onLegendStateChanged?.(payload.selected);
restoreLegendPagePosition();
},
legendselectall: payload => {
onLegendStateChanged?.(payload.selected);
restoreLegendPagePosition();
},
legendinverseselect: payload => {
onLegendStateChanged?.(payload.selected);
restoreLegendPagePosition();
},
// Add handler for legend scroll event to track current page
legendscroll: params => {
if (params.scrollDataIndex !== undefined) {
setCurrentLegendPage(params.scrollDataIndex);
}
},
contextmenu: async eventParams => {
if (onContextMenu) {
Expand Down