24321173379

Committed 13 Apr 2026 01:13AM UTC coverage: 60.043% (-0.2%) from 60.226%

Build # 24321173379

Build Type

Pull #3372

github

Committed by

web-flow

Commit Message

Merge 4ed6c6dec into b87714fcc

Pull Request Pull Request #3372: feat: upgrade heatmap layer from mapbox to deckgl

Coverage Stats

6697 of 13290 branches covered (50.39%)

Branch coverage included in aggregate %.

33 of 67 new or added lines in 4 files covered. (49.25%)

18 existing lines in 3 files now uncovered.

13747 of 20759 relevant lines covered (66.22%)

77.58 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

1.02

/src/layers/src/mapbox-utils.ts

// SPDX-License-Identifier: MIT
// Copyright contributors to the kepler.gl project

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
 * @param layerData extra layer information
 * @param layerOrder the order by which we should convert layers
 * @param layersToRender {[id]: true | false} object whether each layer should be rendered
 * @returns
 */
export function generateMapboxLayers(
  layers: Layer[] = [],
  layerData: any[] = [],
  layerOrder: string[] = [],
  layersToRender: {[key: string]: boolean} = {}
): {[key: string]: Layer} {
  if (layerData.length > 0) {
    return layerOrder
      .slice()
      .reverse()
      .filter(layerId => {
        const layer = findById(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[layerIndex];

        if (!(layer.overlayType === OVERLAY_TYPE_CONST.mapboxgl && layersToRender[layerId])) {
          return acc;
        }

        return {
          ...acc,
          [layer.id]: {
            id: layer.id,
            data: layerData[layerIndex].data,
            isVisible: layer.config.isVisible,
            config: layerData[layerIndex].config,
            hidden: layer.config.hidden,
            sourceId: layerData[layerIndex].config.source
          }
        };
      }, {});
  }

  return {};
}

type newLayersType = {
  [key: string]: Layer & Partial<{data: any; sourceId: any; isVisible: boolean}>;
};
type oldLayersType = {[key: string]: Layer & {data?: any}};
/**
 * Update mapbox layers on the given map
 * @param map
 * @param newLayers Map of new mapbox layers to be displayed
 * @param oldLayers Map of the old layers to be compare with the current ones to detect deleted layers
 *                  {layerId: sourceId}
 */
export function updateMapboxLayers(
  map,
  newLayers: newLayersType = {},
  oldLayers: oldLayersType | null = null
) {
  // delete no longer existed old layers
  if (oldLayers) {
    checkAndRemoveOldLayers(map, oldLayers, newLayers);
  }

  // insert or update new layer
  Object.values(newLayers).forEach(overlay => {
    const {id: layerId, config, data, sourceId, isVisible} = overlay;
    if (!data && !config) {
      return;
    }

    const {data: oldData, config: oldConfig} = (oldLayers && oldLayers[layerId]) || {};

    if (data && data !== oldData) {
      updateSourceData(map, sourceId, data);
    }

    // compare with previous configs
    if (oldConfig !== config) {
      updateLayerConfig(map, layerId, config, isVisible);
    }
  });
}

function checkAndRemoveOldLayers(map, oldLayers: oldLayersType, newLayers: newLayersType) {
  Object.keys(oldLayers).forEach(layerId => {
    if (!newLayers[layerId]) {
      map.removeLayer(layerId);
    }
  });
}

function updateLayerConfig(map, layerId, config, isVisible) {
  const mapboxLayer = map.getLayer(layerId);

  if (mapboxLayer) {
    // check if layer already is set
    // remove it if exists
    map.removeLayer(layerId);
  }

  map.addLayer(config);
  map.setLayoutProperty(layerId, 'visibility', isVisible ? 'visible' : 'none');
}

function updateSourceData(map, sourceId, data) {
  const source = map.getSource(sourceId);

  if (!source) {
    map.addSource(sourceId, {
      type: 'geojson',
      data
    });
  } else {
    source.setData(data);
  }
}

/**
 *
 * @param filteredIndex
 * @param getGeometry {({index: number}) => any}
 * @param getProperties {({index: number}) => any}
 * @returns FeatureCollection
 */
export function geoJsonFromData(
  filteredIndex: number[] = [],
  getGeometry: (arg: {index: number}) => any,
  getProperties: (arg: {index: number}) => object
) {
  const geojson: {type: string; features: Feature[]} = {
    type: 'FeatureCollection',
    features: []
  };

  for (let i = 0; i < filteredIndex.length; i++) {
    const index = filteredIndex[i];
    const rowIndex = {index};
    const geometry = getGeometry(rowIndex);

    if (geometry) {
      geojson.features.push({
        type: 'Feature',
        properties: {
          index,
          ...getProperties(rowIndex)
        },
        geometry
      });
    }
  }

  return geojson;
}

export const prefixGpuField = name => `gpu:${name}`;

export function gpuFilterToMapboxFilter(gpuFilter) {
  const {filterRange, filterValueUpdateTriggers} = gpuFilter;

  const hasFilter = Object.values(filterValueUpdateTriggers).filter(d => d);

  if (!hasFilter.length) {
    return null;
  }

  const condition = ['all'];

  // [">=", key, value]
  // ["<=", key, value]
  const expressions = Object.values(filterValueUpdateTriggers as ({name: string} | null)[]).reduce(
    (accu: any[], gpu, i) =>
      gpu?.name
        ? [
            ...accu,
            ['>=', prefixGpuField(gpu.name), filterRange[i][0]],
            ['<=', prefixGpuField(gpu.name), filterRange[i][1]]
          ]
        : accu,
    condition
  );

  return expressions;
}

1	// SPDX-License-Identifier: MIT
2	// Copyright contributors to the kepler.gl project
3
4	import Layer, {OVERLAY_TYPE_CONST} from './base-layer';
5	import {Feature} from 'geojson';
6
7	import {findById} from '@kepler.gl/utils';
8
9	/**
10	* This function will convert layers to mapbox layers
11	* @param layers the layers to be converted
12	* @param layerData extra layer information
13	* @param layerOrder the order by which we should convert layers
14	* @param layersToRender {[id]: true \| false} object whether each layer should be rendered
15	* @returns
16	*/
17	export function generateMapboxLayers(
18	layers: Layer[] = [],	×
19	layerData: any[] = [],	×
20	layerOrder: string[] = [],	×
21	layersToRender: {[key: string]: boolean} = {}	×
22	): {[key: string]: Layer} {
23	if (layerData.length > 0) {	×
24	return layerOrder	×
25	.slice()
26	.reverse()
27	.filter(layerId => {
28	const layer = findById(layerId)(layers);	×
29	return layer?.overlayType === OVERLAY_TYPE_CONST.mapboxgl && layersToRender[layerId];	×
30	})
31	.reduce((acc, layerId) => {
32	const layerIndex = layers.findIndex(l => l.id === layerId);	×
33	if (layerIndex === -1) {	×
34	return acc;	×
35	}
36
37	const layer = layers[layerIndex];	×
38
39	if (!(layer.overlayType === OVERLAY_TYPE_CONST.mapboxgl && layersToRender[layerId])) {	×
40	return acc;	×
41	}
42
43	return {	×
44	...acc,
45	[layer.id]: {
46	id: layer.id,
47	data: layerData[layerIndex].data,
48	isVisible: layer.config.isVisible,
49	config: layerData[layerIndex].config,
50	hidden: layer.config.hidden,
51	sourceId: layerData[layerIndex].config.source
52	}
53	};
54	}, {});
55	}
56
57	return {};	×
58	}
59
60	type newLayersType = {
61	[key: string]: Layer & Partial<{data: any; sourceId: any; isVisible: boolean}>;
62	};
63	type oldLayersType = {[key: string]: Layer & {data?: any}};
64	/**
65	* Update mapbox layers on the given map
66	* @param map
67	* @param newLayers Map of new mapbox layers to be displayed
68	* @param oldLayers Map of the old layers to be compare with the current ones to detect deleted layers
69	* {layerId: sourceId}
70	*/
71	export function updateMapboxLayers(
72	map,
73	newLayers: newLayersType = {},	×
74	oldLayers: oldLayersType \| null = null	×
75	) {
76	// delete no longer existed old layers
77	if (oldLayers) {	×
78	checkAndRemoveOldLayers(map, oldLayers, newLayers);	×
79	}
80
81	// insert or update new layer
82	Object.values(newLayers).forEach(overlay => {	×
83	const {id: layerId, config, data, sourceId, isVisible} = overlay;	×
84	if (!data && !config) {	×
85	return;	×
86	}
87
88	const {data: oldData, config: oldConfig} = (oldLayers && oldLayers[layerId]) \|\| {};	×
89
90	if (data && data !== oldData) {	×
91	updateSourceData(map, sourceId, data);	×
92	}
93
94	// compare with previous configs
95	if (oldConfig !== config) {	×
96	updateLayerConfig(map, layerId, config, isVisible);	×
97	}
98	});
99	}
100
101	function checkAndRemoveOldLayers(map, oldLayers: oldLayersType, newLayers: newLayersType) {
102	Object.keys(oldLayers).forEach(layerId => {	×
103	if (!newLayers[layerId]) {	×
104	map.removeLayer(layerId);	×
105	}
106	});
107	}
108
109	function updateLayerConfig(map, layerId, config, isVisible) {
110	const mapboxLayer = map.getLayer(layerId);	×
111
112	if (mapboxLayer) {	×
113	// check if layer already is set
114	// remove it if exists
115	map.removeLayer(layerId);	×
116	}
117
118	map.addLayer(config);	×
119	map.setLayoutProperty(layerId, 'visibility', isVisible ? 'visible' : 'none');	×
120	}
121
122	function updateSourceData(map, sourceId, data) {
123	const source = map.getSource(sourceId);	×
124
125	if (!source) {	×
126	map.addSource(sourceId, {	×
127	type: 'geojson',
128	data
129	});
130	} else {
131	source.setData(data);	×
132	}
133	}
134
135	/**
136	*
137	* @param filteredIndex
138	* @param getGeometry {({index: number}) => any}
139	* @param getProperties {({index: number}) => any}
140	* @returns FeatureCollection
141	*/
142	export function geoJsonFromData(
143	filteredIndex: number[] = [],	×
144	getGeometry: (arg: {index: number}) => any,
145	getProperties: (arg: {index: number}) => object
146	) {
UNCOV 147	const geojson: {type: string; features: Feature[]} = {	×
148	type: 'FeatureCollection',
149	features: []
150	};
151
UNCOV 152	for (let i = 0; i < filteredIndex.length; i++) {	×
UNCOV 153	const index = filteredIndex[i];	×
UNCOV 154	const rowIndex = {index};	×
UNCOV 155	const geometry = getGeometry(rowIndex);	×
156
UNCOV 157	if (geometry) {	×
UNCOV 158	geojson.features.push({	×
159	type: 'Feature',
160	properties: {
161	index,
162	...getProperties(rowIndex)
163	},
164	geometry
165	});
166	}
167	}
168
UNCOV 169	return geojson;	×
170	}
171
172	export const prefixGpuField = name => `gpu:${name}`;	13✔
173
174	export function gpuFilterToMapboxFilter(gpuFilter) {
UNCOV 175	const {filterRange, filterValueUpdateTriggers} = gpuFilter;	×
176
UNCOV 177	const hasFilter = Object.values(filterValueUpdateTriggers).filter(d => d);	×
178
UNCOV 179	if (!hasFilter.length) {	×
UNCOV 180	return null;	×
181	}
182
UNCOV 183	const condition = ['all'];	×
184
185	// [">=", key, value]
186	// ["<=", key, value]
UNCOV 187	const expressions = Object.values(filterValueUpdateTriggers as ({name: string} \| null)[]).reduce(	×
188	(accu: any[], gpu, i) =>
UNCOV 189	gpu?.name	×
190	? [
191	...accu,
192	['>=', prefixGpuField(gpu.name), filterRange[i][0]],
193	['<=', prefixGpuField(gpu.name), filterRange[i][1]]
194	]
195	: accu,
196	condition
197	);
198
UNCOV 199	return expressions;	×
200	}

keplergl / kepler.gl / 24321173379

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous