Skip to main content

DeckLayer

A DeckLayer is a leaflet layer that renders deck.gl layers on top of a leaflet base map. DeckLayer is an implementation of L.Layer and can be interleaved with other Leaflet layers.

const deckLayer = new DeckLayer({
  views: [
    new MapView({ repeat: true }),
  ],
  layers: [...],
});
map.addLayer(deckLayer);

The constructor accepts a props object that is passed to the Deck constructor. See the limitations section below for more details.

The following Deck methods can be called directly from a DeckLayer instance:

  • deckLayer.setProps
  • deckLayer.pickObject
  • deckLayer.pickMultipleObjects
  • deckLayer.pickObjects

Supported Features and Limitations​

Supported deck.gl features:

  • Layers
  • Effects
  • Auto-highlighting
  • Attribute transitions
  • onHover and onClick callbacks
  • Tooltip

Not supported features:

  • Tilting
  • Multiple views
  • Controller
  • React integration
  • Gesture event callbacks (e.g. onDrag*)