Skip to content

foliumap module

Folium module for creating a map.

Map (Map)

Create a folium map object.

Source code in geomapdemo/foliumap.py 
class Map(folium.Map):
    """Create a folium map object."""

    def __init__(self, center=[20, 0], zoom=10, **kwargs) -> None:
        """Initialize the map objects.
        Args:
            center (list, optional): The center of the map. Defaults to [20,0].
            zoom (int, optional): Zoom level. Defaults to 10.
            **kwargs: Keyword arguments.
        """

        super().__init__(location=center, zoom_start=zoom, **kwargs)

    def add_tile_layer(self, url, name, attribution=" ", **kwargs):
        """Adds a tile layer to the map
        Args:
            url (str): The url of the tile layer.
            name (str): The name of the tile layer.
            attribution (str, optional): The attribution of the tile layer. Defaults to "".
            **kwargs: Keyword arguments to be passed to the tile layer.
        """
        tile_layer = folium.TileLayer(tiles=url, name=name, attr=attribution, **kwargs)
        self.add_child(tile_layer)

    def add_marker(self, location, popup, **kwargs):
        """Adds a marker to the map
        Args:
            location (list): The location of the marker.
            popup (str): The popup text of the marker.
            **kwargs: Keyword arguments to be passed to the marker.
        """
        marker = folium.Marker(location=location, popup=popup, **kwargs)
        self.add_child(marker)

    def add_circle_marker(self, location, radius=10, popup="", fill=True, **kwargs):
        """Adds a circle marker to the map
        Args:
            location (list): The location of the marker.
            radius (int): The radius of the circle marker.Defaults to 10.
            popup (str): The popup text of the marker.
            fill (bool): Whether to fill the circle marker. Defaults to False.
            **kwargs: Keyword arguments to be passed to the marker.
        """
        marker = folium.CircleMarker(
            location=location, radius=radius, popup=popup, fill=fill, **kwargs
        )
        self.add_child(marker)

    def add_circle(self, location, radius=10, popup="", fill=False, **kwargs):
        """Adds a circle to the map
        Args:
            location (list): The location of the circle.
            radius (int): The radius of the circle marker.Defaults to 10.
            popup (str): The popup text of the marker.
            fill (bool): Whether to fill the circle marker. Defaults to False.
            **kwargs: Keyword arguments to be passed to the marker.
        """
        marker = folium.Circle(
            location=location, radius=radius, popup=popup, fill=fill, **kwargs
        )
        self.add_child(marker)

    def click_for_marker(self, popup="click Point"):
        """Adds a click listener to the map to add markers.
        Args:
            popup (str): The popup text of the marker. Defaults to "click Point".
        """
        self.add_child(folium.ClickForMarker(popup=popup))

    def add_polylines(self, locations, popup="", **kwargs):
        """Adds a polyline to the map
        Args:
            locations (list): The locations of the polyline.
            popup (str): The popup text of the polyline.
            **kwargs: Keyword arguments to be passed to the polyline.
        """
        polyline = folium.PolyLine(locations=locations, popup=popup, **kwargs)
        self.add_child(polyline)

    def add_polygon(self, locations, popup="", **kwargs):
        """Adds a polygon to the map
        Args:
            locations (list): The locations of the polygon.
            popup (str): The popup text of the polygon.
            **kwargs: Keyword arguments to be passed to the polygon.
        """
        polygon = folium.Polygon(locations=locations, popup=popup, **kwargs)
        self.add_child(polygon)

    def set_center(self, lat, lon, zoom=10):
        """Sets the center of the map
        Args:
            lat (float): The latitude of the center.
            lon (float): The longitude of the center.
            zoom (int): The zoom level. Defaults to 10.
        """
        self.fit_bounds([[lat, lon], [lat, lon]], max_zoom=zoom)

    def add_geojson(
        self,
        in_geojson,
        layer_name="Untitled",
        encoding="utf-8",
        **kwargs,
    ):
        """Adds a GeoJSON file to the map.

        Args:
            in_geojson (str): The input file path to the GeoJSON.
            layer_name (str, optional): The layer name to be used. Defaults to "Untitled".
            encoding (str, optional): The encoding of the GeoJSON file. Defaults to "utf-8".

        Raises:
            FileNotFoundError: The provided GeoJSON file could not be found.
        """
        import json
        import requests

        if in_geojson.startswith("http"):
            response = requests.get(in_geojson)
            data = response.json()
        else:
            try:
                with open(in_geojson, encoding=encoding) as f:
                    data = json.load(f)
            except FileNotFoundError:
                raise FileNotFoundError("The provided GeoJSON file could not be found.")

        # interchangeable parameters between ipyleaflet and folium.
        style_dict = {}
        if "style_function" not in kwargs:
            if "style" not in kwargs:
                style_dict = {
                    # "stroke": True,
                    "color": "#3388ff",
                    "weight": 2,
                    "opacity": 1,
                    # "fill": True,
                    # "fillColor": "#ffffff",
                    "fillOpacity": 0,
                    # "dashArray": "9"
                    # "clickable": True,
                }
                kwargs["style_function"] = lambda x: style_dict
            else:
                style_dict = kwargs["style"]
                kwargs["style_function"] = lambda x: style_dict

        geojson = folium.GeoJson(data=data, name=layer_name, **kwargs)
        self.add_child(geojson)

    def add_shp(self, path, name="Shapefile", **kwargs):
        """Adds a shapefile to the map
        Args:
            path (str): The path to the shapefile.
            name (str, optional): The name of the shapefile. Defaults to 'Shapefile'.
            **kwargs: Keyword arguments to be passed to the shapefile.
        """
        import geopandas as gpd

        gdf = gpd.read_file(path)
        geojson = gdf.__geo_interface__
        json = folium.GeoJson(data=geojson, name=name, **kwargs)
        self.add_child(json)

    def add_choropleth_map(
        self,
        json,
        csv,
        columns,
        key_on,
        name="choropleth",
        fill_color="YlGn",
        legend_name="",
        **kwargs,
    ):
        """Adds a choropleth map to the map
        Args:
            json (str): The path to the json file.
            csv (str): The path to the csv file.
            name (str, optional): The name of the choropleth map. Defaults to 'choropleth'.
            fill_color (str, optional): The color scale of the choropleth map. Defaults to 'YlGn'.
            legend_name (str, optional): The name of the legend. Defaults to ''.
            **kwargs: Keyword arguments to be passed to the choropleth map.
        """
        import geopandas as gpd
        import pandas as pd

        df = pd.read_csv(csv)

        if "fill_opacity" not in kwargs:
            kwargs["fill_opacity"] = 0.7

        if "line_opacity" not in kwargs:
            kwargs["line_opacity"] = 0.2

        choropleth = folium.Choropleth(
            geo_data=json,
            name=name,
            data=df,
            columns=columns,
            key_on=key_on,
            fill_color=fill_color,
            legend_name=legend_name,
            **kwargs,
        )
        self.add_child(choropleth)
        self.add_child(folium.LayerControl())

    def add_layer_control(self):
        """Adds a layer control to the map"""
        self.add_child(folium.LayerControl())

    def add_layer(self, layer):
        """Adds a layer to the map
        Args:
            layer (TileLayer): A TileLayer instance.
        """
        layer.add_to(self)

    def export(self, outfile="map.html"):
        """Saves the map to a file
        Args:
            outfile (str, optional): The output file path to the HTML file. Defaults to "map.html".
        """
        self.save(outfile)

__init__(self, center=[20, 0], zoom=10, **kwargs) special

Initialize the map objects.

Parameters:

Name Type Description Default
center list

The center of the map. Defaults to [20,0].

 [20, 0]
zoom int

Zoom level. Defaults to 10.

 10
**kwargs

Keyword arguments.

 {}
Source code in geomapdemo/foliumap.py 
def __init__(self, center=[20, 0], zoom=10, **kwargs) -> None:
    """Initialize the map objects.
    Args:
        center (list, optional): The center of the map. Defaults to [20,0].
        zoom (int, optional): Zoom level. Defaults to 10.
        **kwargs: Keyword arguments.
    """

    super().__init__(location=center, zoom_start=zoom, **kwargs)

add_choropleth_map(self, json, csv, columns, key_on, name='choropleth', fill_color='YlGn', legend_name='', **kwargs)

Adds a choropleth map to the map

Parameters:

Name Type Description Default
json str

The path to the json file.

 required
csv str

The path to the csv file.

 required
name str

The name of the choropleth map. Defaults to 'choropleth'.

 'choropleth'
fill_color str

The color scale of the choropleth map. Defaults to 'YlGn'.

 'YlGn'
legend_name str

The name of the legend. Defaults to ''.

 ''
**kwargs

Keyword arguments to be passed to the choropleth map.

 {}
Source code in geomapdemo/foliumap.py 
def add_choropleth_map(
    self,
    json,
    csv,
    columns,
    key_on,
    name="choropleth",
    fill_color="YlGn",
    legend_name="",
    **kwargs,
):
    """Adds a choropleth map to the map
    Args:
        json (str): The path to the json file.
        csv (str): The path to the csv file.
        name (str, optional): The name of the choropleth map. Defaults to 'choropleth'.
        fill_color (str, optional): The color scale of the choropleth map. Defaults to 'YlGn'.
        legend_name (str, optional): The name of the legend. Defaults to ''.
        **kwargs: Keyword arguments to be passed to the choropleth map.
    """
    import geopandas as gpd
    import pandas as pd

    df = pd.read_csv(csv)

    if "fill_opacity" not in kwargs:
        kwargs["fill_opacity"] = 0.7

    if "line_opacity" not in kwargs:
        kwargs["line_opacity"] = 0.2

    choropleth = folium.Choropleth(
        geo_data=json,
        name=name,
        data=df,
        columns=columns,
        key_on=key_on,
        fill_color=fill_color,
        legend_name=legend_name,
        **kwargs,
    )
    self.add_child(choropleth)
    self.add_child(folium.LayerControl())

add_circle(self, location, radius=10, popup='', fill=False, **kwargs)

Adds a circle to the map

Parameters:

Name Type Description Default
location list

The location of the circle.

 required
radius int

The radius of the circle marker.Defaults to 10.

 10
popup str

The popup text of the marker.

 ''
fill bool

Whether to fill the circle marker. Defaults to False.

 False
**kwargs

Keyword arguments to be passed to the marker.

 {}
Source code in geomapdemo/foliumap.py 
def add_circle(self, location, radius=10, popup="", fill=False, **kwargs):
    """Adds a circle to the map
    Args:
        location (list): The location of the circle.
        radius (int): The radius of the circle marker.Defaults to 10.
        popup (str): The popup text of the marker.
        fill (bool): Whether to fill the circle marker. Defaults to False.
        **kwargs: Keyword arguments to be passed to the marker.
    """
    marker = folium.Circle(
        location=location, radius=radius, popup=popup, fill=fill, **kwargs
    )
    self.add_child(marker)

add_circle_marker(self, location, radius=10, popup='', fill=True, **kwargs)

Adds a circle marker to the map

Parameters:

Name Type Description Default
location list

The location of the marker.

 required
radius int

The radius of the circle marker.Defaults to 10.

 10
popup str

The popup text of the marker.

 ''
fill bool

Whether to fill the circle marker. Defaults to False.

 True
**kwargs

Keyword arguments to be passed to the marker.

 {}
Source code in geomapdemo/foliumap.py 
def add_circle_marker(self, location, radius=10, popup="", fill=True, **kwargs):
    """Adds a circle marker to the map
    Args:
        location (list): The location of the marker.
        radius (int): The radius of the circle marker.Defaults to 10.
        popup (str): The popup text of the marker.
        fill (bool): Whether to fill the circle marker. Defaults to False.
        **kwargs: Keyword arguments to be passed to the marker.
    """
    marker = folium.CircleMarker(
        location=location, radius=radius, popup=popup, fill=fill, **kwargs
    )
    self.add_child(marker)

add_geojson(self, in_geojson, layer_name='Untitled', encoding='utf-8', **kwargs)

Adds a GeoJSON file to the map.

Parameters:

Name Type Description Default
in_geojson str

The input file path to the GeoJSON.

 required
layer_name str

The layer name to be used. Defaults to "Untitled".

 'Untitled'
encoding str

The encoding of the GeoJSON file. Defaults to "utf-8".

 'utf-8'

Exceptions:

Type Description
FileNotFoundError

The provided GeoJSON file could not be found.
Source code in geomapdemo/foliumap.py 
def add_geojson(
    self,
    in_geojson,
    layer_name="Untitled",
    encoding="utf-8",
    **kwargs,
):
    """Adds a GeoJSON file to the map.

    Args:
        in_geojson (str): The input file path to the GeoJSON.
        layer_name (str, optional): The layer name to be used. Defaults to "Untitled".
        encoding (str, optional): The encoding of the GeoJSON file. Defaults to "utf-8".

    Raises:
        FileNotFoundError: The provided GeoJSON file could not be found.
    """
    import json
    import requests

    if in_geojson.startswith("http"):
        response = requests.get(in_geojson)
        data = response.json()
    else:
        try:
            with open(in_geojson, encoding=encoding) as f:
                data = json.load(f)
        except FileNotFoundError:
            raise FileNotFoundError("The provided GeoJSON file could not be found.")

    # interchangeable parameters between ipyleaflet and folium.
    style_dict = {}
    if "style_function" not in kwargs:
        if "style" not in kwargs:
            style_dict = {
                # "stroke": True,
                "color": "#3388ff",
                "weight": 2,
                "opacity": 1,
                # "fill": True,
                # "fillColor": "#ffffff",
                "fillOpacity": 0,
                # "dashArray": "9"
                # "clickable": True,
            }
            kwargs["style_function"] = lambda x: style_dict
        else:
            style_dict = kwargs["style"]
            kwargs["style_function"] = lambda x: style_dict

    geojson = folium.GeoJson(data=data, name=layer_name, **kwargs)
    self.add_child(geojson)

add_layer(self, layer)

Adds a layer to the map

Parameters:

Name Type Description Default
layer TileLayer

A TileLayer instance.

 required
Source code in geomapdemo/foliumap.py 
def add_layer(self, layer):
    """Adds a layer to the map
    Args:
        layer (TileLayer): A TileLayer instance.
    """
    layer.add_to(self)

add_layer_control(self)

Adds a layer control to the map

Source code in geomapdemo/foliumap.py 
def add_layer_control(self):
    """Adds a layer control to the map"""
    self.add_child(folium.LayerControl())

add_marker(self, location, popup, **kwargs)

Adds a marker to the map

Parameters:

Name Type Description Default
location list

The location of the marker.

 required
popup str

The popup text of the marker.

 required
**kwargs

Keyword arguments to be passed to the marker.

 {}
Source code in geomapdemo/foliumap.py 
def add_marker(self, location, popup, **kwargs):
    """Adds a marker to the map
    Args:
        location (list): The location of the marker.
        popup (str): The popup text of the marker.
        **kwargs: Keyword arguments to be passed to the marker.
    """
    marker = folium.Marker(location=location, popup=popup, **kwargs)
    self.add_child(marker)

add_polygon(self, locations, popup='', **kwargs)

Adds a polygon to the map

Parameters:

Name Type Description Default
locations list

The locations of the polygon.

 required
popup str

The popup text of the polygon.

 ''
**kwargs

Keyword arguments to be passed to the polygon.

 {}
Source code in geomapdemo/foliumap.py 
def add_polygon(self, locations, popup="", **kwargs):
    """Adds a polygon to the map
    Args:
        locations (list): The locations of the polygon.
        popup (str): The popup text of the polygon.
        **kwargs: Keyword arguments to be passed to the polygon.
    """
    polygon = folium.Polygon(locations=locations, popup=popup, **kwargs)
    self.add_child(polygon)

add_polylines(self, locations, popup='', **kwargs)

Adds a polyline to the map

Parameters:

Name Type Description Default
locations list

The locations of the polyline.

 required
popup str

The popup text of the polyline.

 ''
**kwargs

Keyword arguments to be passed to the polyline.

 {}
Source code in geomapdemo/foliumap.py 
def add_polylines(self, locations, popup="", **kwargs):
    """Adds a polyline to the map
    Args:
        locations (list): The locations of the polyline.
        popup (str): The popup text of the polyline.
        **kwargs: Keyword arguments to be passed to the polyline.
    """
    polyline = folium.PolyLine(locations=locations, popup=popup, **kwargs)
    self.add_child(polyline)

add_shp(self, path, name='Shapefile', **kwargs)

Adds a shapefile to the map

Parameters:

Name Type Description Default
path str

The path to the shapefile.

 required
name str

The name of the shapefile. Defaults to 'Shapefile'.

 'Shapefile'
**kwargs

Keyword arguments to be passed to the shapefile.

 {}
Source code in geomapdemo/foliumap.py 
def add_shp(self, path, name="Shapefile", **kwargs):
    """Adds a shapefile to the map
    Args:
        path (str): The path to the shapefile.
        name (str, optional): The name of the shapefile. Defaults to 'Shapefile'.
        **kwargs: Keyword arguments to be passed to the shapefile.
    """
    import geopandas as gpd

    gdf = gpd.read_file(path)
    geojson = gdf.__geo_interface__
    json = folium.GeoJson(data=geojson, name=name, **kwargs)
    self.add_child(json)

add_tile_layer(self, url, name, attribution=' ', **kwargs)

Adds a tile layer to the map

Parameters:

Name Type Description Default
url str

The url of the tile layer.

 required
name str

The name of the tile layer.

 required
attribution str

The attribution of the tile layer. Defaults to "".

 ' '
**kwargs

Keyword arguments to be passed to the tile layer.

 {}
Source code in geomapdemo/foliumap.py 
def add_tile_layer(self, url, name, attribution=" ", **kwargs):
    """Adds a tile layer to the map
    Args:
        url (str): The url of the tile layer.
        name (str): The name of the tile layer.
        attribution (str, optional): The attribution of the tile layer. Defaults to "".
        **kwargs: Keyword arguments to be passed to the tile layer.
    """
    tile_layer = folium.TileLayer(tiles=url, name=name, attr=attribution, **kwargs)
    self.add_child(tile_layer)

click_for_marker(self, popup='click Point')

Adds a click listener to the map to add markers.

Parameters:

Name Type Description Default
popup str

The popup text of the marker. Defaults to "click Point".

 'click Point'
Source code in geomapdemo/foliumap.py 
def click_for_marker(self, popup="click Point"):
    """Adds a click listener to the map to add markers.
    Args:
        popup (str): The popup text of the marker. Defaults to "click Point".
    """
    self.add_child(folium.ClickForMarker(popup=popup))

export(self, outfile='map.html')

Saves the map to a file

Parameters:

Name Type Description Default
outfile str

The output file path to the HTML file. Defaults to "map.html".

 'map.html'
Source code in geomapdemo/foliumap.py 
def export(self, outfile="map.html"):
    """Saves the map to a file
    Args:
        outfile (str, optional): The output file path to the HTML file. Defaults to "map.html".
    """
    self.save(outfile)

set_center(self, lat, lon, zoom=10)

Sets the center of the map

Parameters:

Name Type Description Default
lat float

The latitude of the center.

 required
lon float

The longitude of the center.

 required
zoom int

The zoom level. Defaults to 10.

 10
Source code in geomapdemo/foliumap.py 
def set_center(self, lat, lon, zoom=10):
    """Sets the center of the map
    Args:
        lat (float): The latitude of the center.
        lon (float): The longitude of the center.
        zoom (int): The zoom level. Defaults to 10.
    """
    self.fit_bounds([[lat, lon], [lat, lon]], max_zoom=zoom)