d3-hilbert
v1.5.0
Published
D3 layout to visualize distance variables using a continuous Hilbert space-filling space.
Readme
d3-hilbert
D3 layout to visualize distance variables using a continuous Hilbert space-filling curve. Here's an example.
See also d3-morton.
If you are looking for a module that also performs rendering, please see hilbert-chart.
Quick start
import d3Hilbert from 'd3-hilbert';or using a script tag
<script src="//cdn.jsdelivr.net/npm/d3-hilbert"></script>then
const myRange = { start: 4, length: 9 };
d3.hilbert()
.order(2)
.layout(myRange)API reference
| Method | Description | Default |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------- | ------------- |
| canvasWidth([number]) | Getter/setter for the length of each side of the hilbert square canvas. | 1 |
| order([int]) | Getter/setter for the extent of the hilbert curve domain, determined by 4^order. Orders above 26 use BigInt distances to preserve integer precision. | 4 |
| simplifyCurves([boolean]) | Getter/setter for whether to simplify the resolution of the curve to the most canonical 2-bit boundary that fits the range integral. For example, in a 2nd order curve (16 values), a range from 4 to 11 can be simplified from 8 vertices to 2 (each filling a square with 4 values), on the lower quadrants. This simplification greatly reduces the number of vertices in the curve and improves the calculation and rendering performance, specially for high-order ranges which tend to fall on bit boundaries, such as the case of IP address routes. | true |
| layout(rangeObject) | Extends the input rangeObject (syntax: {start, length}) with 3 additional properties defining the hilbert curve: .cellWidth (number defining the side length of each square cell and essentially the thickness of the line, according to the canvasWidth), .startCell ([int,int] the x,y coordinates of the starting cell) and .pathVertices (Array of vertices, specified in terms of characters indicating movement direction: UDLR (Up, Down, Left, Right)). For orders above 26, pass BigInt or Number values for start and length; unsafe Number integers are rejected. Cell coordinates are Numbers through order 53 and BigInts for larger orders. | |
| getValAtXY(num, num) | Returns the reverse translated value on the curve domain found at coordinates x,y, relative to the canvasWidth. The result is a BigInt above order 26. | |
| getXyAtVal(num) | Returns the [x, y] cell coordinates of a value. Above order 26, value may be a BigInt or a safe integer Number; the returned coordinates are Numbers through order 53 and BigInts for larger orders. Returns null if the value is outside the boundaries of the Hilbert domain. | |
