Follow up of #979, correcting our LegendControl docs where needed.

I left in a backwards-compatible shim for giving the name argument to the LegendControl.

Author: jasongrout

docs/source/controls/legend_control.rst

@@ -10,7 +10,7 @@ Example
 
     m = Map(center=(-10,-45), zoom=4)
 
-    legend = LegendControl({"low":"#FAA", "medium":"#A55", "High":"#500"}, name="Legend", position="bottomright")
+    legend = LegendControl({"low":"#FAA", "medium":"#A55", "High":"#500"}, title="Legend", position="bottomright")
     m.add(legend)
 
     m
@@ -20,12 +20,12 @@ Example
     # Manipulate the legend
 
     # Set/Get legend title
-    legend.name = "Risk"  # Set name
-    legend.name  # Get name
+    legend.title = "Risk"  # Set title
+    legend.title  # Get title
 
     # Set/Get legend content
-    legend.legends = {"el1":"#FAA", "el2":"#A55", "el3":"#500"}  # Set content
-    legend.legends  # Get content
+    legend.legend = {"el1":"#FAA", "el2":"#A55", "el3":"#500"}  # Set content
+    legend.legend  # Get content
 
     legend.add_legend_element("el5","#000")  # Add a legend element
     legend.remove_legend_element("el5")  # Remove a legend element

examples/LegendControl.ipynb

@@ -54,7 +54,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "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 named 'Legend', but you can pass a name as argument as well."
+    "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."
    ]
   },
   {
@@ -65,7 +65,7 @@
    "source": [
     "a_legend = LegendControl(\n",
     "    {\"low\": \"#FAA\", \"medium\": \"#A55\", \"High\": \"#500\"},\n",
-    "    name=\"Legend\",\n",
+    "    title=\"Legend\",\n",
     "    position=\"bottomright\",\n",
     ")"
    ]
@@ -90,7 +90,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Name"
+    "### Title"
    ]
   },
   {
@@ -99,8 +99,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "a_legend.name = \"Risk\"  ## set name\n",
-    "a_legend.name  # get name"
+    "a_legend.title = \"Risk\"  ## set title\n",
+    "a_legend.title  # get title"
    ]
   },
   {

ipyleaflet/leaflet.py

@@ -1932,10 +1932,13 @@ class LegendControl(Control):
         "value 2": "#55A",
         "value 3": "#005"}).tag(sync=True)
 
-    def __init__(self, legend, *args, name="Legend", **kwargs):
+    def __init__(self, legend, *args, **kwargs):
+        kwargs["legend"] = legend
+        # For backwards compatibility with ipyleaflet<=0.16.0
+        if 'name' in kwargs:
+            kwargs.setdefault('title', kwargs['name'])
+            del kwargs['name']
         super().__init__(*args, **kwargs)
-        self.title = name
-        self.legend = legend
 
     def add_legend_element(self, key, value):
         """Add a new legend element.