Add your own layers¶

Draw your own zones, points or lines with the roads, each as a layer you can click and switch on or off.

Python

rs.render_edges(edges, palette="mono", overlays=[
    rs.Overlay(zones, placement="under", color="#6aa9ff", opacity=0.14,
               label="Zones", popup=["zone_id", "name"]),
    rs.Overlay(pois, placement="over", color="#ff5d5d", radius=7,
               label="Places", popup=["name", "type"]),
]).save("overlays.html")

zones and pois are your own GeoDataFrames, in any CRS. An overlay keeps the style you give it; it does not use the road palette.

The Overlay¶

rs.Overlay(data, kind=None, placement="over", color=None, opacity=None, outline=None,
           radius=None, width=None, label=None, popup=None, tooltip=None, visible=True)

kind: "fill", "line" or "circle". Left out, it follows the geometry: polygons fill, lines are lines, points are circles.
placement: "under" the roads (zone fills) or "over" them (points). The default is "over".
color, opacity, outline (fills), radius (circles), width (lines and outlines): one style for the whole layer. To colour features by a value, split them into one overlay per value.
label: the layer's name in the Layers control.
popup: the fields shown when a feature is clicked. None shows every field; [] makes the layer not clickable.
tooltip: the fields shown on hover. visible=False starts the layer switched off.

The Layers control¶

Each overlay gets a checkbox in the Layers control, at the bottom-right above the base-map button. From your own page, rsSetOverlay("Zones", false) hides a layer (by label or index): see the JavaScript API.

What wins a click¶

The layer drawn on top wins:

an "over" overlay,
the roads,
an "under" overlay, only where the click misses every road.

So a road inside a clickable zone can still be selected. Its popup also lists the zones under the click.

Note

Overlays work on the web backend only (the default).