Legend Control¶

step 1: create an ipyleaflet map¶

In [ ]:

from ipyleaflet import Map, LegendControl

In [ ]:

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

In [ ]:

mymap

step 2: create a legend¶

By default, you need to provide at least a dictionary with pair key=> the label to display and value=> the desired color. By default, it is titled 'Legend', but you can pass a title as argument as well.

In [ ]:

a_legend = LegendControl(
    {"low": "#FAA", "medium": "#A55", "High": "#500"},
    title="Legend",
    position="bottomright",
)

In [ ]:

mymap.add(a_legend)

Step 3: manipulate Legend¶

Title¶

In [ ]:

a_legend.title = "Risk"  ## set title
a_legend.title  # get title

Legend content¶

In [ ]:

a_legend.legends = {"el1": "#FAA", "el2": "#A55", "el3": "#500"}  # set content
a_legend.legends  # get content

a_legend.add_legend_element("el5", "#000")  # add a legend element

In [ ]:

a_legend.remove_legend_element("el5")  # remove a legend element

Positioning¶

In [ ]:

a_legend.positioning = "topright"  # set positioning : possible values are topleft, topright, bottomleft, bottomright
a_legend.positioning  # get current positioning