Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
Upgrade Guide
Table of Content
- v3.2 to v3.3
- v2.4 to v3.0
- v2.3 to v2.4
- v2.2 to v2.3
- v2.1 to v2.2
- v2.0 to v2.1
- v1.1.12 to v2.0
- v1.1.11 to v1.1.12
Upgrade from v3.2 to v3.3
See the full upgrade guide: Upgrade Guide — kepler.gl 3.3
Highlights
- React 19 — kepler.gl now requires
react@^19.0.0andreact-dom@^19.0.0. React 18 is no longer supported. - react-redux v9 — upgraded from
^8.0.5to^9.1.0 - react-intl v7 — upgraded from
^6.3.0to^7.0.0 - react-map-gl 8 / maplibre-gl 4 — new
@vis.gl/react-maplibrepeer dependency - deck.gl 9 / luma.gl 9 — major rendering stack upgrade
- Node.js 20 — minimum raised from 18.18.2 to 20.19.3
- TypeScript 5.6 — upgraded from 4.7.2
- HeatmapLayer — rewritten from Mapbox GL to deck.gl base
layerOrder— type changed from flatstring[]to(string | LayerOrderGroup)[]LayerSelectorPanelFactory— removed from@kepler.gl/componentsreact-palmremoved — replaceimport {taskMiddleware} from 'react-palm/tasks'withimport {taskMiddleware} from '@kepler.gl/tasks'
Upgrade from v2.4 to v3.0
- TBD
Upgrade from v2.3 to v2.4
Breaking Changes
- Supports React 17
- Dependency Upgrades, major ones:
d3-xxx@^2,[email protected],[email protected],react-palm@~3.3.7
New Features
- Support incremental timeline animation
- Allow changing dataset in layer config
- Enable polygon filter for h3 layer
- Show last added filter at the top
Bug Fixes
- Avoid duplicated h3 layer detection
- Fixed bug when reversing color palette not update
Upgrade from v2.2 to v2.3
- Upgrade dependencies to
[email protected],[email protected]and[email protected]. This should only affects projects with the above libraries in its dependencies.
Upgrade from v2.1 to v2.2
New Features
- Interaction - Added Geocoder in the interactin panel
Improvements
- Localization - Added Spanish, Catalan, and Portuguese translations
Bug Fixes
- Layer - Aggregation layer fix out-of-domain coloring for valid strings
- Export - Fixed download file for microsoft edge
API Update
- Components - Exported map drawing editor factories
Upgrade from v2.0 to v2.1
Breaking Changes
- Upgrade Node v10 for dev development, node requirement is now at
>=10.15.0
New Features
- Provider - Add cloud provider API
- Layer - Added S2 Layer
- Basemap - Added satellite to base map styles options
- Theme - Added base UI theme to theme option as
base
Improvements
- UI - Improved data table and layer panel header
- Filter - Better handle filter steps for small domains
Bug Fixes
- Layer - Remove incorrect outlier for better map center detection
- Layer - Fix point layer stroke width
- Basemap - Fix bug custom map style not saved correctly
- Export - Fix bug exported html blank
Upgrade from v1.1.12 to v2.0
Breaking Changes
- Upgrade deck.gl to
8.0.15, this only affects projects with deck.gl in its dependencies. Because only one version of deck.gl can be loaded.
New Features
- GPU Filter - Improved time and numeric filter performance by moving calculation to GPU
- Geo Fitler - Added drawing polygon function, allow filter layer based on polygon
Improvements
- Layer - Improved GeoJson and H3 layer geometry rendering
- UI - Support custom side panel tabs. example
Bug Fixes
Upgrade from v1.1.11 to v1.1.12
Breaking Changes
Dependency Upgrade
- react and react-dom: minimum required version is now
^16.3 - react-redux is upgraded to
^7.1.3. If you have older version ofreact-reduxin your app. You will have error loading kepler.gl, likely due to multiple version ofreact-reduxinstalled. - react-palm: required version is now
^3.1.2. - react-route: if you are using
react-router, we suggest using^3.2.5to avoidReact 16.8lifecycle deprecation warning in the console.
Bug Fixes
- Cluster Layer: Fix incorrect cluster point count. Fix cluster layer missing in exported image.
Moved from kepler.gl/utils to @kepler.gl/table
maybeToDategetNewDatasetColorcreateNewDataEntrysetFilterGpuModeassignGpuChannelsassignGpuChannelresetFilterGpuModegetGpuFilterPropsgetDatasetFieldIndexForFilter
Moved from kepler.gl/utils to @kepler.gl/reducers
findMapBoundsexportDataTOOLTIP_MINUS_SIGNgetDefaultInteractionBRUSH_CONFIGfindFieldsToShowgetTooltipDisplayDeltaValuegetTooltipDisplayValueLayersToRenderAggregationLayerHoverDataLayerHoverPropfindDefaultLayercalculateLayerDatagetLayerHoverProprenderDeckGlLayerisLayerRenderableisLayerVisibleprepareLayersForDeckprepareLayersToRendergetCustomDeckLayersComputeDeckLayersPropscomputeDeckLayers
Moved from kepler.gl/processors to @kepler.gl/utils
ACCEPTED_ANALYZER_TYPESvalidateInputDatagetSampleForTypeAnalyzegetFieldsFromDatarenameDuplicateFieldsanalyzerTypeToFieldType
Moved from kepler.gl/templates to @kepler.gl/utils
exportMapToHTML
Moved from kepler.gl/layers to @kepler.gl/utils
getCentroididToPolygonGeoh3IsValidgetHexFields