@maplibre/geojson-vt 5.0.0

package/LICENSE

@@ -0,0 +1,39 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 MapLibre contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+--------------------------------------------------------------------------------
+
+ISC License
+
+Copyright (c) 2024, Mapbox
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

package/README.md

@@ -0,0 +1,128 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://maplibre.org/img/maplibre-logos/maplibre-logo-for-dark-bg.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://maplibre.org/img/maplibre-logos/maplibre-logo-for-light-bg.svg">
+    <img alt="MapLibre Logo" src="https://maplibre.org/img/maplibre-logos/maplibre-logo-for-light-bg.svg" width="200">
+  </picture>
+</p>
+
+## geojson-vt &mdash; GeoJSON Vector Tiles
+
+A highly efficient JavaScript library for **slicing GeoJSON data into vector tiles on the fly**,
+primarily designed to enable rendering and interacting with large geospatial datasets
+on the browser side (without a server).
+
+Created to power GeoJSON in [MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js),
+but can be useful in other visualization platforms
+like [Leaflet](https://github.com/Leaflet/Leaflet), [OpenLayers](https://openlayers.org/) and [d3](https://github.com/mbostock/d3),
+as well as Node.js server applications.
+
+Resulting tiles conform to the JSON equivalent
+of the [vector tile specification](https://github.com/mapbox/vector-tile-spec/).
+To make data rendering and interaction fast, the tiles are simplified,
+retaining the minimum level of detail appropriate for each zoom level
+(simplifying shapes, filtering out tiny polygons and polylines).
+
+### Demo
+
+Here's **geojson-vt** action in [MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js),
+dynamically loading a 100Mb US zip codes GeoJSON with 5.4 million points:
+
+![](https://cloud.githubusercontent.com/assets/25395/5360312/86028d8e-7f91-11e4-811f-87f24acb09ca.gif)
+
+There's a convenient [debug page](http://maplibre.github.io/geojson-vt/debug/) to test out **geojson-vt** on different data.
+Just drag any GeoJSON on the page, watching the console.
+
+![](https://cloud.githubusercontent.com/assets/25395/5363235/41955c6e-7fa8-11e4-9575-a66ef54cb6d9.gif)
+
+### Usage
+
+```js
+// build an initial index of tiles
+var tileIndex = geojsonvt(geoJSON);
+
+// request a particular tile
+var features = tileIndex.getTile(z, x, y).features;
+
+// show an array of tile coordinates created so far
+console.log(tileIndex.tileCoords); // [{z: 0, x: 0, y: 0}, ...]
+```
+
+### Options
+
+You can fine-tune the results with an options object,
+although the defaults are sensible and work well for most use cases.
+
+```js
+var tileIndex = geojsonvt(data, {
+	maxZoom: 14,  // max zoom to preserve detail on; can't be higher than 24
+	tolerance: 3, // simplification tolerance (higher means simpler)
+	extent: 4096, // tile extent (both width and height)
+	buffer: 64,   // tile buffer on each side
+	debug: 0,     // logging level (0 to disable, 1 or 2)
+	lineMetrics: false, // whether to enable line metrics tracking for LineString/MultiLineString features
+	promoteId: null,    // name of a feature property to promote to feature.id. Cannot be used with `generateId`
+	generateId: false,  // whether to generate feature ids. Cannot be used with `promoteId`
+	updateable: false,  // whether the tile index can be updated (with the caveat of a stored simplified copy)
+	indexMaxZoom: 5,       // max zoom in the initial tile index
+	indexMaxPoints: 100000 // max number of points per tile in the index
+});
+```
+
+By default, tiles at zoom levels above `indexMaxZoom` are generated on the fly, but you can pre-generate all possible tiles for `data` by setting `indexMaxZoom` and `maxZoom` to the same value, setting `indexMaxPoints` to `0`, and then accessing the resulting tile coordinates from the `tileCoords` property of `tileIndex`.
+
+The `promoteId` and `generateId` options ignore existing `id` values on the feature objects.
+
+GeoJSON-VT only operates on zoom levels up to 24.
+
+### Update
+
+For incremental updates to the tile index, you can use `updateData` to change features without having to recreate a fresh index. `updateData` takes a diff object as a parameter with the following properties:
+
+```js
+var diff = {
+    removeAll: false,             // set to true to clear all features
+    remove: ['id1', 'id2'],       // array of feature ids to remove
+    add: [feature1, feature2],    // array of GeoJSON features to add
+    update: [                     // array of feature update objects
+        {
+            id: 'feature1',                           // required - id of feature to update
+            newGeometry: {type: 'Point', ...},        // new geometry for the feature
+            removeAllProperties: false,               // remove all properties
+            removeProperties: ['prop1', 'prop2'],     // array of property keys to remove
+            addOrUpdateProperties: [                  // array of properties to add/update
+                {key: 'name', value: 'New Name'},
+                {key: 'population', value: 5000}
+            ]
+        }
+    ]
+};
+
+tileIndex.updateData(diff);
+```
+
+All properties in the diff are optional, but at least one operation should be specified. Remove operations are applied before add/update operations.
+
+To use `updateData`, the index must be created with the `updateable: true` option.
+
+### Install
+
+Install using NPM (`npm install geojson-vt`), then:
+
+```js
+// import as a ES module
+import geojsonvt from 'geojson-vt';
+
+// import from a CDN in the browser:
+import geojsonvt from 'https://esm.run/geojson-vt';
+```
+
+Or use a browser build directly:
+
+```html
+<script src="https://unpkg.com/geojson-vt/geojson-vt.js"></script>
+```
+
+### Getting Involved
+
+Join the #maplibre slack channel at OSMUS: get an invite at https://slack.openstreetmap.us/