Skip to content

Commit

Permalink
address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Xiaoji Chen committed Mar 9, 2020
1 parent 169683c commit 8cc8b05
Show file tree
Hide file tree
Showing 16 changed files with 247 additions and 272 deletions.
@@ -1,8 +1,8 @@
# ArcGISDeckLayer
# DeckLayer

This class inherits from the ArcGIS [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) class and can be added to maps created with the ArcGIS API for JavaScript.

`ArcGISDeckLayer` is only available when `loadArcGISModules()` is resolved. At the moment, it only supports 2D integration.
`DeckLayer` is only available when `loadArcGISModules()` is resolved. At the moment, it only supports 2D integration.

## Usage

Expand All @@ -12,10 +12,10 @@ import {loadArcGISModules} from '@deck.gl/arcgis';
loadArcGISModules([
'esri/Map',
'esri/views/MapView'
]).then(({ArcGISDeckLayer, modules}) => {
]).then(({DeckLayer, modules}) => {
const [ArcGISMap, MapView] = modules;

const layer = new ArcGISDeckLayer({
const layer = new DeckLayer({
'deck.layers': [
// deck.gl layers
]
Expand All @@ -37,7 +37,7 @@ loadArcGISModules([
## Constructor

```js
new ArcGISDeckLayer(props);
new DeckLayer(props);
```

Inherits all properties from the base [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#properties-summary) class.
Expand Down
@@ -1,8 +1,8 @@
# ArcGISDeckExternalRenderer
# DeckRenderer

This class inherits implements the ArcGIS [ExternalRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-externalRenderers.html#ExternalRenderer) interface and can be added to maps created with the ArcGIS API for JavaScript.

`ArcGISDeckExternalRenderer` is only available when `loadArcGISModules()` is resolved.
`DeckRenderer` is only available when `loadArcGISModules()` is resolved.

## Usage

Expand All @@ -13,7 +13,7 @@ import {GeoJsonLayer} from '@deck.gl/layers';
loadArcGISModules([
'esri/views/SceneView',
'esri/views/3d/externalRenderers'
]).then(({ArcGISDeckExternalRenderer, modules}) => {
]).then(({DeckRenderer, modules}) => {
const [SceneView, externalRenderers] = modules;

const sceneView = new SceneView({
Expand All @@ -29,21 +29,21 @@ loadArcGISModules([
viewingMode: 'local'
});

const extren = new ArcGISDeckExternalRenderer(sceneView, {
const renderer = new DeckRenderer(sceneView, {
layers: [
// deck.gl layers
]
});

externalRenderers.add(sceneView, extren);
externalRenderers.add(sceneView, renderer);
});
```


## Constructor

```js
new ArcGISDeckExternalRenderer(sceneView, props)
new DeckRenderer(sceneView, props)
```

- `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'`.
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/arcgis/load-arcgis-modules.md
Expand Up @@ -8,7 +8,7 @@ This utility function initializes the classes in this module by loading ArcGIS d
import {loadArcGISModules} from '@deck.gl/arcgis';

loadArcGISModules(['esri/Map', 'esri/views/MapView'], {version: '4.14'})
.then(({ArcGISDeckLayer, ArcGISDeckExternalRenderer, modules}) => {
.then(({DeckLayer, DeckRenderer, modules}) => {
const [ArcGISMap, MapView] = modules;

// Create map
Expand All @@ -26,6 +26,6 @@ loadArcGISModules(modules, loadScriptOptions);

Returns: a promise that resolves to an object with the following fields:

- [ArcGISDeckLayer](/docs/api-reference/arcgis/arcgis-deck-layer.md)
- [ArcGISDeckExternalRenderer](/docs/api-reference/arcgis-deck-external-renderer.md)
- [DeckLayer](/docs/api-reference/arcgis/deck-layer.md)
- [DeckRenderer](/docs/api-reference/deck-renderer.md)
- `modules` (Array) - if the `modules` argument was specified, will represent an array of the resolved objects
8 changes: 4 additions & 4 deletions docs/api-reference/arcgis/overview.md
Expand Up @@ -6,9 +6,9 @@ The functionality exported by this module must be loaded asynchronously using th
This function can be used to load any module that ships with the ArcGIS API for JavaScript, plus an additional `arcGIS` module
that acts as an interface between deck.gl and ArcGIS.

2D integration with `MapView` is supported by the [ArcGISDeckLayer](/docs/api-reference/arcgis-deck-layer.md) class.
2D integration with `MapView` is supported by the [DeckLayer](/docs/api-reference/deck-layer.md) class.

3D integration with `SceneView` is supported by the [ArcGISDeckExternalRenderer](/docs/api-reference/arcgis-deck-external-renderer.md) class.
3D integration with `SceneView` is supported by the [DeckRenderer](/docs/api-reference/deck-renderer.md) class.

## Installation

Expand Down Expand Up @@ -39,10 +39,10 @@ import {loadArcGISModules} from '@deck.gl/arcgis';
loadArcGISModules([
'esri/Map',
'esri/views/MapView'
]).then(({ArcGISDeckLayer, modules}) => {
]).then(({DeckLayer, modules}) => {
const [ArcGISMap, MapView] = modules;

const layer = new ArcGISDeckLayer({
const layer = new DeckLayer({
'deck.layers': [
new ScatterplotLayer({
data: [
Expand Down
4 changes: 2 additions & 2 deletions examples/get-started/pure-js/arcgis/app.js
Expand Up @@ -5,9 +5,9 @@ import {GeoJsonLayer, ArcLayer} from '@deck.gl/layers';
const AIR_PORTS =
'https://d2ad6b4ur7yvpq.cloudfront.net/naturalearth-3.3.0/ne_10m_airports.geojson';

loadArcGISModules(['esri/Map', 'esri/views/MapView']).then(({ArcGISDeckLayer, modules}) => {
loadArcGISModules(['esri/Map', 'esri/views/MapView']).then(({DeckLayer, modules}) => {
const [ArcGISMap, MapView] = modules;
const layer = new ArcGISDeckLayer({
const layer = new DeckLayer({
'deck.layers': [
new GeoJsonLayer({
id: 'airports',
Expand Down
78 changes: 0 additions & 78 deletions modules/arcgis/src/arcgis-deck-external-renderer.js

This file was deleted.

100 changes: 0 additions & 100 deletions modules/arcgis/src/arcgis-deck-layer-view-2d.js

This file was deleted.

39 changes: 0 additions & 39 deletions modules/arcgis/src/arcgis-deck-layer.js

This file was deleted.

0 comments on commit 8cc8b05

Please sign in to comment.