README.md

deck.gl | Docs

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

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

Installation

npm install --save deck.gl

Note: deck.gl has a dependency on node version 0.12 or higher. If you use an older version, you can install a node version manager like nvm and use a separate shell to install and build deck.gl

npm install -g nvm && nvm install 0.12 && nvm use 0.12

Example

import DeckGL from 'deck.gl/react';
import {ArcLayer} from 'deck.gl';

const flights = new ArcLayer({
  id: 'flights',
  data: [] // Some flight points
});

<DeckGL width={1920} height={1080} layers={[flights]} />

Take a look at the docs website or browse the docs folder.

Developing

npm install
npm test
npm start

Node Version Requirement

Building deck.gl from source has a dependency on node version 0.12 or higher. If you use an older version, you can install a node version manager like nvm and use a separate shell to install and build deck.gl.

npm install -g nvm && nvm install 0.12 && nvm use 0.122

This is not an issue when installing deck.gl, only when building it from source.

Contributing

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

Data sources

SF OpenData TLC Trip Record Data Mapzen