Leaflet Contour

A customisable Leaflet contour plugin. Uses d3-contour under the hood.

Image of Leaflet Contour

Grid of simulated water temperature values on Lake Geneva from the Meteolakes project, plotted as filled contours.

Check out the examples:

Simple (source)
Lake (source)

Quick start

import L from "leaflet";
import 'leaflet-contour';

<link
    rel="stylesheet"
    href="https://unpkg.com/leaflet@1.7.1/dist/leaflet.css"
    integrity="sha512-xodZBNTC5n17Xt2atTPuE1HxjVMSvLVW9ocqUKLsCC5CXdbqCmblAshOMAS6/keqq/sMZMZ19scR4PsZChSR7A=="
    crossorigin=""
/>
<script
    src="https://unpkg.com/leaflet@1.7.1/dist/leaflet.js"
    integrity="sha512-XQoYMqMTK8LvdxXYG3nZ448hOEQiglfqkJs1NOQV44cWnUrBc8PkAOcXy20w0vlaXaVUearIOBhiXZ5V3ynxwA=="
    crossorigin=""
></script>
<script type="text/javascript" src="https://unpkg.com/leaflet-contour"></script>

then

var map = L.map("map");
L.contour(data, {
    thresholds: 50
}).addTo(map);

API reference

data

Data must be an object {x: [[]], y:[[]], z:[[]]} where x, y, z are 2D arrays of equivalent shape. x: Longitude y: Latitude z: Parameter to display

:warning: Leaflet contour can only be used to disply gridded data, the gridded data must include geographic data beyond the real values (this means at least one layer of surrounding null values). For point data leaflet.heat may be more appropriate.

Example rectangluar gridded data:

	8.475	8.5	8.525	8.55	8.575	8.6	8.625
47.42	null	null	null	null	null	null	null
47.4	null	null	null	2	null	null	null
47.38	null	null	2	5	2	null	null
47.36	null	2	5	10	5	2	null
47.34	null	null	2	5	2	null	null
47.32	null	null	null	2	null	null	null
47.3	null	null	null	null	null	null	null

const data = {\ x: [\ [8.475, 8.5, 8.525, 8.55, 8.575, 8.6, 8.625],\ [8.475, 8.5, 8.525, 8.55, 8.575, 8.6, 8.625],\ [8.475, 8.5, 8.525, 8.55, 8.575, 8.6, 8.625],\ [8.475, 8.5, 8.525, 8.55, 8.575, 8.6, 8.625],\ [8.475, 8.5, 8.525, 8.55, 8.575, 8.6, 8.625],\ [8.475, 8.5, 8.525, 8.55, 8.575, 8.6, 8.625],\ [8.475, 8.5, 8.525, 8.55, 8.575, 8.6, 8.625],\ ],\ y: [\ [47.42, 47.42, 47.42, 47.42, 47.42, 47.42, 47.42],\ [47.4, 47.4, 47.4, 47.4, 47.4, 47.4, 47.4],\ [47.38, 47.38, 47.38, 47.38, 47.38, 47.38, 47.38],\ [47.36, 47.36, 47.36, 47.36, 47.36, 47.36, 47.36],\ [47.34, 47.34, 47.34, 47.34, 47.34, 47.34, 47.34],\ [47.32, 47.32, 47.32, 47.32, 47.32, 47.32, 47.32],\ [47.3, 47.3, 47.3, 47.3, 47.3, 47.3, 47.3],\ ],\ z: [\ [null, null, null, null, null, null, null],\ [null, null, null, 2, null, null, null],\ [null, null, 2, 5, 2, null, null],\ [null, 2, 5, 10, 5, 2, null],\ [null, null, 2, 5, 2, null, null],\ [null, null, null, 2, null, null, null],\ [null, null, null, null, null, null, null],\ ],\ };

thresholds

Number of contours to draw

custom contour style

Contours are produced as geojson, so the same techniques to control geojson plotting can be used to style the contours [link].

For example filled contours, coloured based on contour value. Here "getColor" is a function that accepts a value, min, max and a color range and returns a color on that range. An example of the function is available in the examples.

L.contour(data, {
    thresholds: 50,
    style: (feature) => {
        return {
        color: getColor(feature.geometry.value, 10.5, 13.6, colors),
        opacity: 0,
        fillOpacity: 1,
        };
    },
}).addTo(map);

add popup

This shows how to add an onclick popup that gives the value of the contour.

L.contour(data, {
    thresholds: 50,
    onEachFeature: onEachContour(),
}).addTo(map);

function onEachContour() {
    return function onEachFeature(feature, layer) {
        layer.bindPopup(
        `<table><tbody><tr><td>${feature.value}°C</td></tr></tbody></table>`
        );
    };
}

JamesRunnalls / leaflet-contour