Skip to content

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

[Enhancement] Use layer.visible prop in deck.gl when toggle layer visibility (#1591)

Shan He91a52b165166
diff --git a/src/components/index.js b/src/components/index.js
index 165fc228b..849884bfa 100644
--- a/src/components/index.js
+++ b/src/components/index.js
@@ -37,7 +37,7 @@ export {default as KeplerGl, default, injectComponents, ContainerFactory} from '
export {default as KeplerGlFactory, DEFAULT_KEPLER_GL_PROPS} from './kepler-gl';
export {default as SidePanelFactory} from './side-panel';
export {default as PanelTitleFactory} from './side-panel/panel-title';
-export {default as MapContainerFactory, Attribution, prepareLayersToRender} from './map-container';
+export {default as MapContainerFactory, Attribution} from './map-container';
export {default as MapsLayoutFactory} from './maps-layout';
export {
default as BottomWidgetFactory,
diff --git a/src/components/kepler-gl.js b/src/components/kepler-gl.js
index 3f6b8116a..51b25586f 100644
--- a/src/components/kepler-gl.js
+++ b/src/components/kepler-gl.js
@@ -422,7 +422,7 @@ function KeplerGlFactory(
<MapsLayout className="maps">{mapContainers}</MapsLayout>
{isExportingImage && <PlotContainer {...plotContainerFields} />}
{interactionConfig.geocoder.enabled && <GeoCoderPanel {...geoCoderPanelFields} />}
- <BottomWidgetOuter>
+ <BottomWidgetOuter absolute>
<BottomWidget
ref={this.bottomWidgetRef}
{...bottomWidgetFields}
diff --git a/src/components/map-container.js b/src/components/map-container.js
index 6519dfda8..67d127772 100644
--- a/src/components/map-container.js
+++ b/src/components/map-container.js
@@ -38,7 +38,12 @@ import EditorFactory from './editor/editor';
import {generateMapboxLayers, updateMapboxLayers} from 'layers/mapbox-utils';
import {setLayerBlending} from 'utils/gl-utils';
import {transformRequest} from 'utils/map-style-utils/mapbox-utils';
-import {getLayerHoverProp, renderDeckGlLayer} from 'utils/layer-utils';
+import {
+ getLayerHoverProp,
+ renderDeckGlLayer,
+ prepareLayersToRender,
+ prepareLayersForDeck
+} from 'utils/layer-utils';
// default-settings
import ThreeDBuildingLayer from 'deckgl-layers/3d-building-layer/3d-building-layer';
@@ -47,7 +52,6 @@ import {
GEOCODER_LAYER_ID,
THROTTLE_NOTIFICATION_TIME
} from 'constants/default-settings';
-import {OVERLAY_TYPE} from 'layers/base-layer';
import ErrorBoundary from 'components/common/error-boundary';
import {observeDimensions, unobserveDimensions} from '../utils/observe-dimensions';
@@ -103,21 +107,6 @@ export const Attribution = () => (
</StyledAttrbution>
);
-// {[id]: true \ false}
-export function prepareLayersToRender(layers, layerData, mapLayers) {
- return layers.reduce(
- (accu, layer, idx) => ({
- ...accu,
- [layer.id]:
- layer.id !== GEOCODER_LAYER_ID &&
- layer.shouldRenderLayer(layerData[idx]) &&
- // if layer.id is not in mapLayers, don't render it
- (!mapLayers || (mapLayers && mapLayers[layer.id]))
- }),
- {}
- );
-}
-
MapContainerFactory.deps = [
MapPopoverFactory,
MapControlFactory,
@@ -211,7 +200,11 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor, MapL
this.mapLayersSelector,
prepareLayersToRender
);
-
+ layersForDeckSelector = createSelector(
+ this.layersSelector,
+ this.layerDataSelector,
+ prepareLayersForDeck
+ );
filtersSelector = props => props.filters;
polygonFilters = createSelector(this.filtersSelector, filters =>
filters.filter(f => f.type === FILTER_TYPES.polygon)
@@ -398,7 +391,7 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor, MapL
return screenCoord && {x: screenCoord[0], y: screenCoord[1]};
}
- _renderDeckOverlay(layersToRender) {
+ _renderDeckOverlay(layersForDeck) {
const {
mapState,
mapStyle,
@@ -419,9 +412,7 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor, MapL
const dataLayers = layerOrder
.slice()
.reverse()
- .filter(
- idx => layers[idx].overlayType === OVERLAY_TYPE.deckgl && layersToRender[layers[idx].id]
- )
+ .filter(idx => layersForDeck[layers[idx].id])
.reduce((overlays, idx) => {
const layerCallbacks = {
onSetLayerDomain: val => this._onLayerSetDomain(idx, val)
@@ -528,6 +519,7 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor, MapL
} = this.props;
const layersToRender = this.layersToRenderSelector(this.props);
+ const layersForDeck = this.layersForDeckSelector(this.props);
const mapProps = {
...mapState,
@@ -578,7 +570,7 @@ export default function MapContainerFactory(MapPopover, MapControl, Editor, MapL
getCursor={this.props.hoverInfo ? () => 'pointer' : undefined}
onMouseMove={this.props.visStateActions.onMouseMove}
>
- {this._renderDeckOverlay(layersToRender)}
+ {this._renderDeckOverlay(layersForDeck)}
{this._renderMapboxOverlays()}
<Editor
index={index}
diff --git a/src/deckgl-layers/cluster-layer/cluster-layer.js b/src/deckgl-layers/cluster-layer/cluster-layer.js
index 6318b6c92..037d44f2a 100644
--- a/src/deckgl-layers/cluster-layer/cluster-layer.js
+++ b/src/deckgl-layers/cluster-layer/cluster-layer.js
@@ -218,7 +218,7 @@ export default class ClusterLayer extends AggregationLayer {
const {cpuAggregator} = this.state;
// base layer props
- const {opacity, pickable, autoHighlight, highlightColor} = this.props;
+ const {visible, opacity, pickable, autoHighlight, highlightColor} = this.props;
const updateTriggers = this._getSublayerUpdateTriggers();
const accessors = this._getSubLayerAccessors();
@@ -230,6 +230,7 @@ export default class ClusterLayer extends AggregationLayer {
id: `${id}-cluster`,
data: cpuAggregator.state.layerData.data,
radiusScale: metersPerPixel * radiusScale,
+ visible,
opacity,
pickable,
autoHighlight,
diff --git a/src/layers/base-layer.js b/src/layers/base-layer.js
index d2f5a6d99..aea7a19ff 100644
--- a/src/layers/base-layer.js
+++ b/src/layers/base-layer.js
@@ -709,7 +709,6 @@ class Layer {
shouldRenderLayer(data) {
return (
(this.type &&
- this.config.isVisible &&
this.hasAllColumns() &&
this.hasLayerData(data) &&
typeof this.renderLayer === 'function')
@@ -1077,7 +1076,7 @@ class Layer {
};
}
- getDefaultDeckLayerProps({idx, gpuFilter, mapState}) {
+ getDefaultDeckLayerProps({idx, gpuFilter, mapState, visible}) {
return {
id: this.id,
idx,
@@ -1091,7 +1090,10 @@ class Layer {
highlightColor: this.config.highlightColor,
// data filtering
extensions: [dataFilterExtension],
- filterRange: gpuFilter ? gpuFilter.filterRange : undefined
+ filterRange: gpuFilter ? gpuFilter.filterRange : undefined,
+
+ // layer should be visible and if splitMap, shown in to one of panel
+ visible: this.config.isVisible && visible
};
}
diff --git a/src/layers/point-layer/point-layer.js b/src/layers/point-layer/point-layer.js
index 76a2e4c99..4d20e71ac 100644
--- a/src/layers/point-layer/point-layer.js
+++ b/src/layers/point-layer/point-layer.js
@@ -267,6 +267,7 @@ export default class PointLayer extends Layer {
getFilterValue: data.getFilterValue,
extensions,
filterRange: defaultLayerProps.filterRange,
+ visible: defaultLayerProps.visible,
...brushingProps
};
const hoveredObject = this.hasHoveredObject(objectHovered);
diff --git a/src/utils/index.js b/src/utils/index.js
index 97598feb5..a8af3cb8a 100644
--- a/src/utils/index.js
+++ b/src/utils/index.js
@@ -30,7 +30,7 @@ export {createNewDataEntry, datasetColorMaker} from './dataset-utils';
export {hexToRgb} from './color-utils';
export {errorNotification} from './notifications-utils';
export {dataURItoBlob, downloadFile} from './export-utils';
-export {calculateLayerData} from './layer-utils';
+export {calculateLayerData, prepareLayersToRender, prepareLayersForDeck} from './layer-utils';
export {
applyFilterFieldName,
applyFiltersToDatasets,
diff --git a/src/utils/layer-utils.d.ts b/src/utils/layer-utils.d.ts
index d283ec71b..b6ce59de7 100644
--- a/src/utils/layer-utils.d.ts
+++ b/src/utils/layer-utils.d.ts
@@ -19,7 +19,7 @@
// THE SOFTWARE.
import {Layer, LayerClassesType} from 'layers';
-import {VisState, Dataset, TooltipField, CompareType} from 'reducers/vis-state-updaters';
+import {VisState, Dataset, TooltipField, CompareType, SplitMapLayers} from 'reducers/vis-state-updaters';
export function calculateLayerData(
layer: Layer,
@@ -53,3 +53,17 @@ export function getLayerHoverProp(arg: {
}): LayerHoverProp | null;
export function renderDeckGlLayer(props: any, layerCallbacks: {[key]: any}, idx: number);
+
+export function prepareLayersToRender(
+ layers: Layer,
+ layerData: VisState['layerData'],
+ mapLayers?: SplitMapLayers): {
+ [key: string]: boolean;
+}
+
+export function prepareLayersForDeck(
+ layers: Layer,
+ layerData: VisState['layerData'],
+): {
+ [key: string]: boolean;
+}
\ No newline at end of file
diff --git a/src/utils/layer-utils.js b/src/utils/layer-utils.js
index 6b9172c3d..9c3c0afd1 100644
--- a/src/utils/layer-utils.js
+++ b/src/utils/layer-utils.js
@@ -17,6 +17,8 @@
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
+import {OVERLAY_TYPE} from 'layers/base-layer';
+import {GEOCODER_LAYER_ID} from 'constants/default-settings';
/**
* Find default layers from fields
@@ -120,14 +122,14 @@ export function renderDeckGlLayer(props, layerCallbacks, idx) {
clicked,
mapState,
interactionConfig,
- animationConfig
+ animationConfig,
+ mapLayers
} = props;
const layer = layers[idx];
const data = layerData[idx];
const {gpuFilter} = datasets[layer.config.dataId] || {};
-
const objectHovered = clicked || hoverInfo;
-
+ const visible = !mapLayers || (mapLayers && mapLayers[layer.id]);
// Layer is Layer class
return layer.renderLayer({
data,
@@ -137,6 +139,46 @@ export function renderDeckGlLayer(props, layerCallbacks, idx) {
layerCallbacks,
mapState,
animationConfig,
- objectHovered
+ objectHovered,
+ visible
});
}
+
+export function isLayerRenderable(layer, layerData) {
+ return layer.id !== GEOCODER_LAYER_ID && layer.shouldRenderLayer(layerData);
+}
+
+export function isLayerVisible(layer, mapLayers) {
+ return (
+ layer.config.isVisible &&
+ // if layer.id is not in mapLayers, don't render it
+ (!mapLayers || (mapLayers && mapLayers[layer.id]))
+ );
+}
+
+// Prepare a dict of layers rendered by the deck.gl
+// Note, isVisible: false layer is passed to deck.gl here
+// return {[id]: true \ false}
+export function prepareLayersForDeck(layers, layerData) {
+ return layers.reduce(
+ (accu, layer, idx) => ({
+ ...accu,
+ [layer.id]:
+ isLayerRenderable(layer, layerData[idx]) && layer.overlayType === OVERLAY_TYPE.deckgl
+ }),
+ {}
+ );
+}
+
+// Prepare a dict of rendered layers rendered in the map
+// This includes only the visibile layers for single map view and split map view
+// return {[id]: true \ false}
+export function prepareLayersToRender(layers, layerData, mapLayers) {
+ return layers.reduce(
+ (accu, layer, idx) => ({
+ ...accu,
+ [layer.id]: isLayerRenderable(layer, layerData[idx]) && isLayerVisible(layer, mapLayers)
+ }),
+ {}
+ );
+}
diff --git a/test/browser/layer-tests/geojson-layer-specs.js b/test/browser/layer-tests/geojson-layer-specs.js
index f60f9c8f4..cc24669a2 100644
--- a/test/browser/layer-tests/geojson-layer-specs.js
+++ b/test/browser/layer-tests/geojson-layer-specs.js
@@ -525,6 +525,7 @@ test('#GeojsonLayer -> renderLayer', t => {
columns: {
geojson: '_geojson'
},
+ isVisible: true,
visConfig: {
strokeColor: [4, 5, 6],
strokeOpacity: 0.1
diff --git a/test/helpers/layer-utils.js b/test/helpers/layer-utils.js
index ea610633c..85191b430 100644
--- a/test/helpers/layer-utils.js
+++ b/test/helpers/layer-utils.js
@@ -168,6 +168,7 @@ export function testRenderLayerCases(t, LayerClass, testCases) {
tc.datasets[layer.config.dataId].gpuFilter ||
getGpuFilterProps([], layer.config.dataId, tc.datasets[layer.config.dataId].fields),
interactionConfig: INITIAL_VIS_STATE.interactionConfig,
+ visible: true,
...(tc.renderArgs || {})
});