README.md

deck.gl | Docs

A suite of WebGL2-powered data visualization layers

Provides tested, highly performant layers for data visualization, such as scatterplots, arcs, geometries defined in GeoJSON, etc.

deck.gl has extensive documentation, please refer to the docs website or browse it directly in the github docs folder.

Using deck.gl

deck.gl can be used through its standard JavaScript API (available both as installable npm modules as well as a "script" file for use in scripting setups). However, if you are using React you will likely want to use the provided React integration. Again, consult the extensive documentation for more details on how to access what you need.

Examples

To get a quick feel for deck.gl applicaiton source code might look like, say the application has some data representing flights with start and end positions for each item. If it wanted to display this data as a set of arcs it would simply import and render a deck.gl ArcLayer:

import DeckGL, {ArcLayer} from 'deck.gl';

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

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

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

To learn how to use deck.gl through the many examples that coming with the deck.gl repo, please clone the latest release branch. git clone -b 5.3-release --single-branch https://github.com/uber/deck.gl.git

For the most up-to-date information, see our docs

Contributing

PRs and bug reports are welcome, and we are actively opening up the deck.gl roadmap to facilitate for external contributors.

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

Data sources are listed in each example.