API Reference

class ipyopenlayers.openlayers.BaseControl(*args: t.Any, **kwargs: t.Any)

BaseControl abstract class.

This is the base class for all ipyopenlayers controls. A control is additional UI components on top of the Map.

class ipyopenlayers.openlayers.BaseOverlay(*args: t.Any, **kwargs: t.Any)

Base class for overlays on the map.

position

The position of the overlay on the map (it’s center).

Type:

list of float, default [0, 0]

class ipyopenlayers.openlayers.FullScreen(*args: t.Any, **kwargs: t.Any)

FullScreen class, with Control as parent class.

A control which contains a button that will put the Map in full-screen when clicked.

class ipyopenlayers.openlayers.GeoJSON(*args: t.Any, **kwargs: t.Any)

GeoJSON class for GeoJSON data layers.

data

The GeoJSON data for the layer.

Type:

dict

style

Style options for the GeoJSON data.

Type:

dict

visible

Whether the layer is visible or not.

Type:

bool, default True

class ipyopenlayers.openlayers.GeoTIFFTileLayer(*args: t.Any, **kwargs: t.Any)

GeoTIFFTileLayer class for WebGL-based GeoTIFF raster tiles.

url

The URL for the WebGL-based GeoTIFF tiles.

Type:

str, default “”

class ipyopenlayers.openlayers.GeoZarrTileLayer(*args: t.Any, **kwargs: t.Any)

GeoZarrTileLayer class for WebGL-based GeoZarr raster tiles.

url

The URL for the WebGL-based GeoZarr tiles.

Type:

str, default “”

bands

List of band indices to display from the GeoZarr dataset.

Type:

list of int, default []

class ipyopenlayers.openlayers.HeatmapLayer(*args: t.Any, **kwargs: t.Any)

HeatmapLayer class for heatmap visualization.

points

A list of data points to be displayed on the heatmap, The weight determines the intensity of the heatmap at that point.

Type:

list of lists [latitude, longitude, weight]

blur

Specifies the blur radius for the heatmap The blur controls the smoothness of the heatmap, with higher values creating more diffuse effects

Type:

int, default 15

radius

The radius of each point in the heatmap, affects how large each data point appears on the map

Type:

int, default 8

class ipyopenlayers.openlayers.ImageOverlay(*args: t.Any, **kwargs: t.Any)

ImageOverlay class.

Image layer from a local or remote image file.

image_url

Url to the local or remote image file.

Type:

string, default “”

position

center of the image.

Type:

list, default [0., 0]

class ipyopenlayers.openlayers.Layer(*args: t.Any, **kwargs: t.Any)

Base class for all layers on the map.

class ipyopenlayers.openlayers.Map(*args: t.Any, **kwargs: t.Any)

Map class.

The Map class is the main widget in ipyopenlayers.

layers

The list of layers that are currently on the map.

Type:

list of Layer instances

controls

The list of controls that are currently on the map.

Type:

list of Control instances

overlays

The list of Overlays that are currently on the map.

Type:

list of Overlay instances

center

The current center of the map.

Type:

list, default [0, 0]

zoom

The current zoom value of the map.

Type:

float, default 0

add_control(control)

Add a control on the map.

Parameters:

control (Control instance) – The new control to add.

add_layer(layer)

Add a layer on the map.

Parameters:

layer (Layer instance) – The new layer to add.

add_overlay(overlay)

Add an overlay to the map.

Parameters:

overlay (BaseOverlay instance) – The overlay to add.

clear_layers()

Remove all layers from the map.

on_click(callback, remove=False)

Add a click event listener.

remove_control(control)

Remove a control from the map.

Parameters:

control (Control instance) – The control to remove.

remove_layer(layer)

Remove a layer from the map.

Parameters:

layer (Layer instance) – The layer to remove.

remove_overlay(overlay)

Remove an overlay from the map.

Parameters:

overlay (BaseOverlay instance) – The overlay to remove.

class ipyopenlayers.openlayers.MousePosition(*args: t.Any, **kwargs: t.Any)

MousePosition class for displaying the mouse position on the map.

class ipyopenlayers.openlayers.PopupOverlay(*args: t.Any, **kwargs: t.Any)

PopupOverlay class.

popup_content

Content to display.

Type:

string, default “”

position

position of the popup.

Type:

list, default [0., 0]

class ipyopenlayers.openlayers.RasterTileLayer(*args: t.Any, **kwargs: t.Any)

RasterTileLayer class for WebGL-based raster tiles.

Inherits from TileLayer and provides additional functionality for rendering raster tiles using WebGL.

class ipyopenlayers.openlayers.ScaleLine(*args: t.Any, **kwargs: t.Any)

ScaleLine class for adding a scale line control to the map.

class ipyopenlayers.openlayers.TileLayer(*args: t.Any, **kwargs: t.Any)

The TileLayer class serves as the foundational class for both raster and vector tile layers.

url

The URL template for the tile images.

Type:

str

attribution

Attribution text for the tile layer.

Type:

str, default “”

opacity

Opacity of the tile layer, between 0.0 and 1.0.

Type:

float, default 1.0

visible

Whether the layer is visible or not.

Type:

bool, default True

min_zoom

Minimum zoom level for the layer.

Type:

int, default 0

max_zoom

Maximum zoom level for the layer.

Type:

int, default 18

source_format

Additional format options for the tile source.

Type:

dict

class ipyopenlayers.openlayers.VectorTileLayer(*args: t.Any, **kwargs: t.Any)

VectorTileLayer class for vector tiles. Inherits from TileLayer and provides additional functionality for vector tiles.

style

Style options for vector tiles.

Type:

dict

class ipyopenlayers.openlayers.VideoOverlay(*args: t.Any, **kwargs: t.Any)

VideoOverlay class.

Video layer from a local or remote video file.

video_url

Url to the local or remote image file.

Type:

string, default “”

position

center of the video.

Type:

list, default [0., 0]

class ipyopenlayers.openlayers.ZoomSlider(*args: t.Any, **kwargs: t.Any)

ZoomSlider class for adding a zoom slider control to the map.