API Reference Manual#

To learn how to use GeoViews, we recommend starting with the User guide, and then utilizing the online help features within IPython or Jupyter Notebook to explore further. Each component should support tab-completion and provide inline help, which is typically sufficient to understand how to use GeoViews effectively.

For a comprehensive reference to every object in GeoViews, this API documentation is generated directly from the source code’s documentation and declarations. While it may be verbose due to the inclusion of many inherited or less commonly used methods, it offers a complete listing of all attributes and methods for each class, which can be challenging to extract directly from the source code.


Module Structure#

GeoViews subpackages#

annotators

Helper functions and classes to annotate visual elements.

data

Data interface classes enabling GeoViews to work with various data types.

element

Core elements that form the basis of geographic visualizations.

links

Tools for linking different elements and streams.

models

Custom models extending GeoViews’ capabilities.

operation

Operations applied to transform existing elements or data structures.

plotting

Base plotting classes and utilities.

plotting.bokeh

Bokeh-specific plotting classes and utilities.

plotting.matplotlib

Matplotlib-specific plotting classes and utilities.

streams

Stream classes providing interactivity for dynamic maps.

util

High-level utilities supporting GeoViews functionality.