Skip to content

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

fix: text labels ignore left/right visibility in split/swipe modes (#3729)

Igor Dykhta698fc230b62a
diff --git a/src/layers/src/base-layer.ts b/src/layers/src/base-layer.ts
index 2e5e13c7a..01a4a1794 100644
--- a/src/layers/src/base-layer.ts
+++ b/src/layers/src/base-layer.ts
@@ -1581,7 +1581,7 @@ class Layer implements KeplerLayer {
filterRange: gpuFilter ? gpuFilter.filterRange : undefined,
onFilteredItemsChange: gpuFilter ? layerCallbacks?.onFilteredItemsChange : undefined,
- // layer should be visible and if splitMap, shown in to one of panel
+ // layer should be visible and, if splitMap, shown in one of the panels
visible: this.config.isVisible && visible
};
}
@@ -1621,8 +1621,10 @@ class Layer implements KeplerLayer {
},
renderOpts
) {
- const {data, mapState} = renderOpts;
+ const {data, mapState, visible: visibleInMap} = renderOpts;
const {textLabel} = this.config;
+ // labels should be visible and, if splitMap, shown in one of the panels
+ const visible = this.config.isVisible && visibleInMap;
const TextLayerClass = isArrowTable(data.data) ? GeoArrowTextLayer : TextLayer;
@@ -1637,7 +1639,7 @@ class Layer implements KeplerLayer {
...sharedProps,
id: `${this.id}-label-${textLabel[i].field?.name}`,
data: data.data,
- visible: this.config.isVisible,
+ visible,
getText,
getPosition,
getFiltered,
diff --git a/src/reducers/src/layer-utils.ts b/src/reducers/src/layer-utils.ts
index 98e99522f..4310d6604 100644
--- a/src/reducers/src/layer-utils.ts
+++ b/src/reducers/src/layer-utils.ts
@@ -297,7 +297,9 @@ export function renderDeckGlLayer(props: any, layerCallbacks: {[key: string]: an
const dataset = datasets[layer.config.dataId];
const {gpuFilter} = dataset || {};
const objectHovered = clicked || hoverInfo;
- const visible = !mapLayers || (mapLayers && mapLayers[layer.id]);
+ // in split mode a layer missing from mapLayers is hidden, so coerce to a boolean
+ // instead of leaking undefined into deck.gl's visible prop
+ const visible = !mapLayers || Boolean(mapLayers[layer.id]);
// Layer is Layer class
return layer.renderLayer({
data,
diff --git a/test/browser/layer-tests/point-layer-specs.js b/test/browser/layer-tests/point-layer-specs.js
index 936465fa2..25cf52a2f 100644
--- a/test/browser/layer-tests/point-layer-specs.js
+++ b/test/browser/layer-tests/point-layer-specs.js
@@ -10,7 +10,7 @@ import cloneDeep from 'es-toolkit/compat/cloneDeep';
import {DEFAULT_TEXT_LABEL, PROJECTED_PIXEL_SIZE_MULTIPLIER} from '@kepler.gl/constants';
import {KeplerGlLayers} from '@kepler.gl/layers';
import {processGeojson} from '@kepler.gl/processors';
-import {INITIAL_MAP_STATE} from '@kepler.gl/reducers';
+import {INITIAL_MAP_STATE, INITIAL_VIS_STATE, renderDeckGlLayer} from '@kepler.gl/reducers';
import {copyTableAndUpdate} from '@kepler.gl/table';
import {hexToRgb} from '@kepler.gl/utils';
@@ -20,6 +20,8 @@ import {StateWArcNeighbors} from 'test/helpers/mock-state';
import {createNewDataEntryMock} from 'test/helpers/table-utils';
import {
testCreateCases,
+ testCreateLayerFromConfig,
+ testFormatLayerData,
testFormatLayerDataCases,
testRenderLayerCases,
testUpdateLayer,
@@ -773,6 +775,81 @@ test('#PointLayer -> renderLayer', t => {
t.end();
});
+test('#PointLayer -> renderLayer split map label visibility', t => {
+ const filteredIndex = [0, 2, 4];
+ const tc = {
+ layer: {
+ config: {
+ dataId,
+ label: 'gps point',
+ columns: {
+ lat: 'lat',
+ lng: 'lng',
+ altitude: 'id'
+ },
+ textLabel: [
+ {
+ field: {
+ name: 'types',
+ type: 'string'
+ }
+ }
+ ]
+ },
+ type: 'point',
+ id: 'test_layer_1'
+ },
+ datasets: {
+ [dataId]: copyTableAndUpdate(preparedDataset, {filteredIndex})
+ }
+ };
+
+ const layer = testCreateLayerFromConfig(t, tc, {point: PointLayer});
+ const data = testFormatLayerData(t, layer, tc.datasets);
+
+ const renderWithMapLayers = mapLayers =>
+ renderDeckGlLayer(
+ {
+ datasets: tc.datasets,
+ layer,
+ layerIndex: 0,
+ data,
+ mapState: INITIAL_MAP_STATE,
+ interactionConfig: INITIAL_VIS_STATE.interactionConfig,
+ mapLayers
+ },
+ {}
+ );
+
+ const assertVisible = (deckLayers, expected, message) => {
+ const labelLayers = deckLayers.filter(l => String(l.id).includes('-label-'));
+ t.ok(labelLayers.length > 0, `should create text label layers (${message})`);
+ t.equal(deckLayers[0].props.visible, expected, `geometry ${message}`);
+ labelLayers.forEach(l => {
+ t.equal(l.props.visible, expected, `${l.id} ${message}`);
+ });
+ };
+
+ assertVisible(
+ renderWithMapLayers(undefined),
+ true,
+ 'should be visible when mapLayers is not set'
+ );
+ assertVisible(
+ renderWithMapLayers({[layer.id]: true}),
+ true,
+ 'should be visible when the panel entry is true'
+ );
+ assertVisible(
+ renderWithMapLayers({[layer.id]: false}),
+ false,
+ 'should be hidden when the panel entry is false'
+ );
+ assertVisible(renderWithMapLayers({}), false, 'should be hidden when the panel entry is missing');
+
+ t.end();
+});
+
test('#PointLayer -> updateLayer', t => {
const layerConfig = {
id: 'test1',