Skip to content

Commit c681ee7

Browse files
committed
(docs) Update references to RenderNode
1 parent 8fec6cb commit c681ee7

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

docs/api-reference/arcgis/deck-renderer.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ const renderer = new DeckRenderer(sceneView, {
3838
]
3939
});
4040

41-
sceneView.map.add(renderer);
41+
// DeckRenderer is a SceneView RenderNode. Constructing it attaches it to the
42+
// view; it should not be added to the map as a layer.
43+
renderer;
4244
```
4345

4446

@@ -48,7 +50,7 @@ sceneView.map.add(renderer);
4850
new DeckRenderer(sceneView, props)
4951
```
5052

51-
- `sceneView` ([SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)) - the view to use this renderer with. `viewingMode` must be set to `'local'`.
53+
- `sceneView` ([SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)) - the view to use this renderer with. `viewingMode` must be set to `'local'`. `DeckRenderer` manages its internal deck.gl view state from the live `SceneView` camera and self-registers as a RenderNode; do not add it to `map.layers`.
5254
- `props` (object) - forwarded to a `Deck` instance. The following [Deck](../core/deck.md) props are supported:
5355

5456
- `layers`

docs/api-reference/arcgis/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ that acts as an interface between deck.gl and ArcGIS.
88

99
2D integration with `MapView` is supported by the [DeckLayer](./deck-layer.md) class.
1010

11-
3D integration with `SceneView` is experimental: see the [DeckRenderer](./deck-renderer.md) class.
11+
3D integration with `SceneView` is experimental and currently targets `viewingMode: 'local'`: see the [DeckRenderer](./deck-renderer.md) class.
1212

1313
## Installation
1414

docs/developer-guide/base-maps/using-with-arcgis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Starting with v8.1, deck.gl has support for ArcGIS with the [@deck.gl/arcgis](..
1010

1111
2D integration with `MapView` is supported by the [DeckLayer](../../api-reference/arcgis/deck-layer.md) class, see [pure JS example](https://github.com/visgl/deck.gl/tree/master/examples/get-started/pure-js/arcgis).
1212

13-
3D integration with `SceneView` is experimental: see the [DeckRenderer](../../api-reference/arcgis/deck-renderer.md) class.
13+
3D integration with `SceneView` is experimental and currently targets `viewingMode: 'local'`; `DeckRenderer` attaches as a RenderNode rather than a map layer. See the [DeckRenderer](../../api-reference/arcgis/deck-renderer.md) class.

0 commit comments

Comments
 (0)