Legend Control#

Example#

from ipyleaflet import Map, LegendControl

m = Map(center=(-10,-45), zoom=4)

legend = LegendControl({"low":"#FAA", "medium":"#A55", "High":"#500"}, name="Legend", position="bottomright")
m.add_control(legend)

m
# Manipulate the legend

# Set/Get legend title
legend.name = "Risk"  # Set name
legend.name  # Get name

# Set/Get legend content
legend.legends = {"el1":"#FAA", "el2":"#A55", "el3":"#500"}  # Set content
legend.legends  # Get content

legend.add_legend_element("el5","#000")  # Add a legend element
legend.remove_legend_element("el5")  # Remove a legend element

# legend position
legend.position = "topright"  # Set position
legend.position  # Get current position
'topright'

Attributes and methods#

class ipyleaflet.leaflet.LegendControl(**kwargs)[source]#

LegendControl class, with Control as parent class.

A control which contains a legend.

title#

The title of the legend.

Type

str, default ‘Legend’

legend#

A dictionary containing names as keys and CSS colors as values.

Type

dict, default ‘Legend’

add_legend_element(key, value)[source]#

Add a new legend element.

Parameters
  • key (str) – The key for the legend element.

  • value (CSS Color) – The value for the legend element.

remove_legend_element(key)[source]#

Remove a legend element.

Parameters

key (str) – The element to remove.