Skip to content

Commit d08d8b2

Browse files
committed
Update changelog with more explicit migration instructions for LegendControl.
1 parent 65eeb9b commit d08d8b2

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@
55
* Add Map panes [#999](https://github.com/jupyter-widgets/ipyleaflet/pull/999)
66
* Allow setting Map.dragging [#1001](https://github.com/jupyter-widgets/ipyleaflet/pull/1001)
77
* Add visible attribute to GeoJSON layer [#1002](https://github.com/jupyter-widgets/ipyleaflet/pull/1002)
8-
* [BREAKING CHANGE] Remove get and set decorators in LegendControl [#979](https://github.com/jupyter-widgets/ipyleaflet/pull/979)
8+
* [BREAKING CHANGE] Remove `name`, `legends`, `positioning`, and `positionning` properties in LegendControl [#979](https://github.com/jupyter-widgets/ipyleaflet/pull/979). Update your code with the following substitutions for a LegendControl `legend`:
9+
* `legend.name` -> `legend.title`
10+
* `legend.legends` -> `legend.legend`
11+
* `legend.positioning` -> `legend.position`
12+
* `legend.positionnning` -> `legend.position`
13+
14+
The recommended way to create a LegendControl with a given title is to use the `title` parameter: `LegendControl({}, title='My Title')`. There is a backwards compatibility shim in place, so giving the title as `name` in the constructor still works, but is not recommended: `LegendControl({}, name='My Title')`
915

1016
## Maintenance
1117

0 commit comments

Comments
 (0)