Chevron DownAPI Reference

Upgrade Guide

Upgrading from deck.gl v8.1 to v8.2

  • The TileLayer now rounds the current zoom to determine the z at which to load tiles. This will load less tiles than the previous version. You can adjust the tileSize prop to modify this behavior.
  • Image URLs are now by default loaded in the ImageBitmap format, versus Image in the previous version. This improves the performance of loading textures. You may override this by supplying the loadOptions prop of a layer:
loadOptions: {
  image: {type: 'image'}
}

See ImageLoader options;

Upgrading from deck.gl v8.0 to v8.1

Breaking Changes

  • s2-geometry is no longer a dependency of @deck.gl/geo-layers. If you were using this module in an application, it needs to be explicitly added to package.json.
  • deck.gl no longer crashes if one of the layers encounters an error during update and/or render. By default, errors are now logged to the console. Specify the onError callback to manually handle errors in your application.
  • Deck now reacts to changes in the initialViewState prop. In 8.0 and earlier versions, this prop was not monitored after the deck instance was constructed. Starting 8.1, if initialViewState changes deeply, the camera will be reset. It is recommended that you use a constant for initialViewState to achieve behavior consistent with the previous versions.
Tile3DLayer
  • A new prop loader needs to be provided, one of CesiumIonLoader, Tiles3DLoader from (@loaders.gl/3d-tiles) or I3SLoader from (@loaders.gl/i3s).
  • The loadOptions prop is now used for passing all loaders.gl options, not just Tileset3D. To revert back to the 8.0 behavior, use {tileset: {throttleRequest: true}}.
  • _ionAccessId and _ionAccesToken props are removed. To render an ion dataset with Tile3DLayer, follow this example:
import {CesiumIonLoader} from '@loaders.gl/3d-tiles';
import {Tile3DLayer} from '@deck.gl/geo-layers';

// load 3d tiles from Cesium ion
const layer = new Tile3DLayer({
  id: 'tile-3d-layer',
  // tileset json file url
  data: 'https://assets.cesium.com/<ion_access_id>/tileset.json',
  loader: CesiumIonLoader,
  // https://cesium.com/docs/rest-api/
  loadOptions: {
    // https://loaders.gl/modules/tiles/docs/api-reference/tileset-3d#constructor-1
    tileset: {
      throttleRequests: true
    },
    'cesium-ion': {accessToken: '<ion_access_token_for_your_asset>'}
  }
});

Upgrading from deck.gl v7.x to v8.0

Breaking Changes

Defaults
  • The opacity prop of all layers is now default to 1 (used to be 0.8).
  • SimpleMeshLayer and ScenegraphLayer: modelMatrix will be composed to instance transformation matrix (derived from layer props getOrientation, getScale, getTranslation and getTransformMatrix) under CARTESIAN and METER_OFFSETS coordinates.
Removed
  • ArcLayer props
    • getStrokeWidth: use getWidth
  • LineLayer props
    • getStrokeWidth: use getWidth
  • PathLayer props
  • PolygonLayer and GeoJsonLayer props
  • H3HexagonLayer props
    • getColor: use getFillColor and getLineColor
  • Tile3DLayer props:
    • onTileLoadFail: use onTileError
  • TileLayer props:
    • onViewportLoaded: use onViewportLoad
  • project shader module
    • project_scale: use project_size
    • project_to_clipspace: use project_position_to_clipspace
    • project_pixel_to_clipspace: use project_pixel_size_to_clipspace
  • WebMercatorViewport class
    • getLocationAtPoint: use getMapCenterByLngLatPosition
    • lngLatDeltaToMeters
    • metersToLngLatDelta
  • Layer class
    • setLayerNeedsUpdate: use setNeedsUpdate
    • setUniforms: use model.setUniforms
    • use64bitProjection
    • projectFlat: use projectPosition
  • PerspectiveView class - use FirstPersonView
  • ThirdPersonView class - use MapView (geospatial) or OrbitView (info-vis)
  • COORDINATE_SYSTEM enum
    • LNGLAT_DEPRECATED: use LNGLAT
    • METERS: use METER_OFFSETS
React
  • DeckGL no longer injects its children with view props (width, height, viewState etc.). If your custom component needs these props, consider using the ContextProvider or a render callback:

    <DeckGL>
      {({width, height, viewState}) => (...)}
    </DeckGL>
  • The children of DeckGL are now placed above the canvas by default (except the react-map-gl base map). Wrap them in e.g. <div style={{zIndex: -1}}> if they are intended to be placed behind the canvas.

Debugging

deck.gl now removes most logging when bundling under NODE_ENV=production.

Standalone bundle

The pre-bundled version, a.k.a. the scripting API has been aligned with the interface of the core Deck class.

  • Top-level view state props such as longitude, latitude, zoom are no longer supported. To specify the default view state, use initialViewState.
  • controller is no longer on by default, use controller: true.
Textures

In older versions of deck, we used to set UNPACK_FLIP_Y_WEBGL by default when creating textures from images. This is removed in v8.0 to better align with WebGL best practice. As a result, the texCoords in the shaders of BitmapLayer, IconLayer and TextLayer are y-flipped. This only affects users who extend these layers.

Users of SimpleMeshLayer with texture will need to flip their texture image vertically.

The change has allowed us to support loading textures from ImageBitmap, in use cases such as rendering to OffscreenCanvas on a web worker.

projection system
  • The common space is no longer scaled to the current zoom level. This is part of an effort to make the geometry calculation more consistent and predictable. While one old common unit is equivalent to 1 screen pixel at the viewport center, one new common unit is equivalent to viewport.scale pixels at the viewport center.
  • viewport.distanceScales keys are renamed:
    • pixelsPerMeter -> unitsPerMeter
    • metersPerPixel -> metersPerUnit
  • Low part of a DOUBLE attribute is renamed from *64xyLow to *64Low and uses the same size as the high part. This mainly affect position attributes, e.g. all vec2 positions64xyLow and vec2 instancePositions64xyLow are now vec3 positions64Low and vec3 instancePositions64Low.
    • project: vec3 project_position(vec3 position, vec2 position64xyLow) is now vec3 project_position(vec3 position, vec3 position64Low).
    • project: vec4 project_position(vec4 position, vec2 position64xyLow) is now vec4 project_position(vec4 position, vec3 position64Low).
    • project32 and project64: vec4 project_position_to_clipspace(vec3 position, vec2 position64xyLow, vec3 offset) is now vec4 project_position_to_clipspace(vec3 position, vec3 position64Low, vec3 offset).
  • The shader module project64 is no longer included in @deck.gl/core and deck.gl. You can still import it from @deck.gl/extensions.
Shader modules

This change affects custom layers. deck.gl is no longer registering shaders by default. This means any modules array defined in layer.getShaders() or new Model() must now use the full shader module objects, instead of just their names. All supported shader modules can be imported from @deck.gl/core.

/// OLD
new Model({
  // ...
  modules: ['picking', 'project32', 'gouraud-lighting']
});

Should now become

import {picking, project32, gouraudLighting} from '@deck.gl/core';
/// NEW
new Model({
  // ...
  modules: [picking, project32, gouraudLighting]
});
Auto view state update

A bug was fixed where initial view state tracking could sometimes overwrite user-provided viewState prop. Apps that rely on auto view state update by specifying initialViewState should make sure that viewState is never assigned. If manual view state update is desired, use viewState and onViewStateChange instead. See developer guide for examples.

We have fixed a bug when using initialViewState with multiple views. In the past, the state change in one view is unintendedly propagated to all views. As a result of this fix, multiple views (e.g. mini map) are no longer synchronized by default. To synchronize them, define the views with an explicit viewState.id:

new Deck({
  // ...
  views: [
    new MapView({id: 'main'}),
    new MapView({id: 'minimap', controller: false, viewState: {id: 'main', pitch: 0, zoom: 10}})
  ]
})

See View class documentation for details.

Upgrading from deck.gl v7.2 to v7.3

Core

  • layer.setLayerNeedsUpdate is renamed to layer.setNeedsUpdate() and the old name will be removed in the next major release.
  • Previously deprecated Layer class method, screenToDevicePixels, is removed. Use luma.gl utility methods instead.

Layers

  • ScreenGridLayer: support is now limited to browsers that implement either WebGL2 or the OES_texture_float extension. coverage stats
  • Some shader attributes are renamed for consistency:
LayerOldNew
LineLayerinstanceSourceTargetPositions64xyLow.xyinstanceSourcePositions64xyLow
instanceSourceTargetPositions64xyLow.zwinstanceTargetPositions64xyLow
PathLayerinstanceLeftStartPositions64xyLow.xyinstanceLeftPositions64xyLow
instanceLeftStartPositions64xyLow.zwinstanceStartPositions64xyLow
instanceEndRightPositions64xyLow.xyinstanceEndPositions64xyLow
instanceEndRightPositions64xyLow.zwinstanceRightPositions64xyLow
ArcLayerinstancePositions64LowinstancePositions64xyLow
ScenegraphLayerinstancePositions64xyinstancePositions64xyLow
SimpleMeshLayerinstancePositions64xyinstancePositions64xyLow

@deck.gl/json

  • Non-breaking Change: The _JSONConverter class has been renamed to JSONConverter (deprecated alias still available).
  • Non-breaking Change: The _JSONConverter.convertJson() method has been renamed to JSONConverter.convert() (deprecated stub still available).
  • Breaking Change: The _JSONConverter no longer automatically injects deck.gl View classes and enumerations. If reqiured need to import and add these to your JSONConfiguration.
  • Removed: The JSONLayer is no longer included in this module. The code for this layer has been moved to an example in /test/apps/json-layer, and would need to be copied into applications to be used.

Upgrading from deck.gl v7.1 to v7.2

Breaking Changes

Layer methods

Following Layer class methods have been removed :

RemovedAlternateComment
use64bitProjectionuse Fp64Extensiondetails in fp64 prop section below
is64bitEnableduse Fp64Extensiondetails in fp64 prop section below
updateAttributes_updateAttributesmethod is renamed
fp64 prop

The deprecated fp64 prop is removed. The current 32-bit projection is generally precise enough for almost all use cases. If you previously use this feature:

/// old
import {COORDINATE_SYSTEM} from '@deck.gl/core';

new ScatterplotLayer({
  coordinateSystem: COORDINATE_SYSTEM.LNGLAT_DEPRECATED,
  fp64: true,
  ...
})

It can be changed to:

/// new
import {COORDINATE_SYSTEM} from '@deck.gl/core';
import {Fp64Extension} from '@deck.gl/extensions';

new ScatterplotLayer({
  coordinateSystem: COORDINATE_SYSTEM.LNGLAT_DEPRECATED,
  extensions: [new Fp64Extension()],
  ...
})
Color Attributes and Uniforms

All core layer shaders now receive normalized color attributes and uniforms. If you were previously subclassing a core layer with custom vertex shaders, you should expect the color attributes to be in [0, 1] range instead of [0, 255].

project64 Shader Module

The project64 shader module is no longer registered by default. If you were previously using a custom layer that depends on this module:

getShaders() {
  return {vs, fs, modules: ['project64']};
}

It can be changed to:

import {project64} from '@deck.gl/core';

getShaders() {
  return {vs, fs, modules: [project64]};
}

CPU Grid layer and Hexagon layer updateTriggers

getElevationValue, getElevationWeight and getColorValue, getColorWeight are now compared using updateTriggers like other layer accessors. Update them without passing updateTriggers will no longer trigger layer update.

Deprecations

IE support is deprecated and will be removed in the next major release.

Upgrading from deck.gl v7.0 to v7.1

Breaking Changes

  • Fixed a bug where coordinateOrigin's z is not applied in METER_OFFSETS and LNGLAT_OFFSETS coordinate systems.

  • If your application was subclassing GridLayer, you should now subclass CPUGridLayer instead, and either use it directly, or provide it as the sublayer class for GridLayer using _subLayerProps:

    class EnhancedCPUGridLayer extends CPUGridLayer {
    // enhancments
    }
    
    // Code initilizing GridLayer
    const myGridLayer = new GridLayer({
      // props
      ...
      // Override sublayer type for 'CPU'
      _subLayerProps: {
        CPU: {
          type: EnhancedCPUGridLayer
        }
      }
    });

Deprecations

  • getColor props in ColumnLayer and H3HexagonLayer are deprecated. Use getLineColor and getFillColor instead.

Upgrading from deck.gl v6.4 to v7.0

Submodule Structure and Dependency Changes

  • @deck.gl/core is moved from dependencies to devDependencies for all submodules. This will reduce the runtime error caused by installing multiple copies of the core.
  • The master module deck.gl now include all submodules except @deck.gl/test-utils. See list of submodules for details.
  • ContourLayer, GridLayer, HexagonLayer and ScreenGridLayer are moved from @deck.gl/layers to @deck.gl/aggregation-layers. No action is required if you are importing them from deck.gl.
  • @deck.gl/experimental-layers is deprecated. Experimental layers will be exported from their respective modules with a _ prefix.
    • BitmapLayer is moved to @deck.gl/layers.
    • MeshLayer is renamed to SimpleMeshLayer and moved to @deck.gl/mesh-layers.
    • TileLayer and TripsLayer are moved to @deck.gl/geo-layers.

Deck Class

Breaking Changes:

  • onLayerHover and onLayerClick props are replaced with onHover and onClick. The first argument passed to the callback will always be a valid picking info object, and the second argument is the pointer event. This change makes these two events behave consistently with other event callbacks.

Layers

Deprecations:

  • ArcLayer and LineLayer's getStrokeWidth props are deprecated. Use getWidth instead.

Breaking Changes:

  • HexagonCellLayer is removed. Use ColumnLayer with diskResolution: 6 instead.
  • A bug in projecting elevation was fixed in HexagonLayer, GridLayer and GridCellLayer. The resulting heights of extruded grids/hexagons have changed. You may adjust them to match previous behavior by tweaking elevationScale.
  • The following former experimental layers' APIs are redesigned as they graduate to official layers. Refer to their documentations for details:

Lighting

The old experimental prop lightSettings in many 3D layers is no longer supported. The new and improved settings are split into two places: a material prop for each 3D layer and a shared set of lights specified by LightingEffect with the effects prop of Deck. Check Using Lighting in developer guide for more details.

Views

v7.0 includes major bug fixes for OrbitView and OrthographicView. Their APIs are also changed for better clarity and consistency.

Breaking Changes:

  • View state: zoom is now logarithmic in all View classes. zoom: 0 maps one unit in world space to one pixel in screen space.
  • View state: minZoom and maxZoom now default to no limit.
  • View state: offset (pixel-shift of the viewport center) is removed, use target (world position [x, y, z] of the viewport center) instead.
  • Constructor prop: added target to specify the viewport center in world position.
  • OrthographicView's constructor props left, right, top and bottom are removed. Use target to specify viewport center.
  • OrbitView's constructor prop distance and static method getDistance are removed. Use fovy and zoom instead.

project Shader Module

Deprecations:

  • project_scale -> project_size
  • project_to_clipspace -> project_common_position_to_clipspace
  • project_to_clipspace_fp64 -> project_common_position_to_clipspace_fp64
  • project_pixel_to_clipspace -> project_pixel_size_to_clipspace

React

If you are using DeckGL with react-map-gl, @deck.gl/react@^7.0.0 no longer works with react-map-gl v3.x.

Upgrading from deck.gl v6.3 to v6.4

OrthographicView

The experimental OrthographicView class has the following breaking changes:

  • zoom is reversed (larger value means zooming in) and switched to logarithmic scale.
  • Changed view state defaults:
    • zoom - 1 -> 0
    • offset - [0, 1] -> [0, 0]
    • minZoom - 0.1 -> -10
  • eye, lookAt and up are now set in the OrthographicView constructor instead of viewState.

ScatterplotLayer

Deprecations:

  • outline is deprecated: use stroked instead.
  • strokeWidth is deprecated: use getLineWidth instead. Note that while strokeWidth is in pixels, line width is now pecified in meters. The old appearance can be achieved by using lineWidthMinPixels and/or lineWidthMaxPixels.
  • getColor is deprecated: use getFillColor and getLineColor instead.

Breaking changes:

  • outline / stroked no longer turns off fill. Use filled: false instead.

GeoJsonLayer

Breaking changes:

  • stroked, getLineWidth and getLineColor props now apply to point features (rendered with a ScatterplotLayer) in addition to polygon features. To revert to the old appearance, supply a _subLayerProps override:
new GeoJsonLayer({
  // ...other props
  stroked: true,
  _subLayerProps: {
    points: {stroked: false}
  }
});

Upgrading from deck.gl v6.2 to v6.3

GridLayer and HexagonLayer

Shallow changes in getColorValue and getElevationValue props are now ignored by default. To trigger an update, use the updateTriggers prop. This new behavior is aligned with other core layers and improves runtime performance.

Prop Types in Custom Layers

Although the prop types system is largely backward-compatible, it is possible that some custom layers may stop updating when a certain prop changes. This is because the automatically deduced prop type from defaultProps does not match its desired usage. Switch to explicit descriptors will fix the issue, e.g. from:

MyLayer.defaultProps = {
  prop: 0
};

To:

MyLayer.defaultProps = {
  prop: {type: 'number', value: 0, min: 0}
};

Upgrading from deck.gl v6.1 to v6.2

fp64

The default coordinate system COORDINATE_SYSTEM.LNGLAT is upgraded to offer high-precision results in a way that is much faster and more cross-platform compatible. The fp64 layer prop is ignored when using this new coordinate system. You can get the old fp64 mode back by using coordinateSystem: COORDINATE_SYSTEM.LNGLAT_DEPRECATED with fp64: true.

Upgrading from deck.gl v5.3 to v6.0

luma.gl v6.0

deck.gl v6.0 brings in luma.gl v6.0 which is a major release with a few breaking changes. The change that is most likely to affect deck.gl applications is probably that the way the GL constant is imported has changed. For details, see to the luma.gl Upgrade Guide.

Pixel sizes

Pixel sizes in line, icon and text layers now match their HTML/SVG counterparts. To achieve the same rendering output as v5, you should use half the previous value in the following props:

  • ArcLayer.getStrokeWidth
  • LineLayer.getStrokeWidth
  • IconLayer.getSize or IconLayer.sizeScale
  • TextLayer.getSize or TextLayer.sizeScale
  • PointCloudLayer.radiusPixels

Accessors

All layer accessors that support constant values have had their default values changed to constants. For example, ScatterplotLayer's default getRadius prop is changed from d => d.radius || 1 to 1. All dynamic attributes now must be explicitly specified. This change makes sure that using default values results in best performance.

Views and Controllers

  • (React only) Viewport constraint props: maxZoom, minZoom, maxPitch, minPitch are no longer supported by the DeckGL component. They must be specified as part of the viewState object.
  • (React only) ViewportController React component has been removed. The functionality is now built in to the Deck and DeckGL classes.
  • Deck.onViewportChange(viewport) etc callbacks are no longer supported. Use Deck.onViewStateChange({viewState})
  • DeckGL.viewport and DeckGL.viewports props are no longer supported. Use DeckGL.views.

ScreenGridLayer

minColor and maxColor props are deprecated. Use colorRange and colorDomain props.

Shader Modules

Some previously deprecated project_ module GLSL functions have now been removed.

Attribute

isGeneric field of attribute object returned by AttributeManager's update callbacks is replaced by constant. For more details check attribute manager.

Upgrading from deck.gl v5.2 to v5.3

Viewport classes

Continuing the changes that started in 5.2: while the base Viewport class will remain supported, the various Viewport subclasses are now deprecated. For now, if for projection purposes you need to create a Viewport instance matching one of your View instances you can use View.makeViewport:

new MapView().makeViewport({width, height, viewState: {longitude, latitude, zoom}});

Layer properties

LayerRemoved PropNew PropComment
ArcLayerstrokeWidthgetStrokeWidthCan be set to constant value
LineLayerstrokeWidthgetStrokeWidthCan be set to constant value

Pure JS applications

Core layers are broken out from @deck.gl/core to a new submodule @deck.gl/layers. Non-React users of deck.gl should now install both submodules:

npm install @deck.gl/core @deck.gl/layers

And import layers from the new submodule instead of core:

import {ScatterplotLayer} from '@deck.gl/layers';

Users of deck.gl are not affected by this change.

Upgrading from deck.gl v5.1 to v5.2

DeckGL component

  • DeckGL.viewports and DeckGL.viewport are deprecated and should be replaced with DeckGL.views.

Viewport classes

  • A number of Viewport subclasses have been deprecated. They should be replaced with their View counterparts.

Experimental Features

Some experimental exports have been removed:

  • The experimental React controller components (MapController and OrbitController) have been removed. These are now replaced with JavaScript classes that can be used with the Deck.controller / DeckGL.controller property.

Upgrading from deck.gl v5 to v5.1

N/A

Upgrading from deck.gl v4.1 to v5

Dependencies

deck.gl 4.1 requires luma.gl as peer dependency, but 5.0 specifies it as a normal "dependency". This means that many applications no longer need to list luma.gl in their package.json. Applications that do might get multiple copies of luma.gl installed, which will not work. luma.gl will detect this situation during run-time throwing an exception, but npm and yarn will not detect it during install time. Thus your build can look successful during upgrade but fail during runtime.

Layer Props

Coordinate system related props have been renamed for clarity. The old props are no longer supported and will generate errors when used.

LayerRemoved PropNew PropComment
LayerprojectionModecoordinateSystemAny constant from COORDINATE_SYSTEM
LayerprojectionOrigincoordinateOrigin[lng, lat]

Note; There is also an important semantical change in that using coordinateSystem instead of projectionMode causes the superimposed METER_OFFSET system's y-axis to point north instead of south. This was always the intention so in some sense this was regarded as a bug fix.

DeckGL component

Following methods and props have been renamed for clarity. The semantics are unchanged. The old props are still available but will generate a deprecation warning.

Old MethodNew MethodComment
queryObjectpickObjectThese names were previously aligned with react-map-gl, but ended up confusing users. Since rest of the deck.gl documentation talks extensively about "picking" it made sense to stay with that terminology.
queryVisibleObjectspickObjectsThe word "visible" was intended to remind the user that this function only selects the objects that are actually visible in at least one pixel, but again it confused more than it helped.

Removed picking Uniforms

Removed uniformComment
renderPickingBufferpicking shader module
pickingEnabledpicking shader module
selectedPickingColorpicking shader module

The shader uniforms are used for implementing picking in custom shaders, these uniforms are no longer set by the deck.gl. Custom shaders can now use luma.gl picking shader module.

Initial WebGL State

Following WebGL parameters are set during DeckGL component initialization.

WebGL StateValue
depthTesttrue
depthFuncgl.LEQUAL
blendFuncSeparate[gl.SRC_ALPHA, gl.ONE_MINUS_SRC_ALPHA, gl.ONE, gl.ONE_MINUS_SRC_ALPHA]

All our layers enable depth test so we are going set this state during initialization. We are also changing blend function for more appropriate rendering when multiple elements are blended.

For any custom needs, these parameters can be overwritten by updating them in onWebGLInitialized callback or by passing them in parameters object to drawLayer method of Layer class.

assembleShaders

The assembleShaders function was moved to luma.gl in v4.1 and is no longer re-exported from deck.gl. As described in v4.1 upgrade guide please use Model class instead or import it from luma.gl.

Removed Immutable support

ScatterplotLayer and PolygonLayer supported immutable/ES6 containers using get method, due to performance reasons this support has been dropped.

Upgrading from deck.gl v4 to v4.1

deck.gl v4.1 is a backward-compatible release. Most of the functionality and APIs remain unchanged but there are smaller changes that might requires developers' attention if they develop custom layers. Note that applications that are only using the provided layers should not need to make any changes issues.

Dependencies

Be aware that deck.gl 4.1 bumps the luma.gl peer dependency from 3.0 to 4.0. There have been instances where this was not detected by the installer during update.

Layer Life Cycle Optimization

  • shouldUpdateState - deck.gl v4.1 contains additional optimizations of the layer lifecycle and layer diffing algorithms. Most of these changes are completely under the hood but one visible change is that the default implementation of Layer.shouldUpdate no longer returns true if only the viewport has changed. This means that layers that need to update state in response to changes in screen space (viewport) will need to redefine shouldUpdate:
  shouldUpdateState({changeFlags}) {
    return changeFlags.somethingChanged; // default is now changeFlags.propsOrDataChanged;
  }

Note that this change has already been done in all the provided deck.gl layers that are screen space based, including the ScreenGridLayer and the HexagonLayer.

luma.gl Model class API change

  • deck.gl v4.1 bumps luma.gl to from v3 to v4. This is major release that brings full WebGL2 enablement to deck.gl. This should not affect you if you are mainly using the provided deck.gl layers but if you are writing your own layers using luma.gl classes you may want to look at the upgrade guide of luma.gl.

The gl parameter is provided as a separate argument in luma.gl v4, instead of part of the options object.

// luma.gl v4
new Model(gl, {opts});
// luma.gl v3
new Model({gl, ...opts});

Shader Assembly

Custom layers are no longer expected to call assembleShaders directly. Instead, the new Model class from luma.gl v4 will take shaders and the modules they are using as parameters and assemble shaders automatically.

// luma.gl v4
const model = new Model(gl, {
  vs: VERTEX_SHADER,
  fs: FRAGMENT_SHADER,
  modules: ['fp64', ...],
  shaderCache: this.context.shaderCache
  ...
}));

// luma.gl v3
const shaders = assembleShaders(gl, {
  vs: VERTEX_SHADER,
  fs: FRAGMENT_SHADER,
  modules: ['fp64', 'project64'],
  shaderCache: this.context.shaderCache
});
const model = new Model({
  gl,
  vs: shaders.vs,
  fs: shaders.fs,
  ...
});

Removed Layers

LayerStatusReplacement
ChoroplethLayerRemovedGeoJsonLayer, PolygonLayer and PathLayer
ChoroplethLayer64RemovedGeoJsonLayer, PolygonLayer and PathLayer
ExtrudedChoroplethLayerRemovedGeoJsonLayer, PolygonLayer and PathLayer
  • ChoroplethLayer, ChoroplethLayer64, ExtrudedChoroplethLayer

These set of layers were deprecated in deck.gl v4, and are now removed in v5. You can still get same functionality using more unified, flexible and performant layers: GeoJsonLayer, PolygonLayer and PathLayer.

Upgrading from deck.gl v3 to v4

Changed Import: The DeckGL React component

A small but breaking change that will affect all applications is that the 'deck.gl/react' import is no longer available. As of v4.0, the app is required to import deck.gl as follows:

// V4
import DeckGL from 'deck.gl';
// V3
import DeckGL from 'deck.gl/react';

While it would have been preferable to avoid this change, a significant modernization of the deck.gl build process and preparations for "tree-shaking" support combined to make it impractical to keep supporting the old import style.

Deprecated/Removed Layers

LayerStatusReplacement
ChoroplethLayerDeprecatedGeoJsonLayer, PolygonLayer and PathLayer
ChoroplethLayer64DeprecatedGeoJsonLayer, PolygonLayer and PathLayer
ExtrudedChoroplethLayerDeprecatedGeoJsonLayer, PolygonLayer and PathLayer
EnhancedChoroplethLayerMoved to examplesPathLayer
  • ChoroplethLayer, ChoroplethLayer64, ExtrudedChoroplethLayer

These set of layers are deprecated in deck.gl v4, with their functionality completely substituted by more unified, flexible and performant new layers: GeoJsonLayer, PolygonLayer and PathLayer.

Developers should be able to just supply the same geojson data that are used with ChoroplethLayers to the new GeoJsonLayer. The props of the GeoJsonLayer are a bit different from the old ChoroplethLayer, so proper testing is recommended to achieve satisfactory result.

  • EnhancedChoroplethLayer

This was a a sample layer in deck.gl v3 and has now been moved to a stand-alone example and is no longer exported from the deck.gl npm module.

Developers can either copy this layer from the example folder into their application's source tree, or consider using the new PathLayer which also handles wide lines albeit in a slightly different way.

Removed, Changed and Deprecated Layer Properties

LayerOld PropNew PropComment
LayerdataIteratorN/AProp was not functional in v3
ScatterplotLayerradiusradiusScaleDefault has changed from 30 to 1
ScatterplotLayerdrawOutlineoutline
ScreenGridLayerunitWidthcellSizePixels
ScreenGridLayerunitHeightcellSizePixels

Note about strokeWidth props

All line based layers (LineLayer and ArcLayerand theScatterplotLayerin outline mode) now use use shaders to render an exact pixel thickness on lines, instead of using theGL.LINE` drawing mode.

This particular change was caused by browsers dropping support for this feature (Chrome and Firefox).

Also GL.LINE mode rendering always had signficant limitations in terms of lack of support for mitering, unreliable support for anti-aliasing and platform dependent line width limits so this should represent an improvement in visual quality and consistency for these layers.

Removed prop: Layer.dataIterator

This prop has been removed in deck.gl v4. Note that it was not functioning as documented in deck.gl v3.

Renamed Props: The ...Scale suffix

Props that have their name end of Scale is a set of props that multiply some existing value for all objects in the layers. These props usually correspond to WebGL shader uniforms that "scaling" all values of specific attributes simultaneously.

For API consistency reasons these have all been renamed with the suffix ..Scale. See the property table above.

Removed lifecycle method: Layer.willReceiveProps

This lifecycle was deprecated in v3 and is now removed in v4. Use Layer.updateState instead.

Changes to updateTriggers

Update triggers can now be specified by referring to the name of the accessor, instead of the name of the actual WebGL attribute.

Note that this is supported on all layers supplied by deck.gl v4, but if you are using older layers, they need a small addition to their attribute definitions to specify the name of the accessor.

AttributeManager changes

Removed method: AttributeManager.setLogFunctions

Use the new static function AttributeManager.setDefaultLogFunctions to set loggers for all AttributeManagers (i.e. for all layers).

Removed method: AttributeManager.addDynamic

This method has been deprecated since version 2.5 and is now removed in v4. Use AttributeManager.add() instead.