geog510_lab_utils folium implementation

Extension of Folium class Map for custom use in geog510_lab_utils

Map (Map)

Source code in geog510_lab_utils/foliumap.py

class Map(folium.Map):

    def __init__(self, center=(0, 0), zoom=2, **kwargs):
        """Initializes Map object based on folium.Map

        Args:
            center (tuple, optional): Center of Map. Defaults to (0, 0).
            zoom (int, optional): Initial zoom level. Defaults to 2.
        """
        super().__init__(location=center, zoom_start=zoom, **kwargs)

    def add_geojson(self, data, hover_style=None, **kwargs):
        """Add GeoJson to the map.

        Args:
            data (_type_): Data dictionary representing GeoJson
            hover_style (_type_, optional): Initial hover style. Defaults to None.
        """

        import geopandas as gpd

        if hover_style is None:
            hover_style = {"color": "green", "fillOpacity": 0.2}

        if isinstance(data, str):
            gdf = gpd.read_file(data)
            geojson = gdf.__geo_interface__

        elif isinstance(data, dict):
            geojson = data

        folium.GeoJson(data=geojson, **kwargs).add_to(self)

    def add_gdf(self, gdf, **kwargs):
        """Adds GeoDataFrame to Map

        Args:
            gdf (_type_): GeoDataFrame to be added to Map
        """

        gdf = gdf.to_crs(epsg=4326)
        geojson = gdf.__geo_interface__

        self.add_geojson(geojson, **kwargs)

    def add_vector(self, data, **kwargs):
        """Add vector data to map.

        Args:
            data (_type_): Can be any vector datatype supported by GeoPandas

        Raises:
            ValueError: If datatype is not support by GeoPandas

        Returns:
            _type_:
        """
        import geopandas as gpd

        if isinstance(data, str):
            gdf = gpd.read_file(data)

        elif isinstance(data, gpd.GeoDataFrame):
            gdf = data

        elif isinstance(data, dict):
            return self.add_geojson(data, **kwargs)

        else:
            raise ValueError("Invalid data type.")

        self.add_gdf(gdf, **kwargs)

    def add_layer_control(self):
        """Adds Layer Control to Map"""
        folium.LayerControl().add_to(self)

__init__(self, center=(0, 0), zoom=2, **kwargs) special

Initializes Map object based on folium.Map

Parameters:

Name	Type	Description	Default
center	tuple	Center of Map. Defaults to (0, 0).	(0, 0)
zoom	int	Initial zoom level. Defaults to 2.	2

Source code in geog510_lab_utils/foliumap.py

def __init__(self, center=(0, 0), zoom=2, **kwargs):
    """Initializes Map object based on folium.Map

    Args:
        center (tuple, optional): Center of Map. Defaults to (0, 0).
        zoom (int, optional): Initial zoom level. Defaults to 2.
    """
    super().__init__(location=center, zoom_start=zoom, **kwargs)

add_gdf(self, gdf, **kwargs)

Adds GeoDataFrame to Map

Parameters:

Name	Type	Description	Default
gdf	_type_	GeoDataFrame to be added to Map	required

Source code in geog510_lab_utils/foliumap.py

def add_gdf(self, gdf, **kwargs):
    """Adds GeoDataFrame to Map

    Args:
        gdf (_type_): GeoDataFrame to be added to Map
    """

    gdf = gdf.to_crs(epsg=4326)
    geojson = gdf.__geo_interface__

    self.add_geojson(geojson, **kwargs)

add_geojson(self, data, hover_style=None, **kwargs)

Add GeoJson to the map.

Parameters:

Name	Type	Description	Default
data	_type_	Data dictionary representing GeoJson	required
hover_style	_type_	Initial hover style. Defaults to None.	None

Source code in geog510_lab_utils/foliumap.py

def add_geojson(self, data, hover_style=None, **kwargs):
    """Add GeoJson to the map.

    Args:
        data (_type_): Data dictionary representing GeoJson
        hover_style (_type_, optional): Initial hover style. Defaults to None.
    """

    import geopandas as gpd

    if hover_style is None:
        hover_style = {"color": "green", "fillOpacity": 0.2}

    if isinstance(data, str):
        gdf = gpd.read_file(data)
        geojson = gdf.__geo_interface__

    elif isinstance(data, dict):
        geojson = data

    folium.GeoJson(data=geojson, **kwargs).add_to(self)

add_layer_control(self)

Adds Layer Control to Map

Source code in geog510_lab_utils/foliumap.py

def add_layer_control(self):
    """Adds Layer Control to Map"""
    folium.LayerControl().add_to(self)

add_vector(self, data, **kwargs)

Add vector data to map.

Parameters:

Name	Type	Description	Default
data	_type_	Can be any vector datatype supported by GeoPandas	required

Exceptions:

Type	Description
ValueError	If datatype is not support by GeoPandas

Returns:

Type	Description
_type_

Source code in geog510_lab_utils/foliumap.py

def add_vector(self, data, **kwargs):
    """Add vector data to map.

    Args:
        data (_type_): Can be any vector datatype supported by GeoPandas

    Raises:
        ValueError: If datatype is not support by GeoPandas

    Returns:
        _type_:
    """
    import geopandas as gpd

    if isinstance(data, str):
        gdf = gpd.read_file(data)

    elif isinstance(data, gpd.GeoDataFrame):
        gdf = data

    elif isinstance(data, dict):
        return self.add_geojson(data, **kwargs)

    else:
        raise ValueError("Invalid data type.")

    self.add_gdf(gdf, **kwargs)