Skip to content

foliumap module

Map (Map)

Create a folium map object.

Parameters:

Name Type Description Default
folium _type_

description

 required
Source code in geoproject/foliumap.py 
class Map(folium.Map):

    """Create a folium map object.

    Args:
        folium (_type_): _description_
    """    
    def __init__(self, center=[48,2], zoom=2, **kwargs) -> None:
        """Initializes the map object.

        Args:
            center (list, optional): The map center. Defaults to [20, 0].
            zoom (int, optional): The zoom level. Defaults to 2.
        """
        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 "".
        """
        tile_layer = folium.TileLayer(
            tiles=url,
            name=name,
            attr=attribution,
            **kwargs
        )
        self.add_child(tile_layer)

__init__(self, center=[48, 2], zoom=2, **kwargs) special

Initializes the map object.

Parameters:

Name Type Description Default
center list

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

 [48, 2]
zoom int

The zoom level. Defaults to 2.

 2
Source code in geoproject/foliumap.py 
def __init__(self, center=[48,2], zoom=2, **kwargs) -> None:
    """Initializes the map object.

    Args:
        center (list, optional): The map center. Defaults to [20, 0].
        zoom (int, optional): The zoom level. Defaults to 2.
    """
    super().__init__(location=center, zoom_start=zoom, **kwargs)

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 "".

 ''
Source code in geoproject/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 "".
    """
    tile_layer = folium.TileLayer(
        tiles=url,
        name=name,
        attr=attribution,
        **kwargs
    )
    self.add_child(tile_layer)
Last update: 2023-05-25
Created: 2023-05-25