deck-renderer.md

DeckRenderer

This class is an experimental implementation of the ArcGIS ExternalRenderer interface and can be added to 3D views of maps created with the ArcGIS API for JavaScript.

Usage

import {DeckRenderer} from '@deck.gl/arcgis';
import {ScatterplotLayer} from '@deck.gl/layers';
import ArcGISMap from '@arcgis/core/Map';
import SceneView from '@arcgis/core/views/SceneView';
import * as externalRenderers from '@arcgis/core/views/3d/externalRenderers';

const sceneView = new SceneView({
  container: 'viewDiv',
  map: new ArcGISMap({
    basemap: 'dark-gray-vector'
  }),
  camera: {
    position: {x: -74, y: 40.65, z: 5000},
    heading: 180,
    tilt: 30
  },
  viewingMode: 'local'
});

const renderer = new DeckRenderer(sceneView, {
  layers: [
    new ScatterplotLayer({
      data: [
        {position: [0.119, 52.205]}
      ],
      getPosition: d => d.position,
      getColor: [255, 0, 0],
      radiusMinPixels: 20
    })
  ]
});

externalRenderers.add(sceneView, renderer);

Constructor

new DeckRenderer(sceneView, props)

• sceneView (SceneView) - the view to use this renderer with. viewingMode must be set to 'local'.

• props (object) - forwarded to a Deck instance. The following Deck props are supported:

• layers

• layerFilter

• parameters

• effects

• pickingRadius

• onBeforeRender

• onAfterRender

• onClick

• onHover

• onDragStart

• onDrag

• onDragEnd

• onError

• debug

• drawPickingColors

• getCursor

• getTooltip

Members

deck {#deck}

An ArcGIS Accessor that stores Deck props. The props can be updated after the layer construction:

// Update deck layers
layer.deck.layers = [...]);

// Update multiple deck props
layer.deck.set({
  layers: [...],
  pickingRadius: 5,
  ...
});