Create a Map with Folium and Leaflet.js Generate a base map of given width and height with either default tilesets or a custom tileset URL. F

Wrapper around Javascript code.

Create a Popup instance that can be linked to a Layer. Parameters ---------- html: string or Element Content of the Popup. pa

Creates a GeoJson object for plotting into a Map. Parameters ---------- data: file, dict or str. The GeoJSON data you want t

Create a tile layer to append on a Map. Parameters ---------- tiles: str or :class:`xyzservices.TileProvider`, default 'OpenStreetMa

Create a simple stock Leaflet marker on the map, with optional popup text or Vincent visualization. Parameters ---------- locati

Apply a GeoJSON overlay to the map. Plot a GeoJSON overlay on the base map. There is no requirement to bind data (passing just a GeoJSON plot

Create a Heatmap layer Parameters ---------- data : list of points of the form [lat, lng] or [lat, lng, weight] The points y

Create a tooltip that shows text when hovering over its parent object. Parameters ---------- text: str String to display as

Creates a LayerControl object to be added on a folium map. This object should be added to a Map object. Only Layer children of Map are i

Draw polyline overlays on a map. See :func:`folium.vector_layers.path_options` for the `Path` options. Parameters ---------- locatio

Add vector tile layers based on https://github.com/Leaflet/Leaflet.VectorGrid. Parameters ---------- url: str url to tile pr

Add javascript event handlers. Examples -------- >>> import folium >>> from folium.utilities import JsCode >>> >>> m = f

Add marker clusters to a map using in-browser rendering. Using FastMarkerCluster it is possible to render 000's of points far quicker tha

Create a FeatureGroup layer ; you can put things in it and handle them as a single layer. For example, you can add a LayerControl to tic

A plugin that handles overlapping markers on a map by spreading them out in a spiral or circle pattern when clicked. This plugin is useful w

Class for drawing circle overlays on a map. It's an approximation and starts to diverge from a real circle closer to the poles (due to p

A circle of a fixed size with radius specified in pixels. See :func:`folium.vector_layers.path_options` for the `Path` options. Paramet

When one clicks on a Map that contains a ClickForMarker, a Marker is created at the pointer's position. Parameters ---------- po

Creates a custom pane to hold map elements. Behavior is as in https://leafletjs.com/examples/map-panes/ Parameters ---------- n

Selenium WebDriver wrapper that adds folium test specific features.

Abstract class to add an element to another element.

Fit the map to contain a bounding box with the maximum zoom level possible. Parameters ---------- bounds: list of (latitude, longitud

Create a popup feature to bind to each element of a GeoJson layer based on its attributes. Parameters ---------- fields: list or

Create dicts that map styling to GeoJson features. :meta private:

An Open Source Leaflet Plugin for editing polygons Examples -------- >>> m = folium.Map() >>> Geoman().add_to(m) For more i

Creates an Icon object that will be rendered using Leaflet.awesome-markers. Parameters ---------- color : str, default 'blue'

Extract the iframes from an html page.

Generate an include statement on a class.

Provides Beautiful Animated Marker Clustering functionality for maps. Parameters ---------- locations: list of list or array of shap

Abstract class to add an element to another element.

Add a field that shows the coordinates of the mouse position. Uses the Leaflet plugin by Ardhi Lukianto under MIT license. https://github.com

Create PolyLines directly from the encoded string. Parameters ---------- encoded: str The raw encoded string from the Polyline En

Draw polygon overlays on a map. See :func:`folium.vector_layers.path_options` for the `Path` options. Parameters ---------- location

Create Polygons directly from the encoded string. Parameters ---------- encoded: str The raw encoded string from the Polyline Enc

Put realtime data on a Leaflet map: live tracking GPS units, sensor data or just about anything. Based on: https://github.com/perliedman/leaf

Draw rectangle overlays on a map. See :func:`folium.vector_layers.path_options` for the `Path` options. Parameters ---------- bounds

Create a choropleth with a timeslider for timestamped data. Visualize timestamped data, allowing users to view the choropleth at differe

Creates a TopoJson object for plotting into a Map. Parameters ---------- data: file, dict or str. The TopoJSON data you want

Class for drawing AntPath polyline overlays on a map. See :func:`folium.vector_layers.path_options` for the `Path` options. Parameters

Base class for vector classes with multiple coordinates. :meta private:

Create a BeautifyIcon that can be added to a Marker Parameters ---------- icon: string, default None the Font-Awesome icon n

Add a Marker in the shape of a boat. Parameters ---------- location: tuple of length 2, default None The latitude and longitude o

Fill Pattern for polygon composed of repeating circles. Add these to the 'fillPattern' field in GeoJson style functions. Parameters ----

The root class of the leaflet class hierarchy

When one clicks on a Map that contains a ClickForLatLng, the coordinates of the pointer's position are copied to clipboard. Parameters

Draw data on a map with specified colors. Parameters ---------- positions: iterable of (lat, lon) pairs The points on the li

Add a Leaflet Control object to the map Parameters ---------- control: str The javascript class name of the control to be re

Create a custom icon, based on an image. Parameters ---------- icon_image : string or array-like object The data to use as a

Represents a lightweight icon for markers that uses a simple `div` element instead of an image. Parameters ---------- icon_size

Vector drawing and editing plugin for Leaflet. Parameters ---------- export : bool, default False Add a small button that ex

Create two maps in the same window. Adding children to this objects adds them to both maps. You can access the individual maps with `DualMap.

The base class for Layer and Map Adds the `on` and `once` methods for event handling capabilities. See https://leafletjs.com/reference.html#

Creates a Feature Group that adds its child layers into a parent group when added to a map (e.g. through LayerControl). Useful to create nest

Fit the bounds of the maps to the enabled overlays. Parameters ---------- padding: int, default 0 Amount of padding in pixels app

Adds a floating image in HTML canvas on top of the map. Parameters ---------- image: str Url to image location. Can also be an in

Adds a fullscreen button to your map. Parameters ---------- position : str change the position of the button can be:

Base class for GeoJsonTooltip and GeoJsonPopup. :meta private:

Create a tooltip that uses data from either geojson or topojson. Parameters ---------- fields: list or tuple. Labels of GeoJ

A simple geocoder for Leaflet that by default uses OSM/Nominatim. Please respect the Nominatim usage policy: https://operations.osmfoundation

Create a Layer Control with groups of overlays. Parameters ---------- groups : dict A dictionary where the keys are group

Create a HeatMapWithTime layer Parameters ---------- data: list of list of points of the form [lat, lng] or [lat, lng, weight]

Used to load and display a single image over specific bounds of the map, implements ILayer interface. Parameters ---------- imag

Render links to external Javascript and CSS resources.

When one clicks on a Map that contains a LatLngPopup, a popup is shown that displays the latitude and longitude of the pointer.

An abstract class for everything that is a Layer on the map. It will be used to define whether an object will be included in LayerControls.

Control plugin to geolocate the user. This plugins adds a button to the map, and when it's clicked shows the current user device location.

Add a measurement widget on the map. Parameters ---------- position: str, default 'topright' Location of the widget. primary_

Add a minimap (locator) to an existing map. Uses the Leaflet plugin by Norkart under BSD 2-Clause "Simplified" License. https://github.com/No

Add offset capabilities to the PolyLine class. This plugin adds to folium Polylines the ability to be drawn with a relative pixel offset

Shows a text along a PolyLine. Parameters ---------- polyline: folium.features.PolyLine object The folium.features.PolyLine

Custom markers using the Leaflet Data Vis Framework. Parameters ---------- location: tuple or list Latitude and Longitude of

Creates a button for enabling/disabling scroll on the Map.

Adds a search tool to your map. Parameters ---------- layer: GeoJson, TopoJson, FeatureGroup, MarkerCluster class object. Th

Add a marker in the shape of a semicircle, similar to the Circle class. Use (direction and arc) or (start_angle and stop_angle), not both. P

Set the icon of a marker after both are created.

Creates a SideBySideLayers that takes two Layers and adds a sliding control with the leaflet-side-by-side plugin. Uses the Leaflet leafl

Fill Pattern for polygon composed of alternating lines. Add these to the 'fillPattern' field in GeoJson style functions. Parameters ----

Creates a Tag Filter Button to filter elements based on criteria (https://github.com/maydemirx/leaflet-tag-filter-button) This plugin wo

Leaflet.Terminator is a simple plug-in to the Leaflet library to overlay day and night regions on maps.

Test class for the Folium library.

Create a layer from GeoJSON with time data to add to a map. To add time data, you need to do one of the following: * Add a 'start' and

Creates a timeline slider for timeline layers. Parameters ---------- auto_play: bool, default True Whether the animation sha

Creates a TimestampedGeoJson plugin from timestamped GeoJSONs to append into a map with Map.add_child. A geo-json is timestamped if:

Creates a TimestampedWmsTileLayer that takes a WmsTileLayer and adds time control with the Leaflet.TimeDimension plugin. Parameters

Create a Layer Control allowing a tree structure for the layers. See https://github.com/jjimenezshaw/Leaflet.Control.Layers.Tree for more

Creates a Vega chart element. Parameters ---------- data: JSON-like str or object The Vega description of the chart.

Creates a Vega-Lite chart element. Parameters ---------- data: JSON-like str or object The Vega-Lite description of the char

Used to load and display a video over the map. Parameters ---------- video_url: str URL of the video bounds: list/tuple

Creates a Web Map Service (WMS) layer. Parameters ---------- url : str The url of the WMS server. layers : str C

Base Interface to create folium objects from encoded strings. Derived classes must define `_encoding_type` property which returns the string