BoxIndex

Description

An Index for points and rectangles

A really fast static spatial index for 2D points and rectangles in JavaScript. Uses either a fast simple Hilbert curve algorithm or a more complex Hilbert curve (S2) algorithm.

This is a partial port/typescript port of the flatbush codebase.

Usage

import { BoxIndex } from 'gis-tools-ts';
import type { BoxIndexAccessor } from 'gis-tools-ts';

interface Item { minX: number; minY: number; maxX: number; maxY: number }

// define how to access the minX, minY, maxX, and maxY properties
const accessor: BoxIndexAccessor<Item> = (item: Item) => [item.minX, item.minY, item.maxX, item.maxY];
// create the index
const flatbush = new BoxIndex<Item>(items, accessor);

// make a bounding box query
const found = index.search(minX, minY, maxX, maxY);

// make a k-nearest-neighbors query
const neighborIds = index.neighbors(x, y, 5);
Copy

Links

• https://github.com/mourner/flatbush