Skip to content

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

fix: respect fixed height for S2 A5 and geohash (#3920)

Igor Dykhta72288da8304c
diff --git a/src/layers/src/a5-layer/a5-layer.ts b/src/layers/src/a5-layer/a5-layer.ts
index cf25cdcbc..48ac6f3de 100644
--- a/src/layers/src/a5-layer/a5-layer.ts
+++ b/src/layers/src/a5-layer/a5-layer.ts
@@ -230,6 +230,7 @@ export default class A5GeometryLayer extends Layer {
},
height: {
property: 'height',
+ fixed: 'fixedHeight',
field: 'heightField',
scale: 'heightScale',
domain: 'heightDomain',
diff --git a/src/layers/src/geohash-layer/geohash-layer.ts b/src/layers/src/geohash-layer/geohash-layer.ts
index ea13d0a08..63e05ffdf 100644
--- a/src/layers/src/geohash-layer/geohash-layer.ts
+++ b/src/layers/src/geohash-layer/geohash-layer.ts
@@ -220,6 +220,7 @@ export default class GeohashGeometryLayer extends Layer {
},
height: {
property: 'height',
+ fixed: 'fixedHeight',
field: 'heightField',
scale: 'heightScale',
domain: 'heightDomain',
diff --git a/src/layers/src/s2-geometry-layer/s2-geometry-layer.ts b/src/layers/src/s2-geometry-layer/s2-geometry-layer.ts
index e65d4aea3..f685b37ac 100644
--- a/src/layers/src/s2-geometry-layer/s2-geometry-layer.ts
+++ b/src/layers/src/s2-geometry-layer/s2-geometry-layer.ts
@@ -212,6 +212,7 @@ export default class S2GeometryLayer extends Layer {
},
height: {
property: 'height',
+ fixed: 'fixedHeight',
field: 'heightField',
scale: 'heightScale',
domain: 'heightDomain',
diff --git a/test/browser/layer-tests/a5-layer-specs.js b/test/browser/layer-tests/a5-layer-specs.js
index 9c9f0da0a..05a516973 100644
--- a/test/browser/layer-tests/a5-layer-specs.js
+++ b/test/browser/layer-tests/a5-layer-specs.js
@@ -230,3 +230,79 @@ test('#A5Geometry -> findDefaultLayerProps', t => {
t.equal(props[0].columns.token.value, 'a5', 'should auto-detect a5 column');
t.end();
});
+
+test('#A5Geometry -> fixed height uses source values', t => {
+ const dataset = new KeplerTable({info: {id: dataId}, color: [255, 0, 0]});
+ dataset.importData({
+ data: processCsvData(`token,height
+1ae2958000000000,0
+1ae2958000000000,10
+1ae2958000000000,20
+1ae2958000000000,
+`)
+ });
+ dataset.gpuFilter = getGpuFilterProps([], dataId, dataset.fields);
+ const datasets = {[dataId]: dataset};
+
+ testFormatLayerDataCases(t, A5GeometryLayer, [
+ {
+ name: 'fixed height',
+ layer: {
+ type: 'a5',
+ config: {
+ dataId,
+ columns: {token: 'token'},
+ heightField: {name: 'height', type: 'integer'},
+ visConfig: {
+ enable3d: true,
+ heightRange: [0, 100],
+ elevationScale: 1,
+ enableElevationZoomFactor: false
+ }
+ }
+ },
+ datasets,
+ assert: ({layer, layerData}) => {
+ for (const globe of [false, true]) {
+ let previousTriggers;
+ for (const fixedHeight of [false, true, false]) {
+ layer.updateLayerVisConfig({fixedHeight});
+ const data = layer.formatLayerData(datasets, layerData);
+ const [rendered] = layer.renderLayer({
+ data,
+ idx: 0,
+ mapState: {zoom: 10, globe: {enabled: globe}},
+ gpuFilter: dataset.gpuFilter,
+ interactionConfig: {},
+ visible: true
+ });
+ t.deepEqual(
+ rendered.props.data.map(rendered.props.getElevation),
+ fixedHeight ? [0, 10, 20, 0] : [0, 50, 100, 0],
+ `rendered elevations ${
+ fixedHeight ? 'preserve source values' : 'use height range'
+ } (globe=${globe})`
+ );
+ const triggers = rendered.props.updateTriggers.getElevation;
+ if (previousTriggers) {
+ t.notDeepEqual(
+ triggers,
+ previousTriggers,
+ 'toggling fixed height invalidates elevations'
+ );
+ }
+ previousTriggers = triggers;
+ }
+ }
+ layer.updateLayerVisConfig({fixedHeight: true});
+ layer.updateLayerConfig({heightField: null});
+ t.equal(
+ layer.formatLayerData(datasets).getElevation,
+ defaultElevation,
+ 'missing height field retains the default elevation'
+ );
+ }
+ }
+ ]);
+ t.end();
+});
diff --git a/test/browser/layer-tests/geohash-layer-specs.js b/test/browser/layer-tests/geohash-layer-specs.js
index 482ebd933..e1f0d0bf2 100644
--- a/test/browser/layer-tests/geohash-layer-specs.js
+++ b/test/browser/layer-tests/geohash-layer-specs.js
@@ -212,3 +212,79 @@ test('#GeohashGeometry -> findDefaultLayerProps', t => {
t.equal(props[0].columns.token.value, 'geohash', 'should auto-detect geohash column');
t.end();
});
+
+test('#GeohashGeometry -> fixed height uses source values', t => {
+ const dataset = new KeplerTable({info: {id: dataId}, color: [255, 0, 0]});
+ dataset.importData({
+ data: processCsvData(`token,height
+9q8yyk,0
+9q8yyk,10
+9q8yyk,20
+9q8yyk,
+`)
+ });
+ dataset.gpuFilter = getGpuFilterProps([], dataId, dataset.fields);
+ const datasets = {[dataId]: dataset};
+
+ testFormatLayerDataCases(t, GeohashGeometryLayer, [
+ {
+ name: 'fixed height',
+ layer: {
+ type: 'geohash',
+ config: {
+ dataId,
+ columns: {token: 'token'},
+ heightField: {name: 'height', type: 'integer'},
+ visConfig: {
+ enable3d: true,
+ heightRange: [0, 100],
+ elevationScale: 1,
+ enableElevationZoomFactor: false
+ }
+ }
+ },
+ datasets,
+ assert: ({layer, layerData}) => {
+ for (const globe of [false, true]) {
+ let previousTriggers;
+ for (const fixedHeight of [false, true, false]) {
+ layer.updateLayerVisConfig({fixedHeight});
+ const data = layer.formatLayerData(datasets, layerData);
+ const [rendered] = layer.renderLayer({
+ data,
+ idx: 0,
+ mapState: {zoom: 10, globe: {enabled: globe}},
+ gpuFilter: dataset.gpuFilter,
+ interactionConfig: {},
+ visible: true
+ });
+ t.deepEqual(
+ rendered.props.data.map(rendered.props.getElevation),
+ fixedHeight ? [0, 10, 20, 0] : [0, 50, 100, 0],
+ `rendered elevations ${
+ fixedHeight ? 'preserve source values' : 'use height range'
+ } (globe=${globe})`
+ );
+ const triggers = rendered.props.updateTriggers.getElevation;
+ if (previousTriggers) {
+ t.notDeepEqual(
+ triggers,
+ previousTriggers,
+ 'toggling fixed height invalidates elevations'
+ );
+ }
+ previousTriggers = triggers;
+ }
+ }
+ layer.updateLayerVisConfig({fixedHeight: true});
+ layer.updateLayerConfig({heightField: null});
+ t.equal(
+ layer.formatLayerData(datasets).getElevation,
+ defaultElevation,
+ 'missing height field retains the default elevation'
+ );
+ }
+ }
+ ]);
+ t.end();
+});
diff --git a/test/browser/layer-tests/s2-geometry-layer-specs.js b/test/browser/layer-tests/s2-geometry-layer-specs.js
index 85dca4523..6d3f16457 100644
--- a/test/browser/layer-tests/s2-geometry-layer-specs.js
+++ b/test/browser/layer-tests/s2-geometry-layer-specs.js
@@ -14,7 +14,8 @@ import {
preparedFilterDomain0
} from 'test/helpers/layer-utils';
import {s2DefaultElevation as defaultElevation, KeplerGlLayers} from '@kepler.gl/layers';
-import {copyTableAndUpdate} from '@kepler.gl/table';
+import {copyTableAndUpdate, getGpuFilterProps, KeplerTable} from '@kepler.gl/table';
+import {processCsvData} from '@kepler.gl/processors';
import {createDataContainer} from '@kepler.gl/utils';
import {INITIAL_MAP_STATE, INITIAL_VIS_STATE} from '@kepler.gl/reducers';
@@ -294,6 +295,82 @@ test('#S2Geometry -> renderLayer', t => {
t.end();
});
+test('#S2Geometry -> fixed height uses source values', t => {
+ const dataset = new KeplerTable({info: {id: dataId}, color: [255, 0, 0]});
+ dataset.importData({
+ data: processCsvData(`token,height
+8085801c,0
+8085801c,10
+8085801c,20
+8085801c,
+`)
+ });
+ dataset.gpuFilter = getGpuFilterProps([], dataId, dataset.fields);
+ const datasets = {[dataId]: dataset};
+
+ testFormatLayerDataCases(t, S2GeometryLayer, [
+ {
+ name: 'fixed height',
+ layer: {
+ type: 's2',
+ config: {
+ dataId,
+ columns: {token: 'token'},
+ heightField: {name: 'height', type: 'integer'},
+ visConfig: {
+ enable3d: true,
+ heightRange: [0, 100],
+ elevationScale: 1,
+ enableElevationZoomFactor: false
+ }
+ }
+ },
+ datasets,
+ assert: ({layer, layerData}) => {
+ for (const globe of [false, true]) {
+ let previousTriggers;
+ for (const fixedHeight of [false, true, false]) {
+ layer.updateLayerVisConfig({fixedHeight});
+ const data = layer.formatLayerData(datasets, layerData);
+ const [rendered] = layer.renderLayer({
+ data,
+ idx: 0,
+ mapState: {zoom: 10, globe: {enabled: globe}},
+ gpuFilter: dataset.gpuFilter,
+ interactionConfig: {},
+ visible: true
+ });
+ t.deepEqual(
+ rendered.props.data.map(rendered.props.getElevation),
+ fixedHeight ? [0, 10, 20, 0] : [0, 50, 100, 0],
+ `rendered elevations ${
+ fixedHeight ? 'preserve source values' : 'use height range'
+ } (globe=${globe})`
+ );
+ const triggers = rendered.props.updateTriggers.getElevation;
+ if (previousTriggers) {
+ t.notDeepEqual(
+ triggers,
+ previousTriggers,
+ 'toggling fixed height invalidates elevations'
+ );
+ }
+ previousTriggers = triggers;
+ }
+ }
+ layer.updateLayerVisConfig({fixedHeight: true});
+ layer.updateLayerConfig({heightField: null});
+ t.equal(
+ layer.formatLayerData(datasets).getElevation,
+ defaultElevation,
+ 'missing height field retains the default elevation'
+ );
+ }
+ }
+ ]);
+ t.end();
+});
+
test('#S2Geometry -> invalid non-hex tokens never reach polygon generation', t => {
const valid = ['80858004', "'80858004'", '"8085801c"', '8085801c'];
const invalid = ['zz', 'unknown', '8085800g', "'zz'", '"unknown"', '', null, undefined, 80858004];