Skip to content

Commit db315df

Browse files
ibgreenShaojing Li
authored andcommitted
Bump react-map-gl. Remove unused dependencies. Remove yarn in start command. Update README (visgl#389)
1 parent e9ec48e commit db315df

31 files changed

Lines changed: 144 additions & 109 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
All notable changes to deck.gl will be documented in this file.
44

5-
Official releases are documented first. Beta releases are listed
6-
towards the end of this document.
7-
85
<!--
96
Each version should:
107
List its release date in the above format.
@@ -20,6 +17,10 @@ Ref: http://keepachangelog.com/en/0.3.0/
2017

2118
## Recent Dev Releases
2219

20+
#### [TBD]
21+
- Dependencies: Bump to react-map-gl@2, remove viewport-mercator-project & lodash.flatten
22+
- ...
23+
2324
#### [v4.0.0-beta.3]
2425
- Add PointCloudLayer
2526
- FIX: `onHover` and `onClick` are no longer called on layers that are not affected
@@ -423,7 +424,7 @@ For details see [What's New](docs/whats-new.md)
423424
- BREAKING: No longer use Camera/Scene to render. Enabler for issue #5.
424425
- BREAKING: Sample layers now available through `import 'deck.gl/samples';
425426
- FEATURE: FP64 layers now exported by default import 'deck.gl'
426-
- BREAKING: DeckGLOverlay renamed to DeckGL: `import DeckGL from 'deck.gl/react';`
427+
- BREAKING: DeckGLOverlay renamed to DeckGL: `import DeckGL from 'deck.gl';`
427428
- FIX: GridLayer
428429
- FEATURE: ChoroplethLayer now renders MultiPolygons and Polygons with holes
429430

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ use cases, such as scatterplots, choropleths etc in 2 and 3 dimensions.
2727
## Example
2828

2929
```javascript
30-
import DeckGL from 'deck.gl/react';
30+
import DeckGL from 'deck.gl';
3131
import {ArcLayer} from 'deck.gl';
3232

3333
const flights = new ArcLayer({
@@ -49,16 +49,24 @@ or browse directly the [docs folder](./docs).
4949

5050
npm install
5151
npm test
52-
npm start
52+
npm start # See note below
53+
54+
Note that you will also need to do an npm install in the main example (`examples/layer-browser`)
55+
since the npm start command tries to build and run that example.
56+
57+
cd examples/layer-browser
58+
npm install
59+
cd ../..
5360

5461
#### Node Version Requirement
5562

5663
Building deck.gl from source has a dependency on node `4.0` or higher.
57-
Either upgrade to a newest version, or install something like [nvm](https://github.com/creationix/nvm).
64+
Either upgrade to a newest version, or install something like
65+
[nvm](https://github.com/creationix/nvm).
5866

5967
#### Install yarn
60-
On macOS deck.gl uses [yarn] (https://www.npmjs.com/package/yarn) to manage packages.
61-
To develop deck.gl, [install yarn] (https://yarnpkg.com/en/docs/install) with brew
68+
On macOS deck.gl uses [yarn](https://www.npmjs.com/package/yarn) to manage packages.
69+
To develop deck.gl, [install yarn](https://yarnpkg.com/en/docs/install) with brew
6270
```
6371
brew update
6472
brew install yarn

demo/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"marked": "^0.3.6",
2626
"react": "^15.4.0",
2727
"react-dom": "^15.4.0",
28-
"react-map-gl": "^1.7.2",
28+
"react-map-gl": "^2.0.0",
2929
"react-redux": "^4.4.5",
3030
"react-router": "^2.8.1",
3131
"redux": "^3.6.0",

demo/src/components/demos/arc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React, {Component} from 'react';
22
import {scaleQuantile} from 'd3-scale';
33

44
import {ChoroplethLayer, ArcLayer} from 'deck.gl';
5-
import DeckGL from 'deck.gl/react';
5+
import DeckGL from 'deck.gl';
66

77
import {readableInteger} from '../../utils/format-utils';
88
import {MAPBOX_STYLES} from '../../constants/defaults';

demo/src/components/demos/choropleth.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React, {Component} from 'react';
22

33
import {ChoroplethLayer64} from 'deck.gl';
4-
import DeckGL from 'deck.gl/react';
4+
import DeckGL from 'deck.gl';
55

66
import {readableInteger} from '../../utils/format-utils';
77
import {MAPBOX_STYLES} from '../../constants/defaults';

demo/src/components/demos/grid.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React, {Component} from 'react';
22

33
import {ScreenGridLayer} from 'deck.gl';
4-
import DeckGL from 'deck.gl/react';
4+
import DeckGL from 'deck.gl';
55

66
import {readableInteger} from '../../utils/format-utils';
77
import {MAPBOX_STYLES} from '../../constants/defaults';

demo/src/components/demos/scatterplot.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React, {Component} from 'react';
22

33
import {ScatterplotLayer} from 'deck.gl';
4-
import DeckGL from 'deck.gl/react';
4+
import DeckGL from 'deck.gl';
55

66
import {MAPBOX_STYLES} from '../../constants/defaults';
77
import {readableInteger} from '../../utils/format-utils';

demo/src/components/demos/trips.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React, {Component} from 'react';
22

33
import {ExtrudedChoroplethLayer64} from 'deck.gl';
4-
import DeckGL from 'deck.gl/react';
4+
import DeckGL from 'deck.gl';
55

66
import {MAPBOX_STYLES} from '../../constants/defaults';
77
import {readableInteger} from '../../utils/format-utils';

docs/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,6 @@ deck.gl has been developed in parallel with a number of companion modules:
3434
or other WebGL libraries.
3535
* [react-map-gl](https://uber.github.io/react-map-gl/#/) - A React wrapper
3636
around Mapbox GL which works seamlessly with deck.gl.
37-
* [viewport-mercator-project](https://github.com/uber-common/viewport-mercator-project) -
38-
Perspective enabled Web Mercator projection and transformation class. Created
39-
for deck.gl, but broken out since it is independently useful and can for instance be used with `react-map-gl` to create perspective enabled SVG overlays (which could be used together with deck.gl).
4037

4138
In addition, in the future we hope to publish additional deck.gl layers and
4239
layer packages as separate modules.

docs/coordinate-systems.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,6 @@ Remarks:
2727
and shared by all layers, so they will always pan zoom and tilt
2828
together, regardless of what coordinate system their positions
2929
are specified in.
30-
* Most of deck.gl's coordinate system handling has been broken out into the
31-
[viewport-mercator-project](https://github.com/uber-common/viewport-mercator-project)
32-
module. See the README file there for more information and documentation
33-
of the `Viewport` class.
34-
3530

3631
### Non-cartographic Projection Mode
3732

0 commit comments

Comments
 (0)