README.md

maplibre-adiff-viewer

A MapLibre GL JS plugin to visualize OpenStreetMap augmented diff files on a map in the browser, in the manner of osmcha.org.

Installation

npm install @osmcha/maplibre-adiff-viewer

Usage

import maplibre from "maplibre-gl";
import adiffParser from "@osmcha/osm-adiff-parser";
import { MapLibreAugmentedDiffViewer } from "@osmcha/maplibre-adiff-viewer";

let map = new maplibre.Map({ /* configure your map here */ });

let adiff = await adiffParser(augmentedDiffXmlString); // parse your augmented diff XML
let adiffViewer = new MapLibreAugmentedDiffViewer(adiff); // initialize the plugin

map.once("load", () => adiffViewer.addTo(map)); // add the plugin to the map

License

This code is available under the ISC License. See the LICENSE file for details.