Skip to main content

Interface: Binner

Defined in: packages/sdvplot/src/bins/squarebin.ts:25

One lattice, either shape.

Properties​

lattice​

readonly lattice: Lattice

Defined in: packages/sdvplot/src/bins/squarebin.ts:31

The resolved options: { radius } for hexagons, { shape: "square", side } for squares.

shape​

readonly shape: BinShape

Defined in: packages/sdvplot/src/bins/squarebin.ts:27

"hex" or "square".

size​

readonly size: number

Defined in: packages/sdvplot/src/bins/squarebin.ts:29

The full cell size in the points' units: the hexagon's circumradius, or the square's side.

Methods​

bins()​

bins<T>(points, o): BinOf<T>[]

Defined in: packages/sdvplot/src/bins/squarebin.ts:33

Bin points (hexbin or squarebin).

Type Parameters​

T​

T

Parameters​

points​

readonly T[]

o​
x​

(p) => number

y​

(p) => number

Returns​

BinOf<T>[]

cell()​

cell(s?): string

Defined in: packages/sdvplot/src/bins/squarebin.ts:35

An SVG path for one cell of size s (default size) centred on the current point.

Parameters​

s?​

number

Returns​

string