Welcome to pydeck’s documentation!

If you have not already, follow the installation instructions

Layers

Configure one of the many deck.gl layers for rendering in pydeck

Deck

Used to write data out to a widget in Jupyter, save it out to HTML, and configure some global parameters of a visualization, like its size or tooltip.

Data utilities

A handful of functions to make certain common data exercises easier, like automatically fitting to data on a map or coloring categorical data.

ViewState

Used to set the precise location of a user’s vantage point on the data, like a user’s zoom level.

View

Used to enable/disable map controls and also modify the kind of map projection, like plotting in flat plane instead of plotting on a mercator projection.

LightSettings (Experimental)

Configure the lighting within a visualization.

Caveats

  • Please note that pydeck assumes Internet access. You will need an Internet connection or the visualization will not render.

  • Currently, in its beta version pydeck will NOT raise an error on incorrect or omitted layer arguments.
    If nothing renders in your viewport, check your browser’s developer console
    or review the layer catalog. If you’re still stuck, file an issue by clicking here.

Indices and tables