Skip to content

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

feat(layers): geojson layer inveert height optional (#3816)

Igor Dykhta228bfaccca10
diff --git a/src/components/src/side-panel/layer-panel/layer-configurator.tsx b/src/components/src/side-panel/layer-panel/layer-configurator.tsx
index 7c5790c90..826e89980 100644
--- a/src/components/src/side-panel/layer-panel/layer-configurator.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-configurator.tsx
@@ -1286,6 +1286,10 @@ export default function LayerConfiguratorFactory(
{...layer.visConfigSettings.fixedHeight}
{...visConfiguratorProps}
/>
+ <VisConfigSwitch
+ {...layer.visConfigSettings.invertHeight}
+ {...visConfiguratorProps}
+ />
<VisConfigSwitch {...visConfiguratorProps} {...layer.visConfigSettings.wireframe} />
</ConfigGroupCollapsibleContent>
</LayerConfigGroup>
diff --git a/src/constants/src/layers.ts b/src/constants/src/layers.ts
index 865f8ed13..dcf813abe 100644
--- a/src/constants/src/layers.ts
+++ b/src/constants/src/layers.ts
@@ -173,6 +173,14 @@ export const LAYER_VIS_CONFIGS: LayerVisConfigSettings = {
group: PROPERTY_GROUPS.height,
property: 'fixedHeight'
},
+ invertHeight: {
+ defaultValue: false,
+ type: 'boolean',
+ label: 'layerVisConfigs.invertHeight',
+ description: 'layerVisConfigs.invertHeightDescription',
+ group: PROPERTY_GROUPS.height,
+ property: 'invertHeight'
+ },
fixedElevation: {
defaultValue: true,
type: 'boolean',
diff --git a/src/layers/src/base-layer.ts b/src/layers/src/base-layer.ts
index 480553d47..c637668f1 100644
--- a/src/layers/src/base-layer.ts
+++ b/src/layers/src/base-layer.ts
@@ -1179,6 +1179,7 @@ class Layer implements KeplerLayer {
const {
field,
fixed,
+ invert,
scale,
domain,
range,
@@ -1194,6 +1195,7 @@ class Layer implements KeplerLayer {
if (shouldGetScale) {
const isFixed = fixed && this.config.visConfig[fixed];
+ const isInverted = Boolean(invert && this.config.visConfig[invert]);
const scaleFunction =
channelScaleType === CHANNEL_SCALES.color
@@ -1206,7 +1208,8 @@ class Layer implements KeplerLayer {
this.config[scale],
this.config[domain],
this.config.visConfig[range],
- isFixed
+ isFixed,
+ isInverted
);
const getFieldValue = this.accessVSFieldValue(this.config[field], indexKey);
@@ -1260,8 +1263,22 @@ class Layer implements KeplerLayer {
scale: string,
domain: VisualChannelDomain | DomainQuantiles,
range: any,
- fixed?: boolean
+ fixed?: boolean,
+ invert?: boolean
): GetVisChannelScaleReturnType {
+ // Reverse the scale output so the lowest input maps to the greatest height.
+ // Fixed height uses the domain as that output, which reflects the raw values.
+ const applyInvert = scaleFunction => {
+ if (!invert || typeof scaleFunction?.range !== 'function') {
+ return scaleFunction;
+ }
+ const currentRange = scaleFunction.range();
+ if (Array.isArray(currentRange) && currentRange.length > 1) {
+ scaleFunction.range(currentRange.slice().reverse());
+ }
+ return scaleFunction;
+ };
+
// if quantile is provided per zoom
if (isDomainQuantile(domain) && scale === SCALE_TYPES.quantile) {
const zSteps = domain.z;
@@ -1270,7 +1287,7 @@ class Layer implements KeplerLayer {
const scaleDomain = getDomainStepsbyZoom(domain.quantiles, zSteps, z);
const thresholds = getThresholdsFromQuantiles(scaleDomain, range.length);
- return getScaleFunction('threshold', range, thresholds, false);
+ return applyInvert(getScaleFunction('threshold', range, thresholds, false));
};
getScale.byZoom = true;
@@ -1288,7 +1305,7 @@ class Layer implements KeplerLayer {
const getScale = function getScaleByZoom(z) {
const scaleDomain = getDomainStepsbyZoom(domain.stops, zSteps, z);
- return getScaleFunction(scale, range, scaleDomain, fixed);
+ return applyInvert(getScaleFunction(scale, range, scaleDomain, fixed));
};
getScale.byZoom = true;
@@ -1299,7 +1316,7 @@ class Layer implements KeplerLayer {
.domain(domain)
.range(fixed ? domain : range);
(scaleFunc as {scaleType?: string}).scaleType = fixed ? 'linear' : scale;
- return scaleFunc;
+ return applyInvert(scaleFunc);
}
/**
@@ -1537,7 +1554,7 @@ class Layer implements KeplerLayer {
const updateTriggers: UpdateTriggers = {};
Object.values(this.visualChannels).forEach(visualChannel => {
// field range scale domain
- const {accessor, field, scale, domain, range, defaultValue, fixed} = visualChannel;
+ const {accessor, field, scale, domain, range, defaultValue, fixed, invert} = visualChannel;
if (accessor) {
updateTriggers[accessor] = {
@@ -1547,7 +1564,8 @@ class Layer implements KeplerLayer {
[range]: this.config.visConfig[range],
defaultValue:
typeof defaultValue === 'function' ? defaultValue(this.config) : defaultValue,
- ...(fixed ? {[fixed]: this.config.visConfig[fixed]} : {})
+ ...(fixed ? {[fixed]: this.config.visConfig[fixed]} : {}),
+ ...(invert ? {[invert]: this.config.visConfig[invert]} : {})
};
}
});
diff --git a/src/layers/src/geojson-layer/geojson-layer.spec.ts b/src/layers/src/geojson-layer/geojson-layer.spec.ts
index a4e7b14aa..8cd156119 100644
--- a/src/layers/src/geojson-layer/geojson-layer.spec.ts
+++ b/src/layers/src/geojson-layer/geojson-layer.spec.ts
@@ -146,6 +146,66 @@ describe('GeoJsonLayer default deck parameters', () => {
});
});
+describe('GeoJsonLayer invert height', () => {
+ const heightField = {
+ name: 'height',
+ type: 'real',
+ valueAccessor: d => d.height
+ };
+
+ const layerWithHeight = () => {
+ const layer = new GeoJsonLayer({id: 'geojson_invert_height'});
+ layer.config.heightField = heightField as any;
+ layer.config.heightDomain = [10, 40];
+ layer.config.heightScale = 'linear';
+ layer.config.visConfig.heightRange = [0, 500];
+ return layer;
+ };
+
+ const elevations = (layer: GeoJsonLayer) => {
+ const getElevation = layer.getAttributeAccessors({
+ dataAccessor: () => d => d,
+ dataContainer: {} as any
+ }).getElevation;
+ return [10, 25, 40, null].map(height => getElevation({height}));
+ };
+
+ test('defaults to off and sits on the height channel next to fixed height', () => {
+ const layer = new GeoJsonLayer({id: 'geojson_invert_height'});
+
+ expect(layer.config.visConfig.invertHeight).toBe(false);
+ expect(layer.visConfigSettings.invertHeight).toMatchObject({
+ defaultValue: false,
+ property: 'invertHeight',
+ group: 'height'
+ });
+ expect(layer.visualChannels.height.invert).toBe('invertHeight');
+ expect(layer.visualChannels.height.fixed).toBe('fixedHeight');
+ expect(layer.getVisualChannelUpdateTriggers().getElevation.invertHeight).toBe(false);
+
+ layer.config.visConfig.invertHeight = true;
+ expect(layer.getVisualChannelUpdateTriggers().getElevation.invertHeight).toBe(true);
+ });
+
+ test('swaps low and high polygons with fixed height off and on', () => {
+ const scaled = layerWithHeight();
+ expect(elevations(scaled)).toEqual([0, 250, 500, 0]);
+
+ scaled.config.visConfig.invertHeight = true;
+ expect(elevations(scaled)).toEqual([500, 250, 0, 0]);
+ expect(scaled.config.visConfig.heightRange).toEqual([0, 500]);
+
+ const fixed = layerWithHeight();
+ fixed.config.visConfig.fixedHeight = true;
+ expect(elevations(fixed)).toEqual([10, 25, 40, 0]);
+
+ fixed.config.visConfig.invertHeight = true;
+ expect(elevations(fixed)).toEqual([40, 25, 10, 0]);
+ expect(fixed.config.heightDomain).toEqual([10, 40]);
+ expect(fixed.config.visConfig.heightRange).toEqual([0, 500]);
+ });
+});
+
describe('GeoJsonLayer hover overlay cache', () => {
const polygonFeature = {
type: 'Feature' as const,
diff --git a/src/layers/src/geojson-layer/geojson-layer.ts b/src/layers/src/geojson-layer/geojson-layer.ts
index e9b01a8be..9b52bc9b1 100644
--- a/src/layers/src/geojson-layer/geojson-layer.ts
+++ b/src/layers/src/geojson-layer/geojson-layer.ts
@@ -88,6 +88,7 @@ export const geojsonVisConfigs: {
enable3d: 'enable3d';
wireframe: 'wireframe';
fixedHeight: 'fixedHeight';
+ invertHeight: 'invertHeight';
fixedElevation: 'fixedElevation';
allowHover: 'allowHover';
} = {
@@ -122,6 +123,7 @@ export const geojsonVisConfigs: {
enable3d: 'enable3d',
wireframe: 'wireframe',
fixedHeight: 'fixedHeight',
+ invertHeight: 'invertHeight',
fixedElevation: 'fixedElevation',
allowHover: 'allowHover'
};
@@ -142,6 +144,7 @@ export type GeoJsonVisConfigSettings = {
elevationOffset: VisConfigNumber;
elevationOffsetRange: VisConfigRange;
fixedHeight: VisConfigBoolean;
+ invertHeight: VisConfigBoolean;
fixedElevation: VisConfigBoolean;
stroked: VisConfigBoolean;
filled: VisConfigBoolean;
@@ -174,6 +177,7 @@ export type GeoJsonLayerVisConfig = {
enable3d: boolean;
wireframe: boolean;
fixedHeight: boolean;
+ invertHeight: boolean;
fixedElevation: boolean;
allowHover: boolean;
};
@@ -427,6 +431,7 @@ export default class GeoJsonLayer extends Layer {
range: 'heightRange',
key: 'height',
fixed: 'fixedHeight',
+ invert: 'invertHeight',
channelScaleType: CHANNEL_SCALES.size,
accessor: 'getElevation',
condition: config => config.visConfig.enable3d,
diff --git a/src/localization/src/translations/en.ts b/src/localization/src/translations/en.ts
index 3c60f038b..cdfe7500e 100644
--- a/src/localization/src/translations/en.ts
+++ b/src/localization/src/translations/en.ts
@@ -230,6 +230,8 @@ export default {
heightMultiplier: 'Height Multiplier',
fixedHeight: 'Fixed height',
fixedHeightDescription: 'Use height without modifications',
+ invertHeight: 'Invert height',
+ invertHeightDescription: 'Map the lowest values to the greatest height',
fixedElevation: 'Fixed elevation',
fixedElevationDescription: 'Use elevation offset without modifications',
allowHover: 'Allow hover',
diff --git a/src/types/layers.d.ts b/src/types/layers.d.ts
index 670ee8929..0267e048f 100644
--- a/src/types/layers.d.ts
+++ b/src/types/layers.d.ts
@@ -371,6 +371,7 @@ export type LayerVisConfigSettings = {
heatmapRadius: VisConfigNumber;
darkBaseMapEnabled: VisConfigBoolean;
fixedHeight: VisConfigBoolean;
+ invertHeight: VisConfigBoolean;
fixedElevation: VisConfigBoolean;
allowHover: VisConfigBoolean;
showNeighborOnHover: VisConfigBoolean;
@@ -518,6 +519,8 @@ export type VisualChannel = {
// TODO: define fixed
fixed?: any;
+ // visConfig key that reverses this channel's scale output (e.g. invertHeight)
+ invert?: string;
supportedFieldTypes?: Array<SupportedFieldTypes>;
diff --git a/test/fixtures/state-saved-v0.js b/test/fixtures/state-saved-v0.js
index f32c34674..85a263c15 100644
--- a/test/fixtures/state-saved-v0.js
+++ b/test/fixtures/state-saved-v0.js
@@ -1417,6 +1417,7 @@ mergedLayer4.config = {
heightRange: [0, 500],
elevationScale: 1,
fixedHeight: false,
+ invertHeight: false,
elevationOffset: 0,
elevationOffsetRange: [0, 500],
fixedElevation: true,
diff --git a/test/fixtures/state-saved-v1-1.js b/test/fixtures/state-saved-v1-1.js
index ca471d969..f39ab2a45 100644
--- a/test/fixtures/state-saved-v1-1.js
+++ b/test/fixtures/state-saved-v1-1.js
@@ -972,6 +972,7 @@ mergedLayer0.config = {
heightRange: [0, 500],
elevationScale: 18,
fixedHeight: false,
+ invertHeight: false,
elevationOffset: 0,
elevationOffsetRange: [0, 500],
fixedElevation: true,
@@ -2773,6 +2774,7 @@ mergedLayer1.config = {
heightRange: [0, 500],
elevationScale: 5,
fixedHeight: false,
+ invertHeight: false,
elevationOffset: 0,
elevationOffsetRange: [0, 500],
fixedElevation: true,
diff --git a/test/helpers/mock-state.js b/test/helpers/mock-state.js
index a2dc28ac5..72ddf49c3 100644
--- a/test/helpers/mock-state.js
+++ b/test/helpers/mock-state.js
@@ -1018,6 +1018,7 @@ export const expectedSavedLayer2 = {
heightRange: [0, 500],
elevationScale: 1,
fixedHeight: false,
+ invertHeight: false,
elevationOffset: 0,
elevationOffsetRange: [0, 500],
fixedElevation: true,
@@ -1073,6 +1074,7 @@ export const expectedLoadedLayer2 = {
heightRange: [0, 500],
elevationScale: 1,
fixedHeight: false,
+ invertHeight: false,
elevationOffset: 0,
elevationOffsetRange: [0, 500],
fixedElevation: true,