[fix] Hexbin layer color aggregation incorrect on load (#2415)

Signed-off-by: Ihor Dykhta <dikhta.igor@gmail.com> Co-authored-by: Jacob Wasilkowski <4933392+jwasilgeo@users.noreply.github.com>
keplergl · Oct 28, 2023 · b995c9b · b995c9b
1 parent 58f0bb7
commit b995c9b
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 18 deletions.
diff --git a/src/components/src/side-panel/layer-panel/layer-configurator.tsx b/src/components/src/side-panel/layer-panel/layer-configurator.tsx
@@ -45,7 +45,11 @@ import LayerErrorMessage from './layer-error-message';
 
 import {capitalizeFirstLetter} from '@kepler.gl/utils';
 
-import {CHANNEL_SCALE_SUPPORTED_FIELDS, LAYER_TYPES} from '@kepler.gl/constants';
+import {
+  CHANNEL_SCALE_SUPPORTED_FIELDS,
+  LAYER_TYPES,
+  AGGREGATION_TYPE_OPTIONS
+} from '@kepler.gl/constants';
 import {Layer, LayerBaseConfig, VisualChannel, AggregationLayer} from '@kepler.gl/layers';
 
 import {NestedPartial, LayerVisConfig, ColorUI, Field} from '@kepler.gl/types';
@@ -1183,16 +1187,31 @@ export const AggregationTypeSelector = ({channel, layer, onChange}: AggregationS
   const {visConfig} = layer.config;
 
   // aggregation should only be selectable when field is selected
-  const aggregationOptions = layer.getAggregationOptions(key);
+  const layerAggregationTypes = layer.getAggregationOptions(key);
+
+  const aggregationOptions = AGGREGATION_TYPE_OPTIONS.filter(({id}) =>
+    layerAggregationTypes.includes(id)
+  );
+
+  const selectedAggregation = aggregation
+    ? aggregationOptions.find(({id}) => id === visConfig[aggregation])
+    : [];
 
   return (
     <SidePanelSection>
       <PanelLabel>
-        <FormattedMessage id={'layer.aggregateBy'} values={{field: selectedField.name}} />
+        <FormattedMessage
+          id={'layer.aggregateBy'}
+          values={{
+            field: selectedField.displayName
+          }}
+        />
       </PanelLabel>
       <ItemSelector
-        selectedItems={visConfig[aggregation as string]}
+        selectedItems={selectedAggregation}
         options={aggregationOptions}
+        displayOption="label"
+        getOptionValue="id"
         multiSelect={false}
         searchable={false}
         onChange={value =>

diff --git a/src/constants/src/default-settings.ts b/src/constants/src/default-settings.ts
@@ -565,7 +565,7 @@ export const AGGREGATION_TYPES: {
   variance: 'variance';
   // ordinal
   mode: 'mode';
-  countUnique: 'count unique';
+  countUnique: 'countUnique';
 } = {
   // default
   count: 'count',
@@ -579,9 +579,23 @@ export const AGGREGATION_TYPES: {
   variance: 'variance',
   // ordinal
   mode: 'mode',
-  countUnique: 'count unique'
+  countUnique: 'countUnique'
 };
 
+export const AGGREGATION_TYPE_OPTIONS: {id: string; label: string}[] = Object.entries(
+  AGGREGATION_TYPES
+).map(([key, value]) => ({
+  id: key,
+  label:
+    key === 'stdev'
+      ? 'Std Deviation'
+      : key === 'countUnique'
+      ? 'Count Unique'
+      : typeof value === 'string'
+      ? value.charAt(0).toUpperCase() + value.slice(1)
+      : value
+}));
+
 export const linearFieldScaleFunctions = {
   [CHANNEL_SCALES.color]: [SCALE_TYPES.quantize, SCALE_TYPES.quantile],
   [CHANNEL_SCALES.radius]: [SCALE_TYPES.sqrt],

diff --git a/src/reducers/src/vis-state-merger.ts b/src/reducers/src/vis-state-merger.ts
@@ -831,11 +831,6 @@ export function validateLayerWithData(
     }
   }
 
-  // visual channel field is saved to be {name, type}
-  // find visual channel field by matching both name and type
-  // refer to vis-state-schema.js VisualChannelSchemaV1
-  newLayer = validateSavedVisualChannels(fields, newLayer, savedLayer, options);
-
   const textLabel =
     savedLayer.config.textLabel && newLayer.config.textLabel
       ? validateSavedTextLabel(
@@ -850,14 +845,21 @@ export function validateLayerWithData(
   const visConfig = newLayer.copyLayerConfig(
     newLayer.config.visConfig,
     savedLayer.config.visConfig || {},
-    {shallowCopy: ['colorRange', 'strokeColorRange']}
+    {
+      shallowCopy: ['colorRange', 'strokeColorRange']
+    }
   );
 
   newLayer.updateLayerConfig({
     visConfig,
     textLabel
   });
 
+  // visual channel field is saved to be {name, type}
+  // find visual channel field by matching both name and type
+  // refer to vis-state-schema.js VisualChannelSchemaV1
+  newLayer = validateSavedVisualChannels(fields, newLayer, savedLayer, options);
+
   if (throwOnError) {
     if (!newLayer.isValidToSave()) {
       throw new Error(`Layer is not valid to save: ${newLayer.id}`);

diff --git a/test/fixtures/state-saved-v0.js b/test/fixtures/state-saved-v0.js
@@ -1267,7 +1267,7 @@ mergedLayer3.config = {
   },
   visConfig: {
     colorAggregation: 'maximum',
-    sizeAggregation: 'average',
+    sizeAggregation: 'count',
     enable3d: true,
     opacity: 0.8,
     worldUnitSize: 0.5,

diff --git a/test/fixtures/state-saved-v1-3.js b/test/fixtures/state-saved-v1-3.js
@@ -263,7 +263,7 @@ export const savedStateV1 = {
                 percentile: [0, 96.54],
                 elevationPercentile: [0, 100],
                 elevationScale: 5,
-                colorAggregation: 'average',
+                colorAggregation: 'count', // if associated visualChannel colorField value is null, it can only default to 'count'
                 sizeAggregation: 'average',
                 enable3d: false
               }
@@ -468,8 +468,8 @@ mergedLayer1.config = {
     elevationPercentile: [0, 100],
     elevationScale: 5,
     enableElevationZoomFactor: true,
-    colorAggregation: 'average',
-    sizeAggregation: 'average',
+    colorAggregation: 'count', // if associated colorField value is null, it can only default to 'count'
+    sizeAggregation: 'count', // if associated sizeField value is null, it can only default to 'count'
     enable3d: false
   },
   animation: {enabled: false}

diff --git a/test/node/utils/aggregate-utils-test.js b/test/node/utils/aggregate-utils-test.js
@@ -45,12 +45,12 @@ test('AggregateUtils - GetMode', t => {
 
 test('AggregateUtils - aggregate', t => {
   const data = [1, 2, 3, 1, 2, 3, 4, 3];
-  const results = [8, 2.375, 4, 1, 2.5, 1.0606601717798212, 19, 1.125, '3', 8];
+  const results = [8, 2.375, 4, 1, 2.5, 1.0606601717798212, 19, 1.125, '3', 4];
   Object.keys(AGGREGATION_TYPES).map((technique, index) => {
     t.equal(
       aggregate(data, technique),
       results[index],
-      `Should compute the right aggregation using ${technique} - ${index}`
+      `Should compute the right aggregation using ${technique} - ${aggregate(data, technique)}`
     );
   });