node package manager

deck.gl

version build downloads stars Coverage Status

deck.gl | Docs

A WebGL overlay suite for React providing a set of highly performant data visualization overlays

docs

Provides tested, highly performant layers for data visualization use cases, such as scatterplots, choropleths etc in 2 and 3 dimensions.

npm install --save deck.gl

Example

import DeckGL from 'deck.gl';
import {ArcLayer} from 'deck.gl';
 
const flights = new ArcLayer({
  id: 'flights',
  data: [] // Some flight points
});
 
<DeckGL width={1920} height={1080} layers={[flights]} />

A very simple usage of deck.gl is showcased in the hello-world examples, using both webpack2 and browserify, so you can choose which setup you prefer or are more familiar with.

You can also take a look at the docs website or browse directly the docs folder.

Developing

npm install # or yarn
npm test
npm start  # See note below

Note that you will also need to do an npm install in the main example (examples/layer-browser) since the npm start command tries to build and run that example.

cd examples/layer-browser
npm install
cd ../..

Note that npm start in the main directory actually runs examples/main. You will need to install dependencies in that example first:

cd examples/main
npm install # or yarn
cd ../..
npm start

Node Version Requirement

Running deck.gl as a dependency in another project (e.g. via npm i deck.gl) requires Node v4 or higher. Building deck.gl from source has a dependency on Node v6.4 or higher. Either upgrade to a supported version, or install something like nvm to manage Node versions.

Install yarn

On macOS deck.gl uses yarn to manage packages. To develop deck.gl, install yarn with brew

brew update
brew install yarn

Contributing

PRs and bug reports are welcome. Note that you once your PR is about to be merged, you will be asked to register as a contributor by filling in a short form.

Data sources

SF OpenData

TLC Trip Record Data

Mapzen