Skip to content
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

Jump to bottom

TimeSeriesWidget: fix echarts props update, to keep state of control when clicking #865

Merged
merged 4 commits into from
Apr 22, 2024
Merged

TimeSeriesWidget: fix echarts props update, to keep state of control when clicking #865

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
269eb27
TimeseriesWidget: fix echarts props replacement not to reset control …
zbigg Apr 19, 2024
51a4017
Fix crash when first series is deselected
zbigg Apr 19, 2024
6f64967
changelog update
zbigg Apr 19, 2024
612b93c
TimeSeriesChart: id series by index to prevent collisions
zbigg Apr 19, 2024
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Not released

- TimeSeriesWidget: fix echarts props update, to keep state of control when clicking [#865](https://github.com/CartoDB/carto-react/pull/865)
- TimeSeriesWidget: support removing series in mounted widget [#863](https://github.com/CartoDB/carto-react/pull/863)

## 3.0.0
Expand All @@ -12,6 +13,10 @@

## 2.5

### 2.5.3 (2024-04-18)

- TimeSeriesWidget: support removing series in mounted widget [#863](https://github.com/CartoDB/carto-react/pull/863)

### 2.5.2 (2024-04-10)

- configurable timeseries y axis [#861](https://github.com/CartoDB/carto-react/pull/861)
Expand Down
14 changes: 14 additions & 0 deletions packages/react-ui/src/custom-components/echarts-for-react/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,20 @@ export default class ReactEcharts extends _ReactEcharts {
}
}

updateEChartsOption() {
const { option, lazyUpdate, showLoading, loadingOption = null } = this.props;
const echartInstance = this.getEchartsInstance();

echartInstance.setOption(option, { replaceMerge: ['series'], lazyUpdate });
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This ensures that merges series objects as list identified by id


if (showLoading) {
echartInstance.showLoading(loadingOption);
} else {
echartInstance.hideLoading();
}
return echartInstance;
}

offEvents(instance, events) {
if (!events) return;
// loop and off
Expand Down
2 changes: 1 addition & 1 deletion packages/react-ui/src/widgets/TimeSeriesWidgetUI/components/TimeSeriesChart.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ export default function TimeSeriesChart({
: theme.palette.action.disabledBackground;

return {
id: name,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This ensures that echarts keeps track of series when we update data.

name,
markLine: i === 0 ? markLine : undefined,
markArea: i === 0 ? markArea : undefined,
Expand Down Expand Up @@ -293,7 +294,6 @@ export default function TimeSeriesChart({
return (
<ReactEcharts
option={options}
notMerge
onEvents={onEvents}
onChartReady={onChartReady}
style={{ height }}
Expand Down
28 changes: 19 additions & 9 deletions packages/react-ui/src/widgets/TimeSeriesWidgetUI/hooks/useTimeSeriesInteractivity.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,26 @@ export default function useTimeSeriesInteractivity({

const updateCursor = useCallback((cursor) => zr?.setCursorStyle(cursor), [zr]);

const firstCategory = data?.[0]?.category;
const seriesFinder = useMemo(() => {
if (firstCategory) {
return { seriesId: firstCategory };
}
return { seriesIndex: 0 };
}, [firstCategory]);

const updateTimelineByCoordinate = useCallback(
(params) => {
if (echartsInstance) {
const [x] = echartsInstance.convertFromPixel({ seriesIndex: 0 }, [
const [x] = echartsInstance.convertFromPixel(seriesFinder, [
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we remove series from beginnning (by filtering sql by param), internal echarts array looks this: [undefined, undefined, something, something ]

So seriesIndex: 0 doesn't always work. Solution: find by category name

params.offsetX,
params.offsetY
]);
const itemIndex = findItemIndexByTime(x, data);
setTimeWindow(itemIndex !== undefined ? [data[itemIndex].name] : []);
}
},
[data, echartsInstance, setTimeWindow]
[data, echartsInstance, setTimeWindow, seriesFinder]
);

// Echarts events
Expand Down Expand Up @@ -87,7 +95,7 @@ export default function useTimeSeriesInteractivity({

// Move markArea
if (timeWindow.length === 2) {
const [x] = echartsInstance.convertFromPixel({ seriesIndex: 0 }, [
const [x] = echartsInstance.convertFromPixel(seriesFinder, [
params.offsetX,
params.offsetY
]);
Expand All @@ -101,7 +109,7 @@ export default function useTimeSeriesInteractivity({

if (echartsInstance) {
setIsMarkAreaSelected(true);
const [x] = echartsInstance.convertFromPixel({ seriesIndex: 0 }, [
const [x] = echartsInstance.convertFromPixel(seriesFinder, [
params.offsetX,
params.offsetY
]);
Expand All @@ -111,7 +119,7 @@ export default function useTimeSeriesInteractivity({
}

return addEventWithCleanUp(zr, 'mousedown', mouseDownEvent);
}, [zr, echartsInstance, timeWindow, updateCursor, filterable]);
}, [zr, echartsInstance, timeWindow, updateCursor, filterable, seriesFinder]);

useEffect(() => {
function mouseMoveEvent(params) {
Expand All @@ -125,7 +133,7 @@ export default function useTimeSeriesInteractivity({
}

if (isMarkAreaSelected && echartsInstance) {
const [x] = echartsInstance.convertFromPixel({ seriesIndex: 0 }, [
const [x] = echartsInstance.convertFromPixel(seriesFinder, [
params.offsetX,
params.offsetY
]);
Expand All @@ -145,7 +153,8 @@ export default function useTimeSeriesInteractivity({
isMarkLineSelected,
setTimeWindow,
updateCursor,
updateTimelineByCoordinate
updateTimelineByCoordinate,
seriesFinder
]);

useEffect(() => {
Expand All @@ -164,7 +173,7 @@ export default function useTimeSeriesInteractivity({
}

if (isMarkAreaMoving && echartsInstance) {
const [x] = echartsInstance.convertFromPixel({ seriesIndex: 0 }, [
const [x] = echartsInstance.convertFromPixel(seriesFinder, [
params.offsetX,
params.offsetY
]);
Expand All @@ -187,7 +196,8 @@ export default function useTimeSeriesInteractivity({
oldMarkAreaPosition,
setTimeWindow,
timeWindow,
updateCursor
updateCursor,
seriesFinder
]);

useEffect(() => {
Expand Down
Loading