@types/d3-quadtree

What is @types/d3-quadtree?

@types/d3-quadtree provides TypeScript type definitions for the d3-quadtree module, which is part of the D3.js library. The d3-quadtree module is used for efficient spatial indexing of 2D points, allowing for fast querying of points within a given area. This is particularly useful for tasks such as collision detection, nearest neighbor search, and spatial clustering.

What are @types/d3-quadtree's main functionalities?

Creating a Quadtree

This feature allows you to create a new quadtree instance. A quadtree is a data structure that partitions a two-dimensional space by recursively subdividing it into four quadrants or regions.

const quadtree = d3.quadtree();

Adding Points to the Quadtree

This feature allows you to add a point to the quadtree. The point is specified as a two-element array [x, y], where x and y are the coordinates of the point.

quadtree.add([x, y]);

Finding the Closest Point

This feature allows you to find the closest point in the quadtree to a given point (x, y). This is useful for nearest neighbor search.

const closest = quadtree.find(x, y);

Removing Points from the Quadtree

This feature allows you to remove a point from the quadtree. The point to be removed is specified as a two-element array [x, y].

quadtree.remove([x, y]);

Querying Points within a Bounding Box

This feature allows you to query all points within a specified bounding box. The visit method is used to traverse the quadtree and collect points that fall within the bounding box.

const points = []; quadtree.visit((node, x0, y0, x1, y1) => { if (!node.length) { do { const d = node.data; if (d[0] >= x0 && d[0] < x1 && d[1] >= y0 && d[1] < y1) { points.push(d); } } while (node = node.next); } return x0 >= x1 || y0 >= y1; });

Other packages similar to @types/d3-quadtree

rbush

rbush is a high-performance JavaScript library for 2D spatial indexing of points and rectangles. It uses a R-tree data structure, which is different from the quadtree used by d3-quadtree. R-trees are generally more efficient for indexing and querying large sets of spatial data.

kdbush

kdbush is a very fast static spatial index for 2D points based on a flat KD-tree. It is designed for performance and simplicity, making it a good alternative to d3-quadtree for applications that require fast nearest neighbor searches.

geokdbush

geokdbush is a geospatial extension of kdbush, providing fast nearest neighbor searches for geographic coordinates. It is particularly useful for applications involving geographic data, such as mapping and location-based services.

README

Installation

npm install --save @types/d3-quadtree

Summary

This package contains type definitions for d3-quadtree (https://github.com/d3/d3-quadtree/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/d3-quadtree.

Additional Details

• Last updated: Wed, 22 Nov 2023 00:24:48 GMT
• Dependencies: none

Credits

These definitions were written by Tom Wanzek, Alex Ford, Boris Yankov, denisname, and Nathan Bierema.