Repository navigation
LayerControl: optional persistence of layer selection in localStorage - #2332
Open
DresdenGman wants to merge 1 commit into
Open
DresdenGman wants to merge 1 commit into
DresdenGman wants to merge 1 commit into
Conversation
Save the user's layer control choices (the active base layer and the visible overlays) to the browser's local storage and restore them when the page is loaded again, so the choices survive a refresh. Opt-in, defaults to off and renders nothing extra when disabled. Fixes python-visualization#1636
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements the request in #1636 in an opt-in form.
LayerControlgains ause_local_storageoption (defaultFalse). It is a folium-side option, in the same style asdraggable, and is not passed through to the Leaflet control. When enabled, the rendered map includes a small script that stores the selected base layer and active overlays inlocalStorage, keyed by layer name and page path, restores them on load, and updates the stored state onbaselayerchange,overlayadd, andoverlayremove. With the option off — the default — the rendered output is unchanged.I saw in the #1636 discussion that there was some hesitation about whether this belongs in folium itself, so I kept it strictly opt-in and self-contained. Happy to adjust the shape, or to close this if you would rather it live outside core.
Notes and limits: