Skip to content

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

fix: keep the tooltip compare mode in saved maps (#3978)

Javier Andrés García3fc065f84637
diff --git a/src/reducers/src/vis-state-merger.ts b/src/reducers/src/vis-state-merger.ts
index d89a6e3ee..c22edf932 100644
--- a/src/reducers/src/vis-state-merger.ts
+++ b/src/reducers/src/vis-state-merger.ts
@@ -36,7 +36,8 @@ import {
AnnotationKind,
isAnnotationKind,
INITIAL_ANNOTATION_LINE_COLOR,
- INITIAL_ANNOTATION_LINE_WIDTH
+ INITIAL_ANNOTATION_LINE_WIDTH,
+ COMPARE_TYPES
} from '@kepler.gl/constants';
import {CURRENT_VERSION, VisState, VisStateMergers, KeplerGLSchemaClass} from '@kepler.gl/schemas';
@@ -481,6 +482,10 @@ export function mergeLayerOrder<S extends VisState>(
};
}
+function isCompareType(value: unknown): value is TooltipInfo['config']['compareType'] {
+ return Object.values(COMPARE_TYPES).includes(value as string);
+}
+
/**
* Merge interactions with saved config
*
@@ -526,6 +531,13 @@ export function mergeInteractions<S extends VisState>(
},
...(savedTooltipConfig.timezone !== undefined
? {timezone: savedTooltipConfig.timezone}
+ : {}),
+ // saved maps write the compare settings with the tooltip; an older config may omit them
+ ...(typeof savedTooltipConfig.compareMode === 'boolean'
+ ? {compareMode: savedTooltipConfig.compareMode}
+ : {}),
+ ...(isCompareType(savedTooltipConfig.compareType)
+ ? {compareType: savedTooltipConfig.compareType}
: {})
};
diff --git a/test/node/reducers/vis-state-merger-test.js b/test/node/reducers/vis-state-merger-test.js
index 5e211d14e..65badabaa 100644
--- a/test/node/reducers/vis-state-merger-test.js
+++ b/test/node/reducers/vis-state-merger-test.js
@@ -1201,6 +1201,107 @@ test('VisStateMerger -> mergeInteractions -> tooltip timezone', t => {
t.end();
});
+test('VisStateMerger -> mergeInteractions -> tooltip compare mode', t => {
+ const initialVisState = cloneDeep(InitialState.visState);
+
+ const mergedWithCompare = mergeInteractions(initialVisState, {
+ tooltip: {
+ enabled: true,
+ fieldsToShow: {},
+ compareMode: true,
+ compareType: 'relative'
+ }
+ });
+ t.equal(
+ mergedWithCompare.interactionConfig.tooltip.config.compareMode,
+ true,
+ 'should hydrate a saved tooltip compareMode'
+ );
+ t.equal(
+ mergedWithCompare.interactionConfig.tooltip.config.compareType,
+ 'relative',
+ 'should hydrate a saved tooltip compareType'
+ );
+
+ const mergedWithoutCompare = mergeInteractions(mergedWithCompare, {
+ tooltip: {
+ enabled: true,
+ fieldsToShow: {}
+ }
+ });
+ t.equal(
+ mergedWithoutCompare.interactionConfig.tooltip.config.compareMode,
+ true,
+ 'should preserve the current compareMode when a config omits it'
+ );
+ t.equal(
+ mergedWithoutCompare.interactionConfig.tooltip.config.compareType,
+ 'relative',
+ 'should preserve the current compareType when a config omits it'
+ );
+
+ const mergedWithInvalidType = mergeInteractions(initialVisState, {
+ tooltip: {
+ enabled: true,
+ fieldsToShow: {},
+ compareMode: true,
+ compareType: 'unknown'
+ }
+ });
+ t.equal(
+ mergedWithInvalidType.interactionConfig.tooltip.config.compareType,
+ 'absolute',
+ 'should ignore an unknown compareType'
+ );
+
+ t.end();
+});
+
+test('VisStateMerger -> tooltip compare mode survives save and load', t => {
+ const initialVisState = cloneDeep(InitialState.visState);
+ const tooltip = initialVisState.interactionConfig.tooltip;
+ const savedState = {
+ ...initialVisState,
+ interactionConfig: {
+ ...initialVisState.interactionConfig,
+ tooltip: {
+ ...tooltip,
+ config: {...tooltip.config, compareMode: true, compareType: 'relative'}
+ }
+ }
+ };
+
+ const saved = SchemaManager.getConfigToSave({
+ visState: savedState,
+ mapState: InitialState.mapState,
+ mapStyle: InitialState.mapStyle,
+ uiState: InitialState.uiState
+ });
+ t.equal(
+ saved.config.visState.interactionConfig.tooltip.compareMode,
+ true,
+ 'saved config should write compareMode'
+ );
+
+ const parsed = SchemaManager.parseSavedConfig(saved);
+ const merged = mergeInteractions(
+ cloneDeep(InitialState.visState),
+ parsed.visState.interactionConfig
+ );
+ t.equal(
+ merged.interactionConfig.tooltip.config.compareMode,
+ true,
+ 'loaded map should keep compareMode'
+ );
+ t.equal(
+ merged.interactionConfig.tooltip.config.compareType,
+ 'relative',
+ 'loaded map should keep compareType'
+ );
+
+ t.end();
+});
+
test('VisStateMerger.v1 -> mergeInteractions -> toWorkingState', t => {
const savedConfig = cloneDeep(savedStateV1);
const oldState = cloneDeep(StateWFilesFiltersLayerColor);