Skip to content

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

feat: add override for vis config (#3379)

bdjulbic595bd909a6f5
diff --git a/src/reducers/src/layer-utils.ts b/src/reducers/src/layer-utils.ts
index 032a8a1d2..789bd3cf8 100644
--- a/src/reducers/src/layer-utils.ts
+++ b/src/reducers/src/layer-utils.ts
@@ -8,6 +8,7 @@ import {Layer as DeckLayer} from '@deck.gl/core';
type DeckLayerProps = any;
import {
Field,
+ LayerVisConfig,
TooltipField,
CompareType,
SplitMapLayers,
@@ -101,6 +102,55 @@ export function findDefaultLayer(dataset: KeplerTable, layerClasses: LayerClasse
});
}
+/**
+ * Applies `patch` to `config.visConfig` only for layers whose `dataId` is in `datasetIdsToPatch`.
+ * Layers for datasets that were already on the map are left unchanged — `addDataToMap`
+ * Keys whose patch value is `undefined` are skipped so existing visConfig is not cleared.
+ */
+export function mergeLayerVisConfigForNewDatasets(
+ state: VisState,
+ patch: Partial<LayerVisConfig> | undefined,
+ datasetIdsToPatch: string[]
+): VisState {
+ if (!patch || !Object.keys(patch).length) {
+ return state;
+ }
+
+ const hasDefinedPatchValue = (Object.keys(patch) as Array<keyof LayerVisConfig>).some(
+ key => patch[key] !== undefined
+ );
+ if (!hasDefinedPatchValue) {
+ return state;
+ }
+
+ const datasetIdSet = new Set(datasetIdsToPatch);
+
+ return {
+ ...state,
+ layers: state.layers.map(layer => {
+ if (!layer.config.dataId || !datasetIdSet.has(layer.config.dataId)) {
+ return layer;
+ }
+ const settings = layer.visConfigSettings;
+ if (!settings) {
+ return layer;
+ }
+ const allowedKeys = (Object.keys(patch) as Array<keyof LayerVisConfig>).filter(
+ key =>
+ Object.prototype.hasOwnProperty.call(settings, key) && patch[key] !== undefined
+ );
+ if (!allowedKeys.length) {
+ return layer;
+ }
+ const partial = allowedKeys.reduce<Partial<LayerVisConfig>>((acc, key) => {
+ acc[key] = patch[key];
+ return acc;
+ }, {});
+ return layer.updateLayerVisConfig(partial);
+ })
+ };
+}
+
type MinVisStateForLayerData = {
datasets: VisState['datasets'];
animationConfig: VisState['animationConfig'];
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 06de0f428..2c0bd1801 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -129,6 +129,7 @@ import {
FilterAnimationConfig,
Editor,
Field,
+ LayerVisConfig,
TimeRangeFilter
} from '@kepler.gl/types';
import {Loader} from '@loaders.gl/loader-utils';
@@ -143,7 +144,12 @@ import {
sortDatasetByColumn
} from '@kepler.gl/table';
import {findFieldsToShow} from './interaction-utils';
-import {calculateLayerData, findDefaultLayer, getLayerOrderFromLayers} from './layer-utils';
+import {
+ calculateLayerData,
+ findDefaultLayer,
+ getLayerOrderFromLayers,
+ mergeLayerVisConfigForNewDatasets
+} from './layer-utils';
import {getPropValueToMerger, hasPropsToMerge} from './merger-handler';
import {mergeDatasetsByOrder} from './vis-state-merger';
import {
@@ -2508,6 +2514,20 @@ export function applyMergersUpdater(
: mergeStateResult.mergedState;
}
+/** Reads `options.layerVisConfig` from add-data-to-map (see `AddDataToMapOptions`). */
+function layerVisConfigFromAddDataOptions(
+ options: PostMergerPayload['options'] | undefined
+): Partial<LayerVisConfig> | undefined {
+ if (!options || !('layerVisConfig' in options)) {
+ return undefined;
+ }
+ const patch = (options as {layerVisConfig?: unknown}).layerVisConfig;
+ if (patch == null || typeof patch !== 'object' || Array.isArray(patch)) {
+ return undefined;
+ }
+ return patch as Partial<LayerVisConfig>;
+}
+
/**
* Add new dataset to `visState`, with option to load a map config along with the datasets
*/
@@ -2551,6 +2571,12 @@ function postMergeUpdater(mergedState: VisState, postMergerPayload: PostMergerPa
};
}
+ mergedState = mergeLayerVisConfigForNewDatasets(
+ mergedState,
+ layerVisConfigFromAddDataOptions(options),
+ newDataIds
+ );
+
// if no tooltips merged add default tooltips
newDataIds.forEach(dataId => {
const tooltipFields = mergedState.interactionConfig.tooltip.config.fieldsToShow[dataId];
diff --git a/src/types/actions.d.ts b/src/types/actions.d.ts
index adac90d54..2f1a9de36 100644
--- a/src/types/actions.d.ts
+++ b/src/types/actions.d.ts
@@ -2,6 +2,7 @@
// Copyright contributors to the kepler.gl project
import {SavedMap, ParsedConfig, SavedConfigV1, MinSavedConfigV1} from './schemas';
+import type {LayerVisConfig} from './layers';
/** EXPORT_FILE_TO_CLOUD */
export type MapData = {
@@ -69,6 +70,7 @@ export type AddDataToMapOptions = {
keepExistingConfig?: boolean;
autoCreateLayers?: boolean;
autoCreateTooltips?: boolean;
+ layerVisConfig?: Partial<LayerVisConfig>;
};
export type AddDataToMapPayload = {
diff --git a/test/node/reducers/composer-state-test.js b/test/node/reducers/composer-state-test.js
index e4d4431fe..0fe174318 100644
--- a/test/node/reducers/composer-state-test.js
+++ b/test/node/reducers/composer-state-test.js
@@ -399,6 +399,82 @@ test('#composerStateReducer - addDataToMapUpdater: autoCreateLayers', t => {
t.end();
});
+test('#composerStateReducer - addDataToMapUpdater: layerVisConfig only affects new datasets; unknown keys ignored', t => {
+ const data = processCsvData(testCsvData);
+ const state = keplerGlReducer({}, registerEntry({id: 'test'})).test;
+
+ let oldState = addDataToMapUpdater(state, {
+ payload: {
+ datasets: {
+ data,
+ info: {id: 'first-csv-dataset'}
+ }
+ }
+ });
+ oldState = {
+ ...oldState,
+ visState: applyExistingDatasetTasks(visStateReducer, oldState.visState)
+ };
+ drainTasksForTesting();
+
+ const firstLayer = oldState.visState.layers.find(l => l.config.dataId === 'first-csv-dataset');
+ t.ok(firstLayer, 'first dataset should have a layer');
+ const allowHoverFirstBefore = firstLayer.config.visConfig.allowHover;
+
+ let nextState = addDataToMapUpdater(oldState, {
+ payload: {
+ datasets: {
+ data,
+ info: {id: 'second-csv-dataset'}
+ },
+ options: {
+ keepExistingConfig: true,
+ layerVisConfig: {
+ allowHover: false,
+ opacity: undefined,
+ totallyUnknownVisKey999: 'strip-me'
+ }
+ }
+ }
+ });
+ nextState = {
+ ...nextState,
+ visState: applyExistingDatasetTasks(visStateReducer, nextState.visState)
+ };
+ drainTasksForTesting();
+
+ const layerFirst = nextState.visState.layers.find(l => l.config.dataId === 'first-csv-dataset');
+ const layerSecond = nextState.visState.layers.find(l => l.config.dataId === 'second-csv-dataset');
+
+ t.ok(layerSecond, 'second dataset should have a layer');
+ t.equal(
+ layerFirst.config.visConfig.allowHover,
+ allowHoverFirstBefore,
+ 'layerVisConfig must not change visConfig for layers tied to prior datasets'
+ );
+ t.equal(
+ layerSecond.config.visConfig.allowHover,
+ false,
+ 'layerVisConfig should merge allowHover onto layers for datasets added in this action'
+ );
+ t.equal(
+ layerFirst.config.visConfig.totallyUnknownVisKey999,
+ undefined,
+ 'unknown keys must not be applied to existing layers'
+ );
+ t.equal(
+ layerSecond.config.visConfig.totallyUnknownVisKey999,
+ undefined,
+ 'unknown keys must not be merged into visConfig when absent from visConfigSettings'
+ );
+ t.ok(
+ typeof layerSecond.config.visConfig.opacity === 'number',
+ 'undefined patch values must not overwrite visConfig (e.g. opacity)'
+ );
+
+ t.end();
+});
+
test('#composerStateReducer - replaceDataInMapUpdater', t => {
const dataIdToReplace = 'dataset_to_replace';
const datasets = {