Skip to main content

DeckOverlay

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

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

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 DeckOverlay instance:

  • deckOverlay.setProps
  • deckOverlay.pickObject
  • deckOverlay.pickMultipleObjects
  • deckOverlay.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*)