Skip to content

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

[feat] Convert layer order from idx to layer IDs (#2203)

Igor Dykhta28fbcdbffe60
diff --git a/src/actions/src/vis-state-actions.ts b/src/actions/src/vis-state-actions.ts
index 44fda1a67..edb0e5db7 100644
--- a/src/actions/src/vis-state-actions.ts
+++ b/src/actions/src/vis-state-actions.ts
@@ -408,7 +408,7 @@ export function addLayer(
}
export type ReorderLayerUpdaterAction = {
- order: number[];
+ order: string[];
};
/**
* Reorder layer, order is an array of layer indexes, index 0 will be the one at the bottom
@@ -418,12 +418,12 @@ export type ReorderLayerUpdaterAction = {
* @public
* @example
*
- * // bring `layers[1]` below `layers[0]`, the sequence layers will be rendered is `1`, `0`, `2`, `3`.
- * // `1` will be at the bottom, `3` will be at the top.
- * this.props.dispatch(reorderLayer([1, 0, 2, 3]));
+ * bring `layers[1]` below `layers[0]`, the sequence layers will be rendered is `layers[1].id`, `layers[0].id`, `layers[2].id`, `layers[3].id`.
+ * `layers[1]` will be at the bottom, `layers[13]` will be at the top.
+ * this.props.dispatch(reorderLayer([`layers[1].id`, `layers[0].id`, `layers[2].id`, `layers[3].id`]));
*/
export function reorderLayer(
- order: number[]
+ order: string[]
): Merge<ReorderLayerUpdaterAction, {type: typeof ActionTypes.REORDER_LAYER}> {
return {
type: ActionTypes.REORDER_LAYER,
@@ -451,7 +451,7 @@ export function removeFilter(
}
export type RemoveLayerUpdaterAction = {
- id: string | number;
+ id: string;
};
/**
* Remove a layer
@@ -461,7 +461,7 @@ export type RemoveLayerUpdaterAction = {
* @public
*/
export function removeLayer(
- id: string | number
+ id: string
): Merge<RemoveLayerUpdaterAction, {type: typeof ActionTypes.REMOVE_LAYER}> {
return {
type: ActionTypes.REMOVE_LAYER,
@@ -470,21 +470,21 @@ export function removeLayer(
}
export type DuplicateLayerUpdaterAction = {
- idx: number;
+ id: string;
};
/**
* Duplicate a layer
* @memberof visStateActions
- * @param idx idx of layer to be duplicated
+ * @param id id of layer to be duplicated
* @returns action
* @public
*/
export function duplicateLayer(
- idx: number
+ id: string
): Merge<DuplicateLayerUpdaterAction, {type: typeof ActionTypes.DUPLICATE_LAYER}> {
return {
type: ActionTypes.DUPLICATE_LAYER,
- idx
+ id
};
}
diff --git a/src/components/src/kepler-gl.tsx b/src/components/src/kepler-gl.tsx
index 024a73351..a80d32e14 100644
--- a/src/components/src/kepler-gl.tsx
+++ b/src/components/src/kepler-gl.tsx
@@ -491,13 +491,13 @@ function KeplerGlFactory(
// update dndItems when layerOrder or layers change
this.setState((state, props) => {
const {
- visState: {layers, layerOrder}
+ visState: {layerOrder}
} = props;
return {
dndItems: {
...state.dndItems,
- sortablelist: layerOrder.map(layerIdx => layers[layerIdx].id)
+ sortablelist: layerOrder
}
};
});
diff --git a/src/components/src/side-panel/layer-manager.tsx b/src/components/src/side-panel/layer-manager.tsx
index 5a6420597..4eab819c9 100644
--- a/src/components/src/side-panel/layer-manager.tsx
+++ b/src/components/src/side-panel/layer-manager.tsx
@@ -56,7 +56,7 @@ type OverlayBlendingSelectorProps = {
type LayerManagerProps = {
datasets: Datasets;
layers: Layer[];
- layerOrder: number[];
+ layerOrder: string[];
layerClasses: LayerClassesType;
layerBlending: string;
overlayBlending: string;
diff --git a/src/components/src/side-panel/layer-panel/dataset-layer-group.tsx b/src/components/src/side-panel/layer-panel/dataset-layer-group.tsx
index 7d11da1fb..72f6dc49b 100644
--- a/src/components/src/side-panel/layer-panel/dataset-layer-group.tsx
+++ b/src/components/src/side-panel/layer-panel/dataset-layer-group.tsx
@@ -28,7 +28,7 @@ import {KeplerTable, Datasets} from '@kepler.gl/table';
type DatasetLayerGroupProps = {
datasets: Datasets;
layers: Layer[];
- layerOrder: number[];
+ layerOrder: string[];
layerClasses: LayerClassesType;
showDeleteDataset: boolean;
removeDataset: ActionHandler<typeof UIStateActions.openDeleteModal>;
diff --git a/src/components/src/side-panel/layer-panel/dataset-layer-section.tsx b/src/components/src/side-panel/layer-panel/dataset-layer-section.tsx
index 9f05400b3..fa931335e 100644
--- a/src/components/src/side-panel/layer-panel/dataset-layer-section.tsx
+++ b/src/components/src/side-panel/layer-panel/dataset-layer-section.tsx
@@ -31,7 +31,7 @@ type DatasetLayerSectionProps = {
datasets: Datasets;
dataset: KeplerTable;
layers: Layer[];
- layerOrder: number[];
+ layerOrder: string[];
layerClasses: LayerClassesType;
showDeleteDataset: boolean;
showDatasetTable: ActionHandler<typeof VisStateActions.showDatasetTable>;
diff --git a/src/components/src/side-panel/layer-panel/layer-list.tsx b/src/components/src/side-panel/layer-panel/layer-list.tsx
index a3f723416..2b2b28b29 100644
--- a/src/components/src/side-panel/layer-panel/layer-list.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-list.tsx
@@ -29,11 +29,12 @@ import {UIStateActions, VisStateActions} from '@kepler.gl/actions';
import {useDroppable} from '@dnd-kit/core';
import {useSortable, SortableContext, verticalListSortingStrategy} from '@dnd-kit/sortable';
import {CSS} from '@dnd-kit/utilities';
+import {findById} from '@kepler.gl/utils';
type LayerListProps = {
datasets: Datasets;
layers: Layer[];
- layerOrder: number[];
+ layerOrder: string[];
layerClasses: LayerClassesType;
isSortable?: boolean;
uiStateActions: typeof UIStateActions;
@@ -79,9 +80,9 @@ LayerListFactory.deps = [LayerPanelFactory];
function LayerListFactory(LayerPanel: ReturnType<typeof LayerPanelFactory>) {
// By wrapping layer panel using a sortable element we don't have to implement the drag and drop logic into the panel itself;
// Developers can provide any layer panel implementation and it will still be sortable
- const SortableItem = ({layerId, layers, layerIndex, panelProps, layerActions}) => {
+ const SortableItem = ({layer, layerIndex, panelProps, layerActions}) => {
const {attributes, listeners, setNodeRef, isDragging, transform, transition} = useSortable({
- id: layerId
+ id: layer.id
});
return (
@@ -95,9 +96,9 @@ function LayerListFactory(LayerPanel: ReturnType<typeof LayerPanelFactory>) {
<LayerPanel
{...panelProps}
{...layerActions}
- key={layerId}
+ key={layer.id}
idx={layerIndex}
- layer={layers[layerIndex]}
+ layer={layer}
listeners={listeners}
/>
</SortableStyledItem>
@@ -128,15 +129,20 @@ function LayerListFactory(LayerPanel: ReturnType<typeof LayerPanelFactory>) {
isSortable = true
} = props;
const {toggleModal: openModal} = uiStateActions;
- const layerOrdersToShow = useMemo(
- () =>
- layerOrder.filter(layerIdx => Boolean(layers[layerIdx]) && !layers[layerIdx].config.hidden),
- [layers, layerOrder]
- );
+
+ const layersToShow = useMemo(() => {
+ return layerOrder.reduce((acc, layerId) => {
+ const layer = findById<Layer>(layerId)(layers);
+ if (!layer) {
+ return acc;
+ }
+ return !layer.config.hidden ? [...acc, layer] : acc;
+ }, [] as Layer[]);
+ }, [layers, layerOrder]);
const sidePanelDndItems = useMemo(() => {
- return layerOrdersToShow.map(layerIdx => layers[layerIdx].id);
- }, [layerOrdersToShow, layers]);
+ return layersToShow.map(({id}) => id);
+ }, [layersToShow]);
const layerTypeOptions = useMemo(
() =>
@@ -175,34 +181,28 @@ function LayerListFactory(LayerPanel: ReturnType<typeof LayerPanelFactory>) {
<SortableList containerId="sortablelist" sidePanelDndItems={sidePanelDndItems}>
{/* warning: containerId should be similar to the first key in dndItems defined in kepler-gl.js*/}
- {layerOrdersToShow.map(layerIdx => (
+ {layersToShow.map(layer => (
<SortableItem
- key={layers[layerIdx].id}
- layerId={layers[layerIdx].id}
+ key={layer.id}
+ layer={layer}
+ layerIndex={layers.findIndex(({id}) => id === layer.id)}
panelProps={panelProps}
layerActions={layerActions}
- layers={layers}
- layerIndex={layerIdx}
/>
))}
</SortableList>
</>
) : (
<>
- {layerOrder.map(
- layerIdx =>
- layers[layerIdx] &&
- !layers[layerIdx].config.hidden && (
- <LayerPanel
- {...panelProps}
- {...layerActions}
- key={layers[layerIdx].id}
- idx={layerIdx}
- layer={layers[layerIdx]}
- isDraggable={false}
- />
- )
- )}
+ {layersToShow.map(layer => (
+ <LayerPanel
+ {...panelProps}
+ {...layerActions}
+ key={layer.id}
+ layer={layer}
+ isDraggable={false}
+ />
+ ))}
</>
);
};
diff --git a/src/components/src/side-panel/layer-panel/layer-panel.tsx b/src/components/src/side-panel/layer-panel/layer-panel.tsx
index c6be28608..5dfd5c418 100644
--- a/src/components/src/side-panel/layer-panel/layer-panel.tsx
+++ b/src/components/src/side-panel/layer-panel/layer-panel.tsx
@@ -41,7 +41,6 @@ type LayerPanelProps = {
onTouchStart?: TouchEventHandler;
layer: Layer;
datasets: Datasets;
- idx: number;
layerTypeOptions: {
id: string;
label: string;
@@ -133,12 +132,12 @@ function LayerPanelFactory(
_removeLayer: MouseEventHandler = e => {
e.stopPropagation();
- this.props.removeLayer(this.props.idx);
+ this.props.removeLayer(this.props.layer.id);
};
_duplicateLayer: MouseEventHandler = e => {
e.stopPropagation();
- this.props.duplicateLayer(this.props.idx);
+ this.props.duplicateLayer(this.props.layer.id);
};
render() {
diff --git a/src/components/src/types.ts b/src/components/src/types.ts
index 2f2c45969..c2a8f07c0 100644
--- a/src/components/src/types.ts
+++ b/src/components/src/types.ts
@@ -27,7 +27,7 @@ export type SidePanelProps = {
overlayBlending: string;
layers: Layer[];
layerClasses: LayerClassesType;
- layerOrder: number[];
+ layerOrder: string[];
mapStyle: MapStyle;
onSaveMap?: () => void;
width: number;
diff --git a/src/layers/src/mapbox-utils.ts b/src/layers/src/mapbox-utils.ts
index 7cfffc0f2..1f6584b71 100644
--- a/src/layers/src/mapbox-utils.ts
+++ b/src/layers/src/mapbox-utils.ts
@@ -21,6 +21,8 @@
import Layer, {OVERLAY_TYPE_CONST} from './base-layer';
import {Feature} from 'geojson';
+import {findById} from '@kepler.gl/utils';
+
/**
* This function will convert layers to mapbox layers
* @param layers the layers to be converted
@@ -32,28 +34,38 @@ import {Feature} from 'geojson';
export function generateMapboxLayers(
layers: Layer[] = [],
layerData: any[] = [],
- layerOrder: number[] = [],
+ layerOrder: string[] = [],
layersToRender: {[key: string]: boolean} = {}
): {[key: string]: Layer} {
if (layerData.length > 0) {
return layerOrder
.slice()
.reverse()
- .filter(
- idx =>
- layers[idx].overlayType === OVERLAY_TYPE_CONST.mapboxgl && layersToRender[layers[idx].id]
- )
- .reduce((accu, index) => {
- const layer = layers[index];
+ .filter(layerId => {
+ const layer = findById<Layer>(layerId)(layers);
+ return layer?.overlayType === OVERLAY_TYPE_CONST.mapboxgl && layersToRender[layerId];
+ })
+ .reduce((acc, layerId) => {
+ const layerIndex = layers.findIndex(l => l.id === layerId);
+ if (layerIndex === -1) {
+ return acc;
+ }
+
+ const layer = layers[layerId];
+
+ if (!(layer.overlayType === OVERLAY_TYPE_CONST.mapboxgl && layersToRender[layerId])) {
+ return acc;
+ }
+
return {
- ...accu,
+ ...acc,
[layer.id]: {
id: layer.id,
- data: layerData[index].data,
+ data: layerData[layerIndex].data,
isVisible: layer.config.isVisible,
- config: layerData[index].config,
+ config: layerData[layerIndex].config,
hidden: layer.config.hidden,
- sourceId: layerData[index].config.source
+ sourceId: layerData[layerIndex].config.source
}
};
}, {});
diff --git a/src/reducers/src/composer-helpers.ts b/src/reducers/src/composer-helpers.ts
index a5a6c6177..0fbda7975 100644
--- a/src/reducers/src/composer-helpers.ts
+++ b/src/reducers/src/composer-helpers.ts
@@ -66,10 +66,14 @@ export function swap_<X extends {id: string}>(item: X): (arr: X[]) => X[] {
return arr => arr.map(a => (a.id === item.id ? item : a));
}
-export function findById<X extends {id: string}>(id: string): (arr: X[]) => X | undefined {
- return arr => arr.find(a => a.id === id);
+export function map_<X, T>(fn: (state: X) => T): (arr: X[]) => T[] {
+ return arr => arr.map(e => fn(e));
}
-export function map_<X>(fn: (state: X) => X): (arr: X[]) => X[] {
- return arr => arr.map(e => fn(e));
+export function filterOutById<X extends {id: string}>(id: string): (arr: X[]) => X[] {
+ return arr => arr.filter(e => e.id !== id);
+}
+
+export function removeElementAtIndex<X>(index: number): (arr: X[]) => X[] {
+ return arr => [...arr.slice(0, index), ...arr.slice(index + 1, arr.length)];
}
diff --git a/src/reducers/src/layer-utils.ts b/src/reducers/src/layer-utils.ts
index 2fca7edd7..3c188e276 100644
--- a/src/reducers/src/layer-utils.ts
+++ b/src/reducers/src/layer-utils.ts
@@ -200,11 +200,12 @@ export function getLayerHoverProp({
return null;
}
-export function renderDeckGlLayer(props: any, layerCallbacks: {[key: string]: any}, idx: number) {
+export function renderDeckGlLayer(props: any, layerCallbacks: {[key: string]: any}) {
const {
datasets,
- layers,
- layerData,
+ layer,
+ layerIndex,
+ data,
hoverInfo,
clicked,
mapState,
@@ -212,16 +213,15 @@ export function renderDeckGlLayer(props: any, layerCallbacks: {[key: string]: an
animationConfig,
mapLayers
} = props;
- const layer = layers[idx];
- const data = layerData[idx];
- const {gpuFilter} = datasets[layer.config.dataId] || {};
+ const dataset = datasets[layer.config.dataId];
+ const {gpuFilter} = dataset || {};
const objectHovered = clicked || hoverInfo;
const visible = !mapLayers || (mapLayers && mapLayers[layer.id]);
// Layer is Layer class
return layer.renderLayer({
data,
gpuFilter,
- idx,
+ idx: layerIndex,
interactionConfig,
layerCallbacks,
mapState,
@@ -362,14 +362,20 @@ export function computeDeckLayers(
dataLayers = layerOrder
.slice()
.reverse()
- .filter(idx => currentLayersForDeck[layers[idx].id])
- .reduce((overlays, idx) => {
- const bindedLayerCallbacks = layerCallbacks ? bindLayerCallbacks(layerCallbacks, idx) : {};
+ .filter(id => currentLayersForDeck[id])
+ .reduce((overlays, layerId) => {
+ const layerIndex = layers.findIndex(({id}) => id === layerId);
+ const bindedLayerCallbacks = layerCallbacks
+ ? bindLayerCallbacks(layerCallbacks, layerIndex)
+ : {};
+ const layer = layers[layerIndex];
+ const data = layerData[layerIndex];
const layerOverlay = renderDeckGlLayer(
{
datasets,
- layers,
- layerData,
+ layer,
+ layerIndex,
+ data,
hoverInfo,
clicked,
mapState,
@@ -377,8 +383,7 @@ export function computeDeckLayers(
animationConfig,
mapLayers
},
- bindedLayerCallbacks,
- idx
+ bindedLayerCallbacks
);
return overlays.concat(layerOverlay || []);
}, []);
@@ -420,3 +425,7 @@ export function computeDeckLayers(
return [...customBottomDeckLayers, ...dataLayers, ...customTopDeckLayers, ...editorLayer];
}
+
+export function getLayerOrderFromLayers<T extends {id: string}>(layers: T[]): string[] {
+ return layers.map(({id}) => id);
+}
diff --git a/src/reducers/src/vis-state-merger.ts b/src/reducers/src/vis-state-merger.ts
index 2da4aade7..89789083c 100644
--- a/src/reducers/src/vis-state-merger.ts
+++ b/src/reducers/src/vis-state-merger.ts
@@ -25,8 +25,10 @@ import {
arrayInsert,
getInitialMapLayersForSplitMap,
applyFiltersToDatasets,
- validateFiltersUpdateDatasets
+ validateFiltersUpdateDatasets,
+ findById
} from '@kepler.gl/utils';
+import {getLayerOrderFromLayers} from '@kepler.gl/reducers';
import {LayerColumns, LayerColumn, Layer} from '@kepler.gl/layers';
import {LAYER_BLENDINGS, OVERLAY_BLENDINGS} from '@kepler.gl/constants';
@@ -122,7 +124,7 @@ export function parseLayerConfig(
const savedConfig = {
version: CURRENT_VERSION,
config: {
- visState: {layers: [layerConfig], layerOrder: [0]}
+ visState: {layers: [layerConfig], layerOrder: [layerConfig.id]}
}
};
@@ -194,7 +196,10 @@ export function serializeLayer(
newLayer: Layer,
schema: KeplerGLSchemaClass
): ParsedLayer | undefined {
- const serializedVisState = serializeVisState({layers: [newLayer], layerOrder: [0]}, schema);
+ const serializedVisState = serializeVisState(
+ {layers: [newLayer], layerOrder: [newLayer.id]},
+ schema
+ );
return serializedVisState?.layers?.[0];
}
@@ -220,7 +225,9 @@ export function mergeLayers<S extends VisState>(
layersToMerge: NonNullable<ParsedConfig['visState']>['layers'] = [],
fromConfig?: boolean
): S {
- const preserveLayerOrder = fromConfig ? layersToMerge.map(l => l.id) : state.preserveLayerOrder;
+ const preserveLayerOrder = fromConfig
+ ? getLayerOrderFromLayers(layersToMerge)
+ : state.preserveLayerOrder;
if (!Array.isArray(layersToMerge) || !layersToMerge.length) {
return state;
}
@@ -268,9 +275,10 @@ export function insertLayerAtRightOrder(
return {newLayers: currentLayers, newLayerOrder: currentOrder};
}
// perservedOrder ['a', 'b', 'c'];
- // layerOrder [1, 0, 3]
- // layerOrderMap ['a', 'c']
- const currentLayerQueue = currentOrder.map(i => currentLayers[i]);
+ // layerOrder ['a', 'b', 'c']
+ const currentLayerQueue = currentOrder
+ .map(id => findById(id)(currentLayers))
+ .filter(layer => Boolean(layer));
const newLayers = currentLayers.concat(layersToInsert);
const newLayerOrderQueue = insertItemBasedOnPreservedOrder(
currentLayerQueue,
@@ -280,7 +288,7 @@ export function insertLayerAtRightOrder(
);
// reconstruct layerOrder after insert
- const newLayerOrder = newLayerOrderQueue.map(lyr => newLayers.findIndex(l => l.id === lyr.id));
+ const newLayerOrder = getLayerOrderFromLayers(newLayerOrderQueue);
return {
newLayerOrder,
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 2647affce..271652078 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -90,14 +90,22 @@ import {
DEFAULT_TEXT_LABEL,
COMPARE_TYPES
} from '@kepler.gl/constants';
-import {pick_, merge_, swap_, apply_, compose_} from './composer-helpers';
+import {
+ pick_,
+ merge_,
+ swap_,
+ apply_,
+ compose_,
+ removeElementAtIndex,
+ filterOutById
+} from './composer-helpers';
import KeplerGLSchema, {VisState, Merger, PostMergerPayload} from '@kepler.gl/schemas';
import {Filter, InteractionConfig, AnimationConfig, Editor, Field} from '@kepler.gl/types';
import {Loader} from '@loaders.gl/loader-utils';
-import {calculateLayerData, findDefaultLayer} from './layer-utils';
+import {calculateLayerData, findDefaultLayer, getLayerOrderFromLayers} from './layer-utils';
import {
copyTableAndUpdate,
Datasets,
@@ -642,6 +650,14 @@ export function layerTypeChangeUpdater(
};
}
+ // update layerOrder with new id
+ newState = {
+ ...newState,
+ layerOrder: newState.layerOrder.map(layerId =>
+ layerId === oldLayer.id ? newLayer.id : layerId
+ )
+ };
+
return newState;
}
@@ -1161,7 +1177,7 @@ export const addLayerUpdater = (
layers: [...state.layers, newLayer],
layerData: [...state.layerData, newLayerData],
// add new layer at the top
- layerOrder: [state.layerOrder.length, ...state.layerOrder],
+ layerOrder: [newLayer.id, ...state.layerOrder],
splitMaps: addNewLayersToSplitMap(state.splitMaps, newLayer)
};
};
@@ -1184,24 +1200,36 @@ export function removeLayerUpdater<T extends VisState>(
Console.warn(`can not remove layer with invalid id|idx ${id}`);
return state;
}
- const {layers, layerData, clicked, hoverInfo} = state;
- const layerToRemove = state.layers[idx];
- const newMaps = removeLayerFromSplitMaps(state.splitMaps, layerToRemove);
+ const {layers, layerData, layerOrder, clicked, hoverInfo} = state;
+ const layerToRemove = layers[idx];
const newState = {
...state,
- layers: [...layers.slice(0, idx), ...layers.slice(idx + 1, layers.length)],
- layerData: [...layerData.slice(0, idx), ...layerData.slice(idx + 1, layerData.length)],
- layerOrder: state.layerOrder.filter(i => i !== idx).map(pid => (pid > idx ? pid - 1 : pid)),
+ layers: filterOutById(layerToRemove.id)(layers),
+ layerData: removeElementAtIndex(idx)(layerData),
+ layerOrder: layerOrder.filter(layerId => layerId !== layerToRemove.id),
clicked: layerToRemove.isLayerHovered(clicked) ? undefined : clicked,
hoverInfo: layerToRemove.isLayerHovered(hoverInfo) ? undefined : hoverInfo,
- splitMaps: newMaps
+ splitMaps: removeLayerFromSplitMaps(state.splitMaps, layerToRemove)
// TODO: update filters, create helper to remove layer form filter (remove layerid and dataid) if mapped
};
return updateAnimationDomain(newState);
}
+/**
+ * Reorder layer
+ * @memberof visStateUpdaters
+ * @public
+ */
+export const reorderLayerUpdater = (
+ state: VisState,
+ {order}: VisStateActions.ReorderLayerUpdaterAction
+): VisState => ({
+ ...state,
+ layerOrder: order
+});
+
/**
* duplicate layer
* @memberof visStateUpdaters
@@ -1209,16 +1237,21 @@ export function removeLayerUpdater<T extends VisState>(
*/
export const duplicateLayerUpdater = (
state: VisState,
- {idx}: VisStateActions.DuplicateLayerUpdaterAction
+ {id}: VisStateActions.DuplicateLayerUpdaterAction
): VisState => {
- const {layers} = state;
- const original = state.layers[idx];
- const originalLayerOrderIdx = state.layerOrder.findIndex(i => i === idx);
-
- if (!original) {
- Console.warn(`layer.${idx} is undefined`);
+ const idx = Number.isFinite(id)
+ ? // support older API, remove layer by idx
+ Number(id)
+ : state.layers.findIndex(l => l.id === id);
+ if (idx < 0 || !state.layers[idx]) {
+ Console.warn(`layer ${idx} not found in layerOrder`);
return state;
}
+
+ const {layers} = state;
+ const original = layers[idx];
+
+ const originalLayerOrderIdx = state.layerOrder.findIndex(lid => lid === original.id);
let newLabel = `Copy of ${original.config.label}`;
let postfix = 0;
// eslint-disable-next-line no-loop-func
@@ -1238,38 +1271,20 @@ export const duplicateLayerUpdater = (
// add layer to state
let nextState = addLayerUpdater(state, {config: loadedLayer});
- // layers: ['a', 'b', 'c', 'd']
- // order: [3, 0, 1, 2]
- // [0, 3, 1, 2]
- // new added layer are at the top, move it to be on top of original layer
- const newLayerOrderIdx = nextState.layers.length - 1;
+ // retrieve newly created layer
+ const newLayer = nextState.layers[nextState.layers.length - 1];
+ // update layer order with newLyaer.id
const newLayerOrder = arrayInsert(
nextState.layerOrder.slice(1, nextState.layerOrder.length),
originalLayerOrderIdx,
- newLayerOrderIdx
+ newLayer.id
);
- nextState = {
- ...nextState,
- layerOrder: newLayerOrder
- };
+ nextState = reorderLayerUpdater(nextState, {order: newLayerOrder});
return updateAnimationDomain(nextState);
};
-/**
- * Reorder layer
- * @memberof visStateUpdaters
- * @public
- */
-export const reorderLayerUpdater = (
- state: VisState,
- {order}: VisStateActions.ReorderLayerUpdaterAction
-): VisState => ({
- ...state,
- layerOrder: order
-});
-
/**
* Remove a dataset and all layers, filters, tooltip configs that based on it
* @memberof visStateUpdaters
@@ -2110,8 +2125,8 @@ export function addDefaultLayers(
...state,
layers: [...state.layers, ...defaultLayers],
layerOrder: [
- // put new layers on top of old ones
- ...defaultLayers.map((_, i) => state.layers.length + i),
+ // put new layers on top of old ones in reverse
+ ...getLayerOrderFromLayers(defaultLayers),
...state.layerOrder
]
},
diff --git a/src/schemas/src/vis-state-schema.ts b/src/schemas/src/vis-state-schema.ts
index 6effd554b..2628b6b4f 100644
--- a/src/schemas/src/vis-state-schema.ts
+++ b/src/schemas/src/vis-state-schema.ts
@@ -21,11 +21,11 @@
import pick from 'lodash.pick';
import {VERSIONS} from './versions';
import {LAYER_VIS_CONFIGS, FILTER_VIEW_TYPES} from '@kepler.gl/constants';
-import {AddDataToMapOptions} from '@kepler.gl/types';
-import {isFilterValidToSave, notNullorUndefined} from '@kepler.gl/utils';
+import {isFilterValidToSave, notNullorUndefined, findById} from '@kepler.gl/utils';
import Schema from './schema';
import cloneDeep from 'lodash.clonedeep';
import {
+ AddDataToMapOptions,
AnimationConfig,
Editor,
FileLoading,
@@ -67,7 +67,7 @@ export interface VisState {
layers: Layer[];
layerData: any[];
layerToBeMerged: any[];
- layerOrder: number[];
+ layerOrder: string[];
filters: Filter[];
filterToBeMerged: any[];
datasets: Datasets;
@@ -571,10 +571,10 @@ export class LayerSchemaV0 extends Schema {
const [visState] = parents.slice(-1);
return {
- [this.key as 'layers']: visState.layerOrder.reduce((saved, index) => {
+ [this.key as 'layers']: visState.layerOrder.reduce((saved, layerId) => {
// save layers according to their rendering order
- const layer = layers[index];
- if (layer.isValidToSave()) {
+ const layer = findById<Layer>(layerId)(layers);
+ if (layer?.isValidToSave()) {
saved.push(this.savePropertiesOrApplySchema(layer).layers);
}
return saved;
diff --git a/src/utils/src/index.ts b/src/utils/src/index.ts
index 3c283718b..e3fa51984 100644
--- a/src/utils/src/index.ts
+++ b/src/utils/src/index.ts
@@ -141,7 +141,8 @@ export {
filterObjectByPredicate,
isFunction,
hasMobileWidth,
- hasPortableWidth
+ hasPortableWidth,
+ findById
} from './utils';
export {
addNewLayersToSplitMap,
diff --git a/src/utils/src/utils.ts b/src/utils/src/utils.ts
index 2f8e411ea..755cdd30b 100644
--- a/src/utils/src/utils.ts
+++ b/src/utils/src/utils.ts
@@ -211,3 +211,18 @@ export function filterObjectByPredicate(obj, predicate) {
export function isFunction(func) {
return typeof func === 'function';
}
+
+export function findById<X extends {id: string}>(id: string): (arr: X[]) => X | undefined {
+ return arr => arr.find(a => a.id === id);
+}
+
+/**
+ * Returns array difference from
+ */
+export function arrayDifference<X extends {id: string}>(origin: X[]): (compare: X[]) => X[] {
+ return compare =>
+ origin.reduce((acc, element) => {
+ const foundElement = findById<X>(element.id)(compare);
+ return foundElement ? [...acc, foundElement] : acc;
+ }, [] as X[]);
+}
diff --git a/test/helpers/layer-utils.js b/test/helpers/layer-utils.js
index 0ba7f53cc..25cdc7d30 100644
--- a/test/helpers/layer-utils.js
+++ b/test/helpers/layer-utils.js
@@ -240,12 +240,15 @@ function testAttributeUpdate(t, attributeValues, layer, shouldUpdate) {
export function renderLayerByState(t, state, layerManager) {
const layerCallbacks = () => {};
const layer = state.visState.layers[0];
+ const data = state.visState.layerData[0];
let layerOverlay;
t.doesNotThrow(() => {
layerOverlay = renderDeckGlLayer(
{
...state.visState,
+ layer,
+ data,
mapState: state.mapState
},
layerCallbacks,
diff --git a/test/helpers/mock-state.js b/test/helpers/mock-state.js
index 4c9ff389f..3a57dc717 100644
--- a/test/helpers/mock-state.js
+++ b/test/helpers/mock-state.js
@@ -116,11 +116,16 @@ export function mockStateWithFileUpload() {
drainTasksForTesting();
// replace layer id and color with controlled value for testing
updatedState.visState.layers.forEach((l, i) => {
+ const oldLayerId = l.id;
l.id = `${l.type}-${i}`;
l.config.color = [i, i, i];
if (l.config.visConfig.strokeColor) {
l.config.visConfig.strokeColor = [i + 10, i + 10, i + 10];
}
+ // update layerOrder with newly created IDs
+ updatedState.visState.layerOrder = updatedState.visState.layerOrder.map(layerId =>
+ layerId === oldLayerId ? l.id : layerId
+ );
});
test(t => {
@@ -144,8 +149,13 @@ function mockStateWithTripGeojson() {
// replace layer id and color with controlled value for testing
updatedState.visState.layers.forEach((l, i) => {
+ const oldLayerId = l.id;
l.id = `${l.type}-${i}`;
l.config.color = [i, i, i];
+ // update layerOrder with newly created IDs
+ updatedState.visState.layerOrder = updatedState.visState.layerOrder.map(layerId =>
+ layerId === oldLayerId ? l.id : layerId
+ );
});
return updatedState;
@@ -409,7 +419,7 @@ export function mockStateWithLayerDimensions(state) {
}
]);
- const reorderPayload = [[2, 0, 1]];
+ const reorderPayload = [['hexagon-2', 'point-0', 'geojson-1']];
const resultState = applyActions(keplerGlReducer, prepareState, [
// reorder Layer
diff --git a/test/node/reducers/composer-state-test.js b/test/node/reducers/composer-state-test.js
index 6fd664d21..302027d27 100644
--- a/test/node/reducers/composer-state-test.js
+++ b/test/node/reducers/composer-state-test.js
@@ -206,6 +206,8 @@ test('#composerStateReducer - addDataToMapUpdater: keepExistingConfig', t => {
}
});
+ t.deepEqual(nextState1.visState.layerOrder, ['avlgol'], 'Should contain nextState1 layer order');
+
cmpDataset(t, expectedMergedDataset, nextState1.visState.datasets[hexDataId]);
t.deepEqual(nextState1.visState.splitMaps, [], 'should clear out splitMaps');
@@ -231,8 +233,9 @@ test('#composerStateReducer - addDataToMapUpdater: keepExistingConfig', t => {
const actualVisState = nextState2.visState;
+ const newLayers = [...oldLayers, mergedH3Layer];
const expectedVisState = {
- layers: [...oldLayers, mergedH3Layer],
+ layers: newLayers,
filters: [...oldFilters, ...mergedFilters],
datasets: 'test seperate',
interactionConfig: {
@@ -272,7 +275,7 @@ test('#composerStateReducer - addDataToMapUpdater: keepExistingConfig', t => {
}
}
],
- layerOrder: [2, 0, 1]
+ layerOrder: [newLayers[2].id, newLayers[0].id, newLayers[1].id]
};
cmpLayers(t, expectedVisState.layers, actualVisState.layers);
diff --git a/test/node/reducers/vis-state-merger-test.js b/test/node/reducers/vis-state-merger-test.js
index 75822c133..3f34f9053 100644
--- a/test/node/reducers/vis-state-merger-test.js
+++ b/test/node/reducers/vis-state-merger-test.js
@@ -34,14 +34,15 @@ import keplerGlReducer, {
applyMergersUpdater,
visStateReducer,
keplerGlReducerCore as coreReducer,
- defaultInteractionConfig
+ defaultInteractionConfig,
+ getLayerOrderFromLayers
} from '@kepler.gl/reducers';
import SchemaManager, {CURRENT_VERSION, visStateSchema} from '@kepler.gl/schemas';
import {processKeplerglJSON} from '@kepler.gl/processors';
import {updateVisData, receiveMapConfig, addDataToMap, registerEntry} from '@kepler.gl/actions';
-import {createDataContainer} from '@kepler.gl/utils';
+import {createDataContainer, findById} from '@kepler.gl/utils';
// fixtures
import {
@@ -343,15 +344,15 @@ test('VisStateMerger.current -> mergeLayers -> toEmptyState', t => {
const stateWData = visStateReducer(mergedState, updateVisData(parsedData));
// test parsed layers
- const genericLayersByOrder = stateToSave.visState.layerOrder.map(
- idx => stateToSave.visState.layers[idx]
+ const genericLayersByOrder = stateToSave.visState.layerOrder.map(id =>
+ findById(id)(stateToSave.visState.layers)
);
cmpLayers(t, genericLayersByOrder, stateWData.layers, {id: true});
t.end();
});
-test('visStateMerger -> mergeLayer -> imcremental load', t => {
+test('visStateMerger -> mergeLayer -> incremental load', t => {
const stateToSave = cloneDeep(StateWFilesFiltersLayerColor);
const appStateToSave = SchemaManager.save(stateToSave);
const {datasets, config} = appStateToSave;
@@ -387,7 +388,11 @@ test('visStateMerger -> mergeLayer -> imcremental load', t => {
'shoud load geojeon layer'
);
- t.deepEqual(stateWithData2.visState.layerOrder, [0], 'layerOrder should be correct');
+ t.deepEqual(
+ stateWithData2.visState.layerOrder,
+ [stateWithData2.visState.layers[0].id],
+ 'layerOrder should be correct'
+ );
t.deepEqual(
stateWithData2.visState.layerToBeMerged.map(l => l.id),
['hexagon-2', 'point-0'],
@@ -407,7 +412,15 @@ test('visStateMerger -> mergeLayer -> imcremental load', t => {
['geojson-1', 'hexagon-2', 'point-0'],
'shoud load 2 layers'
);
- t.deepEqual(stateWithData1.visState.layerOrder, [1, 2, 0], 'layerOrder should be correct');
+ t.deepEqual(
+ stateWithData1.visState.layerOrder,
+ [
+ stateWithData1.visState.layers[1].id,
+ stateWithData1.visState.layers[2].id,
+ stateWithData1.visState.layers[0].id
+ ],
+ 'layerOrder should be correct'
+ );
t.deepEqual(
stateWithData1.visState.layerToBeMerged.map(l => l.id),
[],
@@ -540,7 +553,14 @@ test('VisStateMerger.v0 -> mergeLayers -> toWorkingState', t => {
const parsedConfig = SchemaManager.parseSavedConfig(savedConfig.config);
const oldState = cloneDeep(StateWFilesFiltersLayerColor);
+
const oldVisState = oldState.visState;
+ t.deepEqual(
+ oldVisState.layerOrder,
+ ['hexagon-2', 'point-0', 'geojson-1'],
+ 'layer order should be correct'
+ );
+
const oldLayers = [...oldVisState.layers];
const parsedLayers = parsedConfig.visState.layers;
@@ -560,6 +580,12 @@ test('VisStateMerger.v0 -> mergeLayers -> toWorkingState', t => {
}
});
+ t.deepEqual(
+ mergedState.layerOrder,
+ ['hexagon-2', 'point-0', 'geojson-1'],
+ 'layer order should not change'
+ );
+
const parsedData = SchemaManager.parseSavedData(savedConfig.datasets);
// load data into reducer
@@ -570,7 +596,7 @@ test('VisStateMerger.v0 -> mergeLayers -> toWorkingState', t => {
t.deepEqual(
stateWData.layerOrder,
- [3, 4, 5, 6, 7, 2, 0, 1],
+ [...getLayerOrderFromLayers(mergedLayersV0), 'hexagon-2', 'point-0', 'geojson-1'],
'should put new layers on top of old ones'
);
t.deepEqual(stateWData.layerToBeMerged, [], 'should clean up layer to be merged');
@@ -585,6 +611,11 @@ test('VisStateMerger.v1 -> mergeLayers -> toWorkingState', t => {
const oldState = cloneDeep(StateWFilesFiltersLayerColor);
const oldVisState = oldState.visState;
+ t.deepEqual(
+ oldVisState.layerOrder,
+ ['hexagon-2', 'point-0', 'geojson-1'],
+ 'layer order should be correct'
+ );
const oldLayers = [...oldVisState.layers];
const parsedLayers = parsedConfig.visState.layers;
@@ -604,6 +635,12 @@ test('VisStateMerger.v1 -> mergeLayers -> toWorkingState', t => {
}
});
+ t.deepEqual(
+ mergedState.layerOrder,
+ ['hexagon-2', 'point-0', 'geojson-1'],
+ 'layer order should not change'
+ );
+
const parsedData = SchemaManager.parseSavedData(savedConfig.datasets);
// load data into reducer
@@ -612,7 +649,17 @@ test('VisStateMerger.v1 -> mergeLayers -> toWorkingState', t => {
// test parsed filters
cmpLayers(t, [...oldLayers, ...mergedLayersV1], stateWData.layers);
- t.deepEqual(stateWData.layerOrder, [3, 4, 2, 0, 1], 'should put new layers on top of old ones');
+ t.deepEqual(
+ stateWData.layerOrder,
+ [
+ stateWData.layers[3].id,
+ stateWData.layers[4].id,
+ stateWData.layers[2].id,
+ stateWData.layers[0].id,
+ stateWData.layers[1].id
+ ],
+ 'should put new layers on top of old ones'
+ );
t.deepEqual(stateWData.layerToBeMerged, [], 'should clean up layer to be merged');
t.equal(stateWData.layerData.length, 5, 'should calculate layer data');
@@ -1748,21 +1795,21 @@ test('VisStateMerger -> insertLayerAtRightOrder -> to empty config', t => {
{
load: [{id: 'b'}],
expectedLayers: [{id: 'b'}],
- expectedOrder: [0]
+ expectedOrder: ['b']
},
{
load: [{id: 'a'}, {id: 'c'}],
expectedLayers: [{id: 'b'}, {id: 'a'}, {id: 'c'}],
- expectedOrder: [1, 0, 2]
+ expectedOrder: ['a', 'b', 'c']
},
{
load: [{id: 'd'}],
expectedLayers: [{id: 'b'}, {id: 'a'}, {id: 'c'}, {id: 'd'}],
- expectedOrder: [1, 0, 2, 3]
+ expectedOrder: ['a', 'b', 'c', 'd']
}
],
expectedLayers: [{id: 'b'}, {id: 'a'}, {id: 'c'}, {id: 'd'}],
- expectedOrder: [1, 0, 2, 3]
+ expectedOrder: ['a', 'b', 'c', 'd']
},
{
preservedOrder: ['x', 'm', 'e', 'p', 'w', '6', 'h'],
@@ -1770,17 +1817,17 @@ test('VisStateMerger -> insertLayerAtRightOrder -> to empty config', t => {
{
load: [{id: '6'}],
expectedLayers: [{id: '6'}],
- expectedOrder: [0]
+ expectedOrder: ['6']
},
{
load: [{id: 'e'}],
expectedLayers: [{id: '6'}, {id: 'e'}],
- expectedOrder: [1, 0]
+ expectedOrder: ['e', '6']
},
{
load: [{id: 'x'}, {id: 'p'}, {id: 'w'}, {id: 'h'}],
expectedLayers: [{id: '6'}, {id: 'e'}, {id: 'x'}, {id: 'p'}, {id: 'w'}, {id: 'h'}],
- expectedOrder: [2, 1, 3, 4, 0, 5]
+ expectedOrder: ['x', 'e', 'p', 'w', '6', 'h']
},
{
load: [{id: 'm'}],
@@ -1793,11 +1840,11 @@ test('VisStateMerger -> insertLayerAtRightOrder -> to empty config', t => {
{id: 'h'},
{id: 'm'}
],
- expectedOrder: [2, 6, 1, 3, 4, 0, 5]
+ expectedOrder: ['x', 'm', 'e', 'p', 'w', '6', 'h']
}
],
expectedLayers: [{id: '6'}, {id: 'e'}, {id: 'x'}, {id: 'p'}, {id: 'w'}, {id: 'h'}, {id: 'm'}],
- expectedOrder: [2, 6, 1, 3, 4, 0, 5]
+ expectedOrder: ['x', 'm', 'e', 'p', 'w', '6', 'h']
},
{
preservedOrder: ['x', 'm', 'e', 'p', 'w', '6', 'h'],
@@ -1805,17 +1852,17 @@ test('VisStateMerger -> insertLayerAtRightOrder -> to empty config', t => {
{
load: [{id: 'x'}, {id: 'm'}],
expectedLayers: [{id: 'x'}, {id: 'm'}],
- expectedOrder: [0, 1]
+ expectedOrder: ['x', 'm']
},
{
load: [{id: 'w'}],
expectedLayers: [{id: 'x'}, {id: 'm'}, {id: 'w'}],
- expectedOrder: [0, 1, 2]
+ expectedOrder: ['x', 'm', 'w']
},
{
load: [{id: 'p'}],
expectedLayers: [{id: 'x'}, {id: 'm'}, {id: 'w'}, {id: 'p'}],
- expectedOrder: [0, 1, 3, 2]
+ expectedOrder: ['x', 'm', 'p', 'w']
},
{
load: [{id: 'e'}, {id: 'h'}, {id: '6'}],
@@ -1828,10 +1875,10 @@ test('VisStateMerger -> insertLayerAtRightOrder -> to empty config', t => {
{id: 'h'},
{id: '6'}
],
- expectedOrder: [0, 1, 4, 3, 2, 6, 5]
+ expectedOrder: ['x', 'm', 'e', 'p', 'w', '6', 'h']
}
],
- expectedOrder: [0, 1, 4, 3, 2, 6, 5],
+ expectedOrder: ['x', 'm', 'e', 'p', 'w', '6', 'h'],
expectedLayers: [{id: 'x'}, {id: 'm'}, {id: 'w'}, {id: 'p'}, {id: 'e'}, {id: 'h'}, {id: '6'}]
}
];
@@ -1866,21 +1913,21 @@ test('VisStateMerger -> insertLayerAtRightOrder -> to empty config', t => {
const preservedOrder = ['a', 'b', 'c', 'd'];
const batches = [
- {load: [{id: 'b'}], expectedLayers: [{id: 'm'}, {id: 'b'}], expectedOrder: [1, 0]},
+ {load: [{id: 'b'}], expectedLayers: [{id: 'm'}, {id: 'b'}], expectedOrder: ['b', 'm']},
{
load: [{id: 'a'}, {id: 'c'}],
expectedLayers: [{id: 'm'}, {id: 'b'}, {id: 'a'}, {id: 'c'}],
- expectedOrder: [2, 1, 3, 0]
+ expectedOrder: ['a', 'b', 'c', 'm']
},
{
load: [{id: 'd'}],
expectedLayers: [{id: 'm'}, {id: 'b'}, {id: 'a'}, {id: 'c'}, {id: 'd'}],
- expectedOrder: [2, 1, 3, 4, 0]
+ expectedOrder: ['a', 'b', 'c', 'd', 'm']
}
];
let currentLayers = [{id: 'm'}];
- let currentOrder = [0];
+ let currentOrder = ['m'];
// add layers in batch
for (const batch of batches) {
@@ -1929,7 +1976,7 @@ test('VisStateMerger -> createLayerFromConfig with Parsed Layer', t => {
// mock an exported layer config with visual channels
const savedLayer = visStateSchema[CURRENT_VERSION].save({
layers: [oldState.visState.layers[0]],
- layerOrder: [0]
+ layerOrder: [oldState.visState.layers[0].id]
}).visState.layers[0];
t.ok(savedLayer.visualChannels, 'Should have visualChannels');
diff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.js
index 786180ca1..715e43201 100644
--- a/test/node/reducers/vis-state-test.js
+++ b/test/node/reducers/vis-state-test.js
@@ -280,7 +280,7 @@ test('#visStateReducer -> ADD_LAYER.1', t => {
},
layers: [{id: 'existing_layer'}],
layerData: [[{data: [1, 2, 3]}, {data: [4, 5, 6]}]],
- layerOrder: [0],
+ layerOrder: ['existing_layer'],
splitMaps: [
{
layers: {existing_layer: false}
@@ -321,7 +321,11 @@ test('#visStateReducer -> ADD_LAYER.1', t => {
[oldState.layerData[0], {}],
'newState should have empty layer datat'
);
- t.deepEqual(newReducer.layerOrder, [1, 0], 'should add to layerOrder');
+ t.deepEqual(
+ newReducer.layerOrder,
+ [newReducer.layers[1].id, newReducer.layers[0].id],
+ 'should add to layerOrder'
+ );
t.deepEqual(newReducer.splitMaps, expectedSplitMaps, 'should add to SplitMaps');
t.end();
@@ -356,7 +360,7 @@ test('#visStateReducer -> LAYER_TYPE_CHANGE.1', t => {
},
layers: [{id: 'existing_layer'}, layer],
layerData: [[{data: [1, 2, 3]}, {data: [4, 5, 6]}]],
- layerOrder: [1, 0],
+ layerOrder: ['more_layer', 'existing_layer'],
hoverInfo: {
layer: {props: {id: 'more_layer'}},
picked: true
@@ -1075,7 +1079,7 @@ test('#visStateReducer -> REMOVE_LAYER', t => {
const oldState = {
layers: [layer1, layer2],
layerData: [{data: 1}, {data: 2}],
- layerOrder: [1, 0],
+ layerOrder: ['b', 'a'],
hoverInfo: {
layer: {props: {id: 'b'}},
picked: true
@@ -1095,7 +1099,7 @@ test('#visStateReducer -> REMOVE_LAYER', t => {
{
layers: [layer1],
layerData: [{data: 1}],
- layerOrder: [0],
+ layerOrder: ['a'],
hoverInfo: undefined,
clicked: {
layer: {props: {id: 'a'}},
@@ -1116,7 +1120,11 @@ test('#visStateReducer -> DUPLICATE_LAYER', t => {
// layers: ['point-0', 'geojson-1', 'hexagon-2'],
const layerToCopy = serializeLayer(oldState.layers[0], oldState.schema);
t.equal(oldState.layers.length, 3, 'should have 3 layers to begin');
- t.deepEqual(oldState.layerOrder, [2, 0, 1], 'should have 3 layers to begin');
+ t.deepEqual(
+ oldState.layerOrder,
+ [oldState.layers[2].id, oldState.layers[0].id, oldState.layers[1].id],
+ 'should have 3 layers to begin'
+ );
const nextState = reducer(oldState, VisStateActions.duplicateLayer(0));
t.equal(nextState.layers.length, 4, 'should add 1 layer');
@@ -1139,7 +1147,12 @@ test('#visStateReducer -> DUPLICATE_LAYER', t => {
);
t.deepEqual(
nextState.layerOrder,
- [2, 3, 0, 1],
+ [
+ nextState.layers[2].id,
+ nextState.layers[3].id,
+ nextState.layers[0].id,
+ nextState.layers[1].id
+ ],
'should insert copied layer in front of older layer'
);
@@ -1164,7 +1177,13 @@ test('#visStateReducer -> DUPLICATE_LAYER', t => {
);
t.deepEqual(
nextState1.layerOrder,
- [2, 3, 4, 0, 1],
+ [
+ nextState1.layers[2].id,
+ nextState1.layers[3].id,
+ nextState1.layers[4].id,
+ nextState1.layers[0].id,
+ nextState1.layers[1].id
+ ],
'should insert copied layer in front of older layer'
);
@@ -1187,175 +1206,6 @@ test('#visStateReducer -> DUPLICATE_LAYER', t => {
t.end();
});
-// TODO: not sure if this test is correct, it basically checks if the loaded visState is empty
-// if we load configuration through the schema manager all layers will be changing from having visualChannels to visualConfig
-// test('#visStateReducer -> SERIALIZE', t => {
-// const configuration = {
-// version: 'v1',
-// config: {
-// visState: {
-// filters: [
-// {
-// dataId: ['earthquakes'],
-// id: 'vo18yorx',
-// name: ['DateTime'],
-// type: 'timeRange',
-// value: [663046722470, 1301519405470],
-// enlarged: true,
-// plotType: 'histogram',
-// animationWindow: 'free',
-// yAxis: null,
-// speed: 1
-// }
-// ],
-// layers: [
-// {
-// id: 'hty62yd',
-// type: 'point',
-// config: {
-// dataId: 'earthquakes',
-// label: 'Point',
-// color: [23, 184, 190],
-// highlightColor: [252, 242, 26, 255],
-// columns: {
-// lat: 'Latitude',
-// lng: 'Longitude',
-// altitude: null
-// },
-// isVisible: true,
-// visConfig: {
-// radius: 10,
-// fixedRadius: false,
-// opacity: 0.39,
-// outline: false,
-// thickness: 2,
-// strokeColor: [23, 184, 190],
-// colorRange: {
-// name: 'ColorBrewer PRGn-6',
-// type: 'diverging',
-// category: 'ColorBrewer',
-// colors: ['#762a83', '#af8dc3', '#e7d4e8', '#d9f0d3', '#7fbf7b', '#1b7837'],
-// reversed: false
-// },
-// strokeColorRange: {
-// name: 'ColorBrewer PRGn-6',
-// type: 'diverging',
-// category: 'ColorBrewer',
-// colors: ['#762a83', '#af8dc3', '#e7d4e8', '#d9f0d3', '#7fbf7b', '#1b7837'],
-// reversed: false
-// },
-// radiusRange: [4.2, 96.2],
-// filled: true
-// },
-// hidden: false,
-// textLabel: [
-// {
-// field: null,
-// color: [255, 255, 255],
-// size: 18,
-// offset: [0, 0],
-// anchor: 'start',
-// alignment: 'center'
-// }
-// ]
-// },
-// visualChannels: {
-// colorField: {
-// name: 'Magnitude',
-// type: 'real'
-// },
-// colorScale: 'quantize',
-// strokeColorField: null,
-// strokeColorScale: 'quantile',
-// sizeField: {
-// name: 'Magnitude',
-// type: 'real'
-// },
-// sizeScale: 'sqrt'
-// }
-// }
-// ],
-// interactionConfig: {
-// tooltip: {
-// fieldsToShow: {
-// earthquakes: [
-// {
-// name: 'DateTime',
-// format: null
-// },
-// {
-// name: 'Latitude',
-// format: null
-// },
-// {
-// name: 'Longitude',
-// format: null
-// },
-// {
-// name: 'Depth',
-// format: null
-// },
-// {
-// name: 'Magnitude',
-// format: null
-// }
-// ]
-// },
-// compareMode: false,
-// compareType: 'absolute',
-// enabled: true
-// },
-// brush: {
-// size: 0.5,
-// enabled: false
-// },
-// geocoder: {
-// enabled: false
-// },
-// coordinate: {
-// enabled: false
-// }
-// },
-// layerBlending: 'normal',
-// splitMaps: [],
-// animationConfig: {
-// currentTime: null,
-// speed: 1
-// }
-// },
-// mapState: {
-// bearing: 0,
-// dragRotate: false,
-// latitude: 37.05881309947238,
-// longitude: -122.80009283836715,
-// pitch: 0,
-// zoom: 5.740491857794806,
-// isSplit: false
-// },
-// mapStyle: {
-// styleType: 'light',
-// topLayerGroups: {},
-// visibleLayerGroups: {
-// border: false,
-// building: true,
-// label: true,
-// land: true,
-// road: true,
-// water: true
-// },
-// threeDBuildingColor: [9.665468314072013, 17.18305478057247, 31.1442867897876],
-// mapStyles: {}
-// }
-// }
-// };
-//
-// const loadedVisState = visStateSchema[CURRENT_VERSION].load(configuration.config.visState);
-//
-// t.deepEqual(loadedVisState, {}, 'Should have the same configuration');
-//
-// t.end();
-// });
-
test('#visStateReducer -> UPDATE_VIS_DATA.1 -> No data', t => {
const oldState = CloneDeep(InitialState).visState;
const nextState1 = reducer(oldState, VisStateActions.updateVisData([{info: null, data: null}]));
@@ -1523,7 +1373,11 @@ test('#visStateReducer -> UPDATE_VIS_DATA.2 -> to empty state', t => {
cmpLayers(t, expectedLayers, newStateLayers);
t.equal(newState.layerData.length, expectedLayers.length, 'should calculate layerdata');
- t.deepEqual(newState.layerOrder, [0, 1, 2, 3], 'should calculate layerOrder');
+ t.deepEqual(
+ newState.layerOrder,
+ [newStateLayers[0].id, newStateLayers[1].id, newStateLayers[2].id, newStateLayers[3].id],
+ 'should calculate layerOrder'
+ );
t.end();
});
@@ -1578,7 +1432,7 @@ test('#visStateReducer -> UPDATE_VIS_DATA.3 -> merge w/ existing state', t => {
}
}
},
- layerOrder: [0],
+ layerOrder: [mockLayer.id],
layerBlending: 'additive',
splitMaps: []
};
@@ -1644,7 +1498,13 @@ test('#visStateReducer -> UPDATE_VIS_DATA.3 -> merge w/ existing state', t => {
t.equal(newState.layers.length, 5, 'should find 1 arc aline and 2 point layers');
t.deepEqual(
newState.layerOrder,
- [1, 2, 3, 4, 0],
+ [
+ newState.layers[1].id,
+ newState.layers[2].id,
+ newState.layers[3].id,
+ newState.layers[4].id,
+ newState.layers[0].id
+ ],
'should add new layer index to layer order, put them on top'
);
t.equal(newState.layers[1].config.dataId, 'smoothie', 'should save dataId to layer');
@@ -1963,14 +1823,6 @@ test('#visStateReducer -> UPDATE_VIS_DATA -> mergeFilters', t => {
datasets: expectedDatasets
};
- // cmpFilters(t, expectedState.filters, newState.filters);
- //
- // t.deepEqual(
- // newState.filterToBeMerged,
- // expectedState.filterToBeMerged,
- // 'should saved unmerged filter to filterToBeMerged'
- // );
-
cmpDatasets(t, expectedState.datasets, newState.datasets);
t.end();
@@ -2001,6 +1853,8 @@ test('#visStateReducer -> UPDATE_VIS_DATA.SPLIT_MAPS', t => {
isVisible: false
});
+ const layers = [layer0, layer1, layer2, layer3];
+
const oldState = {
...INITIAL_VIS_STATE,
layers: [layer0, layer1, layer2, layer3],
@@ -2028,7 +1882,7 @@ test('#visStateReducer -> UPDATE_VIS_DATA.SPLIT_MAPS', t => {
}
},
layerData: [],
- layerOrder: [2, 1, 0, 3]
+ layerOrder: [layers[2].id, layers[1].id, layers[0].id, layers[3].id]
};
const newState = reducer(
@@ -2061,7 +1915,20 @@ test('#visStateReducer -> UPDATE_VIS_DATA.SPLIT_MAPS', t => {
];
t.equal(newState.layers.length, 8, 'should create 1 arc 1 line and 2 point layers');
- t.deepEqual(newState.layerOrder, [4, 5, 6, 7, 2, 1, 0, 3], 'should move new layers to front');
+ t.deepEqual(
+ newState.layerOrder,
+ [
+ newState.layers[4].id,
+ newState.layers[5].id,
+ newState.layers[6].id,
+ newState.layers[7].id,
+ newState.layers[2].id,
+ newState.layers[1].id,
+ newState.layers[0].id,
+ newState.layers[3].id
+ ],
+ 'should move new layers to front'
+ );
t.deepEqual(newState.splitMaps, expectedSplitMaps, 'should add new layers to split maps');
t.end();
@@ -2100,7 +1967,7 @@ test('#visStateReducer -> setFilter.dynamicDomain & cpu', t => {
const expectedLayers = [expectedLayer1];
// test default layer
- t.equal(initialState.layers.length, 1, 'should find two layers');
+ t.equal(initialState.layers.length, 1, 'should find one layer');
cmpLayers(t, expectedLayers, initialState.layers);
@@ -3008,7 +2875,7 @@ test('#visStateReducer -> REMOVE_DATASET w filter and layer', t => {
layers: [oldState.layers[1]],
filters: [oldState.filters[1]],
layerData: [oldState.layerData[1]],
- layerOrder: [0],
+ layerOrder: [oldState.layers[1].id],
datasets: {
[testGeoJsonDataId]: oldState.datasets[testGeoJsonDataId]
},
@@ -3124,10 +2991,11 @@ test('#visStateReducer -> SPLIT_MAP: TOGGLE', t => {
test('#visStateReducer -> SPLIT_MAP: REMOVE_LAYER', t => {
const layer1 = new PointLayer({id: 'a'});
const layer2 = new PointLayer({id: 'b'});
+ const layers = [layer1, layer2];
const oldState = {
- layers: [layer1, layer2],
+ layers,
layerData: [{data: 1}, {data: 2}],
- layerOrder: [1, 0],
+ layerOrder: [layers[1].id, layers[0].id],
hoverInfo: {
layer: {props: {id: 'b'}},
picked: true
@@ -3160,7 +3028,7 @@ test('#visStateReducer -> SPLIT_MAP: REMOVE_LAYER', t => {
{
layers: [layer1],
layerData: [{data: 1}],
- layerOrder: [0],
+ layerOrder: [layer1.id],
hoverInfo: undefined,
clicked: {
layer: {props: {id: 'a'}},
@@ -3253,11 +3121,10 @@ test('#visStateReducer -> SPLIT_MAP: REMOVE_DATASET', t => {
const expectedState = {
layers: [oldState.layers[0]],
layerData: [oldState.layerData[0]],
- layerOrder: [0],
+ layerOrder: [oldState.layers[0].id],
datasets: {
[testCsvDataId]: oldState.datasets[testCsvDataId]
},
-
filters: [],
interactionConfig: {
tooltip: {
@@ -5377,7 +5244,7 @@ test('VisStateUpdater -> prepareStateForDatasetReplace', t => {
t.deepEqual(nextState.filterToBeMerged[0].dataId, [dataIdToUse], 'should replace filter dataId');
// preserveLayerOrder
- t.deepEqual(nextState.layerOrder, [0], 'should remove layer from layer order');
+ t.deepEqual(nextState.layerOrder, ['geojson-1'], 'should remove layer from layer order');
t.deepEqual(
nextState.preserveLayerOrder,
['geojson-1', 'point-0'],
diff --git a/test/node/utils/composer-helpers-test.js b/test/node/utils/composer-helpers-test.js
new file mode 100644
index 000000000..e1aeaf6c4
--- /dev/null
+++ b/test/node/utils/composer-helpers-test.js
@@ -0,0 +1,34 @@
+// Copyright (c) 2023 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import test from 'tape';
+import {filterOutById, removeElementAtIndex} from '@kepler.gl/reducers';
+
+test('#composeHelpers -> RemoveElementAtIndex', t => {
+ const list = [1, 2, 3, 4, 5];
+ t.deepEqual(removeElementAtIndex(1)(list), [1, 3, 4, 5], 'Should remove element at index');
+ t.end();
+});
+
+test('#composeHelpers -> filterOutById', t => {
+ const list = [{id: 1}, {id: 2}, {id: 3}];
+ t.deepEqual(filterOutById(1)(list), [{id: 2}, {id: 3}], 'Should remove element with specific id');
+ t.end();
+});
diff --git a/test/node/utils/index.js b/test/node/utils/index.js
index 21aacaec0..7a13cbfff 100644
--- a/test/node/utils/index.js
+++ b/test/node/utils/index.js
@@ -38,3 +38,4 @@ import './s2-utils-test';
import './editor-utils-test';
import './kepler-gl-utils-test';
import './timeline-test';
+import './composer-helpers-test';
diff --git a/test/node/utils/layer-utils-test.js b/test/node/utils/layer-utils-test.js
index 3973a6c70..b08d041b0 100644
--- a/test/node/utils/layer-utils-test.js
+++ b/test/node/utils/layer-utils-test.js
@@ -23,7 +23,7 @@ import cloneDeep from 'lodash.clonedeep';
import {processCsvData, processGeojson} from '@kepler.gl/processors';
import {LayerClasses, KeplerGlLayers} from '@kepler.gl/layers';
import {GEOJSON_FIELDS} from '@kepler.gl/constants';
-import {findDefaultLayer, getLayerHoverProp} from '@kepler.gl/reducers';
+import {findDefaultLayer, getLayerHoverProp, getLayerOrderFromLayers} from '@kepler.gl/reducers';
import {StateWTripGeojson, StateWFiles} from 'test/helpers/mock-state';
const {PointLayer, ArcLayer, GeojsonLayer, LineLayer} = KeplerGlLayers;
@@ -927,3 +927,11 @@ test('layerUtils -> getLayerHoverProp', t => {
t.end();
});
+
+test('layerUtils -> getLayerOrderFromLayers', t => {
+ const visState = cloneDeep(StateWFiles).visState;
+ const layerOrder = getLayerOrderFromLayers(visState.layers);
+
+ t.deepEqual(layerOrder, ['point-0', 'geojson-1'], 'Should generate layerOrder correctly');
+ t.end();
+});