Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[feat] Add extraReducers arg to keplerGlReducer.initialState (#2232)

Igor D07f8c9f96f72
diff --git a/src/components/src/index.ts b/src/components/src/index.ts
index 26c8d005e..817fc4b50 100644
--- a/src/components/src/index.ts
+++ b/src/components/src/index.ts
@@ -56,7 +56,9 @@ export {testForCoordinates} from './geocoder/geocoder';
export {
default as PanelHeaderFactory,
SaveExportDropdownFactory,
- PanelHeaderDropdownFactory
+ PanelHeaderDropdownFactory,
+ CloudStorageDropdownFactory,
+ PanelAction
} from './side-panel/panel-header';
export {default as PanelHeaderActionFactory} from './side-panel/panel-header-action';
export {CollapseButtonFactory, default as SidebarFactory} from './side-panel/side-bar';
diff --git a/src/components/src/map/layer-selector-panel.tsx b/src/components/src/map/layer-selector-panel.tsx
index d77907615..e5ae80591 100644
--- a/src/components/src/map/layer-selector-panel.tsx
+++ b/src/components/src/map/layer-selector-panel.tsx
@@ -27,7 +27,7 @@ import MapLayerSelector from '../common/map-layer-selector';
import MapControlTooltipFactory from './map-control-tooltip';
import MapControlPanelFactory from './map-control-panel';
import {Layer} from '@kepler.gl/layers';
-import {MapControl, MapControls} from '@kepler.gl/types';
+import {MapControlItem, MapControls} from '@kepler.gl/types';
LayerSelectorPanelFactory.deps = [MapControlTooltipFactory, MapControlPanelFactory];
@@ -55,7 +55,7 @@ function LayerSelectorPanelFactory(
mapControls,
readOnly
}) => {
- const visibleLayers = mapControls?.visibleLayers || ({} as MapControl);
+ const visibleLayers = mapControls?.visibleLayers || ({} as MapControlItem);
const {active: isActive, show, disableClose} = visibleLayers || {};
const legendLayers = useMemo(
diff --git a/src/components/src/map/map-legend-panel.tsx b/src/components/src/map/map-legend-panel.tsx
index 01bfbfb3c..756c48d1b 100644
--- a/src/components/src/map/map-legend-panel.tsx
+++ b/src/components/src/map/map-legend-panel.tsx
@@ -29,7 +29,7 @@ import MapLegendFactory from './map-legend';
import LazyTippy from './lazy-tippy';
import {createPortal} from 'react-dom';
import {DIMENSIONS} from '@kepler.gl/constants';
-import {MapControl, MapControls, MapState} from '@kepler.gl/types';
+import {MapControlItem, MapControls, MapState} from '@kepler.gl/types';
import {Layer} from '@kepler.gl/layers';
import {media} from '@kepler.gl/styles';
import {ActionHandler, toggleSplitMapViewport} from '@kepler.gl/actions';
@@ -98,7 +98,7 @@ function MapLegendPanelFactory(MapControlTooltip, MapControlPanel, MapLegend) {
onToggleSplitMapViewport,
isViewportUnsyncAllowed = true
}) => {
- const mapLegend = mapControls?.mapLegend || ({} as MapControl);
+ const mapLegend = mapControls?.mapLegend || ({} as MapControlItem);
const {active: isPinned} = mapLegend || {};
const onClick = () => {
diff --git a/src/components/src/map/split-map-button.tsx b/src/components/src/map/split-map-button.tsx
index b99eca01d..67ac8ebcc 100644
--- a/src/components/src/map/split-map-button.tsx
+++ b/src/components/src/map/split-map-button.tsx
@@ -23,7 +23,7 @@ import classnames from 'classnames';
import {MapControlButton} from '../common/styled-components';
import {Delete, Split} from '../common/icons';
import MapControlTooltipFactory from './map-control-tooltip';
-import {MapControl, MapControls} from '@kepler.gl/types';
+import {MapControlItem, MapControls} from '@kepler.gl/types';
SplitMapButtonFactory.deps = [MapControlTooltipFactory];
@@ -56,7 +56,7 @@ function SplitMapButtonFactory(MapControlTooltip) {
mapControls,
readOnly
}) => {
- const splitMap = mapControls?.splitMap || ({} as MapControl);
+ const splitMap = mapControls?.splitMap || ({} as MapControlItem);
const onClick = useCallback(
event => {
event.preventDefault();
diff --git a/src/components/src/side-panel/filter-panel/filter-panel-header.tsx b/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
index 96e7c48d0..d66ddbb08 100644
--- a/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
+++ b/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
@@ -52,11 +52,14 @@ const StyledChildrenContainer = styled.div`
`;
type FilterPanelHeaderProps = {
- children: React.ReactNode;
+ className?: string;
datasets: KeplerTable[];
filter: Filter;
removeFilter: () => void;
- actionIcons?: Record<string, ComponentType>;
+ actionIcons?: {
+ delete: ComponentType;
+ };
+ children: React.ReactNode;
};
FilterPanelHeaderFactory.deps = [PanelHeaderActionFactory];
@@ -67,7 +70,7 @@ function FilterPanelHeaderFactory(
const defaultActionIcons = {
delete: Trash
};
- const FilterPanelHeader = ({
+ const FilterPanelHeader: React.FC<FilterPanelHeaderProps> = ({
children,
datasets,
filter,
diff --git a/src/layers/src/base-layer.ts b/src/layers/src/base-layer.ts
index 8190ebbfc..e435ff764 100644
--- a/src/layers/src/base-layer.ts
+++ b/src/layers/src/base-layer.ts
@@ -577,10 +577,10 @@ class Layer {
* Calculate a elevation zoom multiplier to render points, so they are visible in all zoom level
* @param {object} mapState
* @param {number} mapState.zoom - actual zoom
- * @param {number | void} mapState.zoomOffset - zoomOffset when render in the plot container for export image
+ * @param {number=} mapState.zoomOffset - zoomOffset when render in the plot container for export image
* @returns {number}
*/
- getElevationZoomFactor({zoom, zoomOffset = 0}: {zoom: number; zoomOffset?: number}) {
+ getElevationZoomFactor({zoom, zoomOffset = 0}: {zoom: number; zoomOffset?: number}): number {
return this.config.visConfig.enableElevationZoomFactor
? Math.pow(2, Math.max(8 - zoom + zoomOffset, 0))
: 1;
diff --git a/src/reducers/src/core.ts b/src/reducers/src/core.ts
index 49bab6db9..19362f845 100644
--- a/src/reducers/src/core.ts
+++ b/src/reducers/src/core.ts
@@ -41,23 +41,28 @@ export type KeplerGlState = {
providerState: ProviderState;
};
-const combined = (initialState: Partial<KeplerGlState> = {}) =>
- combineReducers({
+const combined = (
+ initialState: Partial<KeplerGlState> = {},
+ extraReducers: {[x: string]: unknown} = {}
+) => {
+ return combineReducers({
visState: visStateReducerFactory(initialState.visState),
mapState: mapStateReducerFactory(initialState.mapState),
mapStyle: mapStyleReducerFactory(initialState.mapStyle),
uiState: uiStateReducerFactory(initialState.uiState),
- providerState: providerStateReducerFactory(initialState.providerState)
+ providerState: providerStateReducerFactory(initialState.providerState),
+ ...extraReducers
});
+};
-export const coreReducerFactory = (initialState: Partial<KeplerGlState> = {}) => (
- state,
- action
-) => {
+export const coreReducerFactory = (
+ initialState: Partial<KeplerGlState> = {},
+ extraReducers = {}
+) => (state, action) => {
if (composers[action.type]) {
return composers[action.type](state, action);
}
- return combined(initialState)(state, action);
+ return combined(initialState, extraReducers)(state, action);
};
export default coreReducerFactory();
diff --git a/src/reducers/src/root.ts b/src/reducers/src/root.ts
index 08be76021..ae2c10388 100644
--- a/src/reducers/src/root.ts
+++ b/src/reducers/src/root.ts
@@ -26,8 +26,8 @@ import {coreReducerFactory} from './core';
// INITIAL_STATE
const initialCoreState = {};
-export function provideInitialState(initialState) {
- const coreReducer = coreReducerFactory(initialState);
+export function provideInitialState(initialState, extraReducers?) {
+ const coreReducer = coreReducerFactory(initialState, extraReducers);
const handleRegisterEntry = (
state,
@@ -96,11 +96,11 @@ export function provideInitialState(initialState) {
const _keplerGlReducer = provideInitialState(initialCoreState);
-function mergeInitialState(saved = {}, provided = {}) {
- const keys = ['mapState', 'mapStyle', 'visState', 'uiState'];
+function mergeInitialState(saved = {}, provided = {}, extraInitialStateKeys: string[] = []) {
+ const keys = ['mapState', 'mapStyle', 'visState', 'uiState', ...extraInitialStateKeys];
// shallow merge each reducer
- return keys.reduce(
+ const newState = keys.reduce(
(accu, key) => ({
...accu,
...(saved[key] && provided[key]
@@ -109,6 +109,8 @@ function mergeInitialState(saved = {}, provided = {}) {
}),
{}
);
+
+ return newState;
}
function decorate(target, savedInitialState = {}) {
@@ -191,6 +193,7 @@ function decorate(target, savedInitialState = {}) {
* @mixin keplerGlReducer.initialState
* @memberof keplerGlReducer
* @param {Object} iniSt - custom state to be merged with default initial state
+ * @param {Object} extraReducers - optional custom reducers in addition to the default `visState`, `mapState`, `mapStyle`, and `uiState`
* @public
* @example
* const myKeplerGlReducer = keplerGlReducer
@@ -198,9 +201,11 @@ function decorate(target, savedInitialState = {}) {
* uiState: {readOnly: true}
* });
*/
- target.initialState = function initialState(iniSt) {
- const merged = mergeInitialState(targetInitialState, iniSt);
- const targetReducer = provideInitialState(merged);
+ target.initialState = function initialState(iniSt, extraReducers = {}) {
+ // passing through extraInitialStateKeys and extraReducers allows external customization by adding additional subreducers and state beyond the default `visState`, `mapState`, `mapStyle`, and `uiState`
+ const extraInitialStateKeys = Object.keys(extraReducers);
+ const merged = mergeInitialState(targetInitialState, iniSt, extraInitialStateKeys);
+ const targetReducer = provideInitialState(merged, extraReducers);
return decorate(targetReducer, merged);
};
diff --git a/src/reducers/src/ui-state-updaters.ts b/src/reducers/src/ui-state-updaters.ts
index e957cf5d1..40d611a3d 100644
--- a/src/reducers/src/ui-state-updaters.ts
+++ b/src/reducers/src/ui-state-updaters.ts
@@ -46,7 +46,7 @@ import {
ExportHtml,
ExportJson,
ExportMap,
- MapControl,
+ MapControlItem,
MapControls,
UiState
} from '@kepler.gl/types';
@@ -95,7 +95,7 @@ export const DEFAULT_MODAL = ADD_DATA_ID;
const uiStateUpdaters = null;
/* eslint-enable no-unused-vars */
-const DEFAULT_MAP_CONTROLS_FEATURES: MapControl = {
+const DEFAULT_MAP_CONTROLS_FEATURES: MapControlItem = {
show: true,
active: false,
disableClose: false,
diff --git a/src/types/reducers.d.ts b/src/types/reducers.d.ts
index 3936e646b..5f23977e8 100644
--- a/src/types/reducers.d.ts
+++ b/src/types/reducers.d.ts
@@ -342,19 +342,19 @@ export type ExportMap = {
format: 'HTML' | 'JSON';
};
-export type MapControl = {
+export type MapControlItem = {
show: boolean;
active: boolean;
disableClose?: boolean;
activeMapIndex?: number;
};
export type MapControls = {
- visibleLayers?: MapControl;
- mapLegend?: MapControl;
- toggle3d?: MapControl;
- splitMap?: MapControl;
- mapDraw?: MapControl;
- mapLocale?: MapControl;
+ visibleLayers?: MapControlItem;
+ mapLegend?: MapControlItem;
+ toggle3d?: MapControlItem;
+ splitMap?: MapControlItem;
+ mapDraw?: MapControlItem;
+ mapLocale?: MapControlItem;
};
export type LoadFiles = {
diff --git a/test/node/reducers/root-test.js b/test/node/reducers/root-test.js
index eec9d5fc6..a38f643a1 100644
--- a/test/node/reducers/root-test.js
+++ b/test/node/reducers/root-test.js
@@ -164,6 +164,52 @@ test('keplerGlReducer.initialState.2', t => {
t.end();
});
+test('keplerGlReducer.initialState extrareducers', t => {
+ const INITIAL_STATE = {
+ panels: []
+ };
+
+ const insightReducer = handleActions(
+ {
+ ADD_PANEL_TO_SECTION: state => ({
+ ...state,
+ panels: ['first']
+ })
+ },
+ INITIAL_STATE
+ );
+
+ const addPanelToSectionAction = createAction('ADD_PANEL_TO_SECTION');
+
+ const test1Reducer = keplerGlReducer.initialState(
+ {
+ visState: {
+ layerClasses: []
+ },
+ mapStyle: {
+ styleType: 'light'
+ }
+ },
+ {
+ insightState: insightReducer
+ }
+ );
+
+ const test1ReducerInitialState = test1Reducer(undefined, registerEntry({id: 'test'}));
+
+ t.deepEqual(test1ReducerInitialState.test.insightState.panels, [], 'should have extra state');
+
+ const actionModifiedState = test1Reducer(test1ReducerInitialState, addPanelToSectionAction());
+
+ t.deepEqual(
+ actionModifiedState.test.insightState.panels,
+ ['first'],
+ 'should have modified panels'
+ );
+
+ t.end();
+});
+
test('keplerGlReducer.plugin', t => {
// custom actions
const hideAndShowSidePanel = createAction('HIDE_AND_SHOW_SIDE_PANEL');