Choropleth

Example

import ipyleaflet
import json
import pandas as pd
import os
import requests
from ipywidgets import link, FloatSlider
from branca.colormap import linear

def load_data(url, filename, file_type):
    r = requests.get(url)
    with open(filename, 'w') as f:
        f.write(r.content.decode("utf-8"))
    with open(filename, 'r') as f:
        return file_type(f)

geo_json_data = load_data(
    'https://raw.githubusercontent.com/jupyter-widgets/ipyleaflet/master/examples/us-states.json',
    'us-states.json',
     json.load)

unemployment = load_data(
    'https://raw.githubusercontent.com/jupyter-widgets/ipyleaflet/master/examples/US_Unemployment_Oct2012.csv',
    'US_Unemployment_Oct2012.csv',
     pd.read_csv)

unemployment =  dict(zip(unemployment['State'].tolist(), unemployment['Unemployment'].tolist()))

layer = ipyleaflet.Choropleth(
    geo_data=geo_json_data,
    choro_data=unemployment,
    colormap=linear.YlOrRd_04,
    border_color='black',
    style={'fillOpacity': 0.8, 'dashArray': '5, 5'})

m = ipyleaflet.Map(center = (43,-100), zoom = 4)
m.add(layer)
m

Usage

The Choropleth takes geo_data and choro_data as arguments.

The geo_data is a GeoJSON dictionary, for instance :

{
    "type": "FeatureCollection",
    "features":[{
        "type":"Feature",
        "id":"AL",
        "properties":{"name":"Alabama"},
        "geometry":{
            "type":"Polygon",
            "coordinates": [[[-87.359296,35.00118]]] ...
        }
    }]
}

The choro_data is a dictionary that maps an key to a float value, in order to build the colormap :

{'AL': 7.1,
 'AK': 6.8}

The Choropleth layer is then created specifying on which key the colormap is applied:

Choropleth(
    geo_data=geo_data,
    choro_data=choro_data,
    key_on='id'
)

Attributes

class ipyleaflet.leaflet.Choropleth(**kwargs: Any)

Choropleth class, with GeoJSON as parent class.

Layer showing a Choropleth effect on a GeoJSON structure.

geo_data

The GeoJSON structure on which to apply the Choropleth effect.

Type:

dict, default None

choro_data

Data used for building the Choropleth effect.

Type:

dict, default None

value_min

Minimum data value for the color mapping.

Type:

float, default None

value_max

Maximum data value for the color mapping.

Type:

float, default None

colormap

The colormap used for the effect.

Type:

branca.colormap.ColorMap instance, default linear.OrRd_06

key_on

The feature key to use for the colormap effect.

Type:

string, default “id”

nan_color

The color used for filling polygons with NaN-values data.

Type:

string, default “black”

nan_opacity

The opacity used for NaN data polygons, between 0. (fully transparent) and 1. (fully opaque).

Type:

float, default 0.4

default_opacity

The opacity used for well-defined data (non-NaN values), between 0. (fully transparent) and 1. (fully opaque).

Type:

float, default 1.0