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

[fix] handle undefined values in updateViewport #2178

Merged
merged 2 commits into from
Mar 30, 2023
Merged

[fix] handle undefined values in updateViewport #2178

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44f0489
[fix] handle `undefined` values in `updateViewport`
kylebarron Jul 22, 2022
7167fb2
fix: handle undefined values in updateViewport
igorDykhta Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 15 additions & 5 deletions src/reducers/src/map-state-updaters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import pick from 'lodash.pick';

import {getCenterAndZoomFromBounds, validateBounds, MAPBOX_TILE_SIZE} from '@kepler.gl/utils';
import {MapStateActions, ReceiveMapConfigPayload, ActionTypes} from '@kepler.gl/actions';
import {MapState, Bounds} from '@kepler.gl/types';
import {MapState, Bounds, Viewport} from '@kepler.gl/types';

/**
* Updaters for `mapState` reducer. Can be used in your root reducer to directly modify kepler.gl's state.
Expand Down Expand Up @@ -121,6 +121,10 @@ export const updateMapUpdater = (
const {viewport, mapIndex = 0} = action.payload;

if (state.isViewportSynced) {
// The `updateViewport` function is typed as (Viewport, Viewport) -> Viewport but here the
// expected typing is (MapState, Viewport) -> MapState.
// this could be a potential bug as we treat Viewport and MapState as equal seemingly
// @ts-expect-error Type 'Viewport' is missing the following properties from type 'MapState': isSplit, isViewportSynced, isZoomLocked, splitMapViewports
return updateViewport(state, viewport);
}

Expand Down Expand Up @@ -474,22 +478,28 @@ function getViewportFromMapState(state) {
]);
}

function updateViewport(originalViewport, viewportUpdates) {
// From https://stackoverflow.com/a/56650790
/** Select items from object whose value is not undefined */
const definedProps = obj =>
Object.fromEntries(Object.entries(obj).filter(([k, v]) => v !== undefined));

function updateViewport(originalViewport: Viewport, viewportUpdates: Viewport): Viewport {
let newViewport = {
...originalViewport,
...(viewportUpdates || {})
...(definedProps(viewportUpdates) || {})
};

// Make sure zoom level doesn't go bellow minZoom if defined
if (newViewport.minZoom && newViewport.zoom < newViewport.minZoom) {
if (newViewport.minZoom && newViewport.zoom && newViewport.zoom < newViewport.minZoom) {
newViewport.zoom = newViewport.minZoom;
}
// Make sure zoom level doesn't go above maxZoom if defined
if (newViewport.maxZoom && newViewport.zoom > newViewport.maxZoom) {
if (newViewport.maxZoom && newViewport.zoom && newViewport.zoom > newViewport.maxZoom) {
newViewport.zoom = newViewport.maxZoom;
}
// Limit viewport update based on maxBounds
if (newViewport.maxBounds && validateBounds(newViewport.maxBounds)) {
// @ts-expect-error Type 'Viewport' is missing the following properties from type 'MapState': isSplit, isViewportSynced, isZoomLocked, splitMapViewports
newViewport = updateViewportBasedOnBounds(originalViewport, newViewport);
}

Expand Down