Skip to content

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

[Feat] Map overlay blending (#2086)

Igor Dykhta7d9d54b88e7e
diff --git a/src/actions/src/action-types.ts b/src/actions/src/action-types.ts
index 58a813827..4bb8b9767 100644
--- a/src/actions/src/action-types.ts
+++ b/src/actions/src/action-types.ts
@@ -82,6 +82,7 @@ const ActionTypes = {
SET_FILTER_ANIMATION_WINDOW: `${ACTION_PREFIX}SET_FILTER_ANIMATION_WINDOW`,
SHOW_DATASET_TABLE: `${ACTION_PREFIX}SHOW_DATASET_TABLE`,
UPDATE_LAYER_BLENDING: `${ACTION_PREFIX}UPDATE_LAYER_BLENDING`,
+ UPDATE_OVERLAY_BLENDING: `${ACTION_PREFIX}UPDATE_OVERLAY_BLENDING`,
UPDATE_VIS_DATA: `${ACTION_PREFIX}UPDATE_VIS_DATA`,
RENAME_DATASET: `${ACTION_PREFIX}RENAME_DATASET`,
TOGGLE_FILTER_ANIMATION: `${ACTION_PREFIX}TOGGLE_FILTER_ANIMATION`,
diff --git a/src/actions/src/vis-state-actions.ts b/src/actions/src/vis-state-actions.ts
index a8f182bcc..b442f5082 100644
--- a/src/actions/src/vis-state-actions.ts
+++ b/src/actions/src/vis-state-actions.ts
@@ -233,6 +233,26 @@ export function updateLayerBlending(
};
}
+export type UpdateOverlayBlendingUpdaterAction = {
+ mode: 'screen' | 'normal' | 'darken';
+};
+
+/**
+ * Update overlay blending mode
+ * @memberof visStateActions
+ * @param mode one of `screen`, `normal` and `darken`
+ * @returns action
+ * @public
+ */
+export function updateOverlayBlending(
+ mode: 'screen' | 'normal' | 'darken'
+): Merge<UpdateOverlayBlendingUpdaterAction, {type: typeof ActionTypes.UPDATE_OVERLAY_BLENDING}> {
+ return {
+ type: ActionTypes.UPDATE_OVERLAY_BLENDING,
+ mode
+ };
+}
+
export type InteractionConfigChangeUpdaterAction = {
config: ValueOf<InteractionConfig>;
};
diff --git a/src/components/src/kepler-gl.tsx b/src/components/src/kepler-gl.tsx
index 7ee6c9ca4..a8f2b1363 100644
--- a/src/components/src/kepler-gl.tsx
+++ b/src/components/src/kepler-gl.tsx
@@ -179,6 +179,7 @@ export const sidePanelSelector = (props: KeplerGLProps, availableProviders, filt
interactionConfig: props.visState.interactionConfig,
mapInfo: props.visState.mapInfo,
layerBlending: props.visState.layerBlending,
+ overlayBlending: props.visState.overlayBlending,
width: props.sidePanelWidth ? props.sidePanelWidth : DEFAULT_KEPLER_GL_PROPS.width,
availableProviders,
diff --git a/src/components/src/map-container.tsx b/src/components/src/map-container.tsx
index 112780b07..8a04cebaa 100644
--- a/src/components/src/map-container.tsx
+++ b/src/components/src/map-container.tsx
@@ -20,7 +20,7 @@
// libraries
import React, {Component, createRef, useMemo} from 'react';
-import {withTheme} from 'styled-components';
+import styled, {withTheme} from 'styled-components';
import {StaticMap, MapRef} from 'react-map-gl';
import DeckGL from '@deck.gl/react';
import {createSelector, Selector} from 'reselect';
@@ -101,6 +101,18 @@ const MAP_STYLE: {[key: string]: React.CSSProperties} = {
const LOCALE_CODES_ARRAY = Object.keys(LOCALE_CODES);
+interface StyledMapContainerProps {
+ mixBlendMode?: string;
+}
+
+const StyledMap = styled(StyledMapContainer)<StyledMapContainerProps>(
+ ({mixBlendMode = 'normal'}) => `
+ .overlays {
+ mix-blend-mode: ${mixBlendMode};
+ };
+`
+);
+
const MAPBOXGL_STYLE_UPDATE = 'style.load';
const MAPBOXGL_RENDER = 'render';
const nop = () => {};
@@ -826,14 +838,16 @@ export default function MapContainerFactory(
}
render() {
+ const {visState} = this.props;
return (
- <StyledMapContainer
+ <StyledMap
ref={this._ref}
style={MAP_STYLE.container}
onContextMenu={event => event.preventDefault()}
+ mixBlendMode={visState.overlayBlending}
>
{this._renderMap()}
- </StyledMapContainer>
+ </StyledMap>
);
}
}
diff --git a/src/components/src/side-panel.tsx b/src/components/src/side-panel.tsx
index 8cebb4f92..a211da4df 100644
--- a/src/components/src/side-panel.tsx
+++ b/src/components/src/side-panel.tsx
@@ -123,6 +123,7 @@ export default function SidePanelFactory(
filters,
layers,
layerBlending,
+ overlayBlending,
layerClasses,
layerOrder,
interactionConfig,
@@ -235,6 +236,7 @@ export default function SidePanelFactory(
layerClasses={layerClasses}
layerOrder={layerOrder}
layerBlending={layerBlending}
+ overlayBlending={overlayBlending}
mapStyle={mapStyle}
mapStyleActions={mapStyleActions}
mapStateActions={mapStateActions}
diff --git a/src/components/src/side-panel/layer-manager.tsx b/src/components/src/side-panel/layer-manager.tsx
index 994f68eee..f1176ad6a 100644
--- a/src/components/src/side-panel/layer-manager.tsx
+++ b/src/components/src/side-panel/layer-manager.tsx
@@ -34,7 +34,7 @@ import AddLayerButtonFactory from './layer-panel/add-layer-button';
import ItemSelector from '../common/item-selector/item-selector';
import {PanelLabel, SidePanelDivider, SidePanelSection} from '../common/styled-components';
-import {LAYER_BLENDINGS} from '@kepler.gl/constants';
+import {LAYER_BLENDINGS, OVERLAY_BLENDINGS} from '@kepler.gl/constants';
import {Layer, LayerClassesType} from '@kepler.gl/layers';
import {UIStateActions, VisStateActions, ActionHandler} from '@kepler.gl/actions';
import {SidePanelItem} from '../types';
@@ -46,12 +46,18 @@ type LayerBlendingSelectorProps = {
updateLayerBlending: ActionHandler<typeof VisStateActions.updateLayerBlending>;
} & WrappedComponentProps;
+type OverlayBlendingSelectorProps = {
+ overlayBlending: string;
+ updateOverlayBlending: ActionHandler<typeof VisStateActions.updateOverlayBlending>;
+} & WrappedComponentProps;
+
type LayerManagerProps = {
datasets: Datasets;
layers: Layer[];
layerOrder: number[];
layerClasses: LayerClassesType;
layerBlending: string;
+ overlayBlending: string;
uiStateActions: typeof UIStateActions;
visStateActions: typeof VisStateActions;
showAddDataModal: () => void;
@@ -104,6 +110,39 @@ const LayerBlendingSelector = React.memo(
);
LayerBlendingSelector.displayName = 'LayerBlendingSelector';
+const OverlayBlendingSelector = React.memo(
+ ({overlayBlending, updateOverlayBlending, intl}: OverlayBlendingSelectorProps) => {
+ const labeledOverlayBlendings = Object.keys(OVERLAY_BLENDINGS).reduce(
+ (acc, current) => ({
+ ...acc,
+ [intl.formatMessage({id: OVERLAY_BLENDINGS[current].label})]: current
+ }),
+ {}
+ );
+
+ const onChange = useCallback(
+ blending => updateOverlayBlending(labeledOverlayBlendings[blending]),
+ [updateOverlayBlending, labeledOverlayBlendings]
+ );
+
+ return (
+ <SidePanelSection>
+ <PanelLabel>
+ <FormattedMessage id="overlayBlending.title" />
+ </PanelLabel>
+ <ItemSelector
+ selectedItems={intl.formatMessage({id: OVERLAY_BLENDINGS[overlayBlending].label})}
+ options={Object.keys(labeledOverlayBlendings)}
+ multiSelect={false}
+ searchable={false}
+ onChange={onChange}
+ />
+ </SidePanelSection>
+ );
+ }
+);
+OverlayBlendingSelector.displayName = 'OverlayBlendingSelector';
+
LayerManagerFactory.deps = [
LayerListFactory,
DatasetLayerGroupFactory,
@@ -219,6 +258,11 @@ function LayerManagerFactory(
updateLayerBlending={visStateActions.updateLayerBlending}
intl={intl}
/>
+ <OverlayBlendingSelector
+ overlayBlending={this.props.overlayBlending}
+ updateOverlayBlending={visStateActions.updateOverlayBlending}
+ intl={intl}
+ />
</div>
);
}
diff --git a/src/components/src/types.ts b/src/components/src/types.ts
index 43ddf8dd4..25af10afa 100644
--- a/src/components/src/types.ts
+++ b/src/components/src/types.ts
@@ -24,6 +24,7 @@ export type SidePanelProps = {
filters: Filter[];
interactionConfig: InteractionConfig;
layerBlending: string;
+ overlayBlending: string;
layers: Layer[];
layerClasses: LayerClassesType;
layerOrder: number[];
diff --git a/src/constants/src/default-settings.ts b/src/constants/src/default-settings.ts
index 2cc1ca6b1..fa22b7359 100644
--- a/src/constants/src/default-settings.ts
+++ b/src/constants/src/default-settings.ts
@@ -658,6 +658,21 @@ export const NO_VALUE_COLOR: RGBAColor = [0, 0, 0, 0];
export const DEFAULT_PICKING_RADIUS = 3;
+export const OVERLAY_BLENDINGS = {
+ normal: {
+ label: 'overlayBlending.normal',
+ value: 'normal'
+ },
+ screen: {
+ label: 'overlayBlending.screen',
+ value: 'screen'
+ },
+ darken: {
+ label: 'overlayBlending.darken',
+ value: 'darken'
+ }
+};
+
export const LAYER_BLENDINGS = {
additive: {
label: 'layerBlending.additive',
diff --git a/src/localization/src/translations/en.ts b/src/localization/src/translations/en.ts
index 65d3c6562..7dc3e6cb2 100644
--- a/src/localization/src/translations/en.ts
+++ b/src/localization/src/translations/en.ts
@@ -168,7 +168,8 @@ export default {
layerManager: {
addData: 'Add Data',
addLayer: 'Add Layer',
- layerBlending: 'Layer Blending'
+ layerBlending: 'Layer Blending',
+ overlayBlending: 'Overlay Blending'
},
mapManager: {
mapStyle: 'Map style',
@@ -413,6 +414,12 @@ export default {
normal: 'normal',
subtractive: 'subtractive'
},
+ overlayBlending: {
+ title: 'Map overlay blending',
+ screen: 'screen',
+ normal: 'normal',
+ darken: 'darken'
+ },
columns: {
title: 'Columns',
lat: 'lat',
diff --git a/src/reducers/src/vis-state-merger.ts b/src/reducers/src/vis-state-merger.ts
index 1a020036e..55f889047 100644
--- a/src/reducers/src/vis-state-merger.ts
+++ b/src/reducers/src/vis-state-merger.ts
@@ -30,7 +30,7 @@ import {
} from '@kepler.gl/utils';
import {LayerColumns, LayerColumn, Layer} from '@kepler.gl/layers';
-import {LAYER_BLENDINGS} from '@kepler.gl/constants';
+import {LAYER_BLENDINGS, OVERLAY_BLENDINGS} from '@kepler.gl/constants';
import {
CURRENT_VERSION,
Merger,
@@ -365,6 +365,24 @@ export function mergeLayerBlending<S extends VisState>(
return state;
}
+/**
+ * Merge overlayBlending with saved
+ */
+export function mergeOverlayBlending<S extends VisState>(
+ state: S,
+ overlayBlending: NonNullable<ParsedConfig['visState']>['overlayBlending'],
+ fromConfig?: boolean
+): S {
+ if (overlayBlending && OVERLAY_BLENDINGS[overlayBlending]) {
+ return {
+ ...state,
+ overlayBlending
+ };
+ }
+
+ return state;
+}
+
/**
* Merge animation config
*/
@@ -624,6 +642,7 @@ export const VIS_STATE_MERGERS: VisStateMergers = [
{merge: mergeFilters, prop: 'filters', toMergeProp: 'filterToBeMerged'},
{merge: mergeInteractions, prop: 'interactionConfig', toMergeProp: 'interactionToBeMerged'},
{merge: mergeLayerBlending, prop: 'layerBlending'},
+ {merge: mergeOverlayBlending, prop: 'overlayBlending'},
{merge: mergeSplitMaps, prop: 'splitMaps', toMergeProp: 'splitMapsToBeMerged'},
{merge: mergeAnimationConfig, prop: 'animationConfig'},
{merge: mergeEditor, prop: 'editor'}
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 254143385..f81e655e2 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -231,6 +231,7 @@ export const INITIAL_VIS_STATE: VisState = {
interactionToBeMerged: undefined,
layerBlending: 'normal',
+ overlayBlending: 'normal',
hoverInfo: undefined,
clicked: undefined,
mousePos: {},
@@ -1316,6 +1317,19 @@ export const updateLayerBlendingUpdater = (
layerBlending: action.mode
});
+/**
+ * update overlay blending mode
+ * @memberof visStateUpdaters
+ * @public
+ */
+export const updateOverlayBlendingUpdater = (
+ state: VisState,
+ action: VisStateActions.UpdateOverlayBlendingUpdaterAction
+): VisState => ({
+ ...state,
+ overlayBlending: action.mode
+});
+
/**
* Display dataset table in a modal
* @memberof visStateUpdaters
diff --git a/src/reducers/src/vis-state.ts b/src/reducers/src/vis-state.ts
index 02acc429d..817f7500f 100644
--- a/src/reducers/src/vis-state.ts
+++ b/src/reducers/src/vis-state.ts
@@ -114,6 +114,8 @@ const actionHandler = {
[ActionTypes.UPDATE_LAYER_BLENDING]: visStateUpdaters.updateLayerBlendingUpdater,
+ [ActionTypes.UPDATE_OVERLAY_BLENDING]: visStateUpdaters.updateOverlayBlendingUpdater,
+
[ActionTypes.UPDATE_VIS_DATA]: visStateUpdaters.updateVisDataUpdater,
[ActionTypes.RENAME_DATASET]: visStateUpdaters.renameDatasetUpdater,
diff --git a/src/schemas/src/vis-state-schema.ts b/src/schemas/src/vis-state-schema.ts
index e4e6d60d6..6e4bdbecd 100644
--- a/src/schemas/src/vis-state-schema.ts
+++ b/src/schemas/src/vis-state-schema.ts
@@ -72,6 +72,7 @@ export interface VisState {
interactionConfig: InteractionConfig;
interactionToBeMerged: any;
layerBlending: string;
+ overlayBlending: string;
hoverInfo: any;
clicked: any;
mousePos: any;
@@ -778,7 +779,8 @@ export const propertiesV0 = {
version: VERSIONS.v0,
properties: interactionPropsV0
}),
- layerBlending: null
+ layerBlending: null,
+ overlayBlending: null
};
export const propertiesV1 = {
@@ -795,6 +797,7 @@ export const propertiesV1 = {
properties: interactionPropsV1
}),
layerBlending: null,
+ overlayBlending: null,
splitMaps: new SplitMapsSchema({
key: 'splitMaps',
version: VERSIONS.v1
diff --git a/src/types/schemas.d.ts b/src/types/schemas.d.ts
index f0b4d019d..af8e125a7 100644
--- a/src/types/schemas.d.ts
+++ b/src/types/schemas.d.ts
@@ -91,6 +91,7 @@ export type SavedVisState = {
layers: SavedLayer[];
interactionConfig: SavedInteractionConfig;
layerBlending: string;
+ overlayBlending: string;
splitMaps: SplitMap[];
animationConfig: SavedAnimationConfig;
editor?: SavedEditor;
@@ -101,6 +102,7 @@ export type ParsedVisState = {
filters?: ParsedFilter[];
interactionConfig?: Partial<SavedInteractionConfig>;
layerBlending?: string;
+ overlayBlending?: string;
splitMaps?: SplitMap[];
animationConfig?: Partial<SavedAnimationConfig>;
};
diff --git a/test/browser/components/side-panel/layer-manager-test.js b/test/browser/components/side-panel/layer-manager-test.js
index ef33f2a3b..cbf00d0c5 100644
--- a/test/browser/components/side-panel/layer-manager-test.js
+++ b/test/browser/components/side-panel/layer-manager-test.js
@@ -69,7 +69,8 @@ const defaultProps = {
layerPanelListView: 'list',
uiStateActions: UIStateActions,
visStateActions: VisStateActions,
- layerBlending: 'normal'
+ layerBlending: 'normal',
+ overlayBlending: 'normal'
};
test('Components -> LayerManager -> render -> list view', t => {
diff --git a/test/browser/components/side-panel/side-panel-test.js b/test/browser/components/side-panel/side-panel-test.js
index 3863f0c0c..8be0413bc 100644
--- a/test/browser/components/side-panel/side-panel-test.js
+++ b/test/browser/components/side-panel/side-panel-test.js
@@ -62,6 +62,7 @@ const defaultProps = {
datasets: InitialState.visState.datasets,
filters: InitialState.visState.filters,
layerBlending: InitialState.visState.layerBlending,
+ overlayBlending: InitialState.visState.overlayBlending,
layerClasses: InitialState.visState.layerClasses,
layerOrder: InitialState.visState.layerOrder,
interactionConfig: InitialState.visState.interactionConfig,
diff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.js
index dc4ec32e6..7483775c3 100644
--- a/test/node/reducers/vis-state-test.js
+++ b/test/node/reducers/vis-state-test.js
@@ -2814,6 +2814,7 @@ test('#visStateReducer -> REMOVE_DATASET w filter and layer', t => {
},
editingDataset: oldState.editingDataset,
layerBlending: oldState.layerBlending,
+ overlayBlending: oldState.overlayBlending,
hoverInfo: oldState.hoverInfo,
clicked: oldState.clicked,
mousePos: oldState.mousePos,
@@ -3063,6 +3064,7 @@ test('#visStateReducer -> SPLIT_MAP: REMOVE_DATASET', t => {
splitMaps: [{layers: {'point-0': false}}, {layers: {'point-0': true}}],
editingDataset: oldState.editingDataset,
layerBlending: oldState.layerBlending,
+ overlayBlending: oldState.overlayBlending,
hoverInfo: oldState.hoverInfo,
clicked: oldState.clicked,
mousePos: oldState.mousePos,
diff --git a/test/node/schemas/vis-state-schema-test.js b/test/node/schemas/vis-state-schema-test.js
index 4095b8fff..5da9d1f29 100644
--- a/test/node/schemas/vis-state-schema-test.js
+++ b/test/node/schemas/vis-state-schema-test.js
@@ -45,6 +45,7 @@ const expectedVisStateEntries = [
'layers',
'interactionConfig',
'layerBlending',
+ 'overlayBlending',
'splitMaps',
'animationConfig',
'editor'