@types/d3-voronoi

property halfedges

halfedges: number[];

• An array of indexes into diagram.edges representing the cell’s polygon.

property site

site: VoronoiSite<T>;

• The Voronoi Site of the cell’s associated input point.

property cells

cells: Array<VoronoiCell<T> | null>;

• Array of Voronoi Cells, one per input point; a cell may be null for a coincident point.

property edges

edges: Array<VoronoiEdge<T>>;

• Array of Voronoi Edges

method find

find: (x: number, y: number, radius?: number) => VoronoiSite<T> | null;

• Return the nearest Voronoi Site to point [x, y]. If radius is specified, only sites within radius distance are considered. If no Voronoi Site can be found (within the specified radius), null is returned.

  Parameter x

  x-coordinate

  Parameter y

  y-coordinate

  Parameter radius

  Optional parameter for search radius around [x, y]

method links

links: () => Array<VoronoiLink<T>>;

• Returns the Delaunay triangulation of the specified data array as an array of links, one for each edge in the mesh. Each link has the following attributes: - source (the source node, an element in data) - target (the target node, an element in data)

  Since the triangulation is computed as the dual of the Voronoi diagram, and the Voronoi diagram is clipped by the extent, a subset of the Delaunay links is returned.

method polygons

polygons: () => Array<VoronoiPolygon<T>>;

• Return an array of polygons clipped to the extent, one for each cell in the diagram. Each polygon is represented as an array of points [x, y] where x and y are the point coordinates, and a data field that refers to the corresponding element in data. Polygons are open: they do not contain a closing point that duplicates the first point; a triangle, for example, is an array of three points. Polygons are also counterclockwise, assuming the origin ⟨0,0⟩ is in the top-left corner.

  If the cell’s site is coincident with an earlier site, the associated polygon is null.

method triangles

triangles: () => Array<VoronoiTriangle<T>>;

• Returns the Delaunay triangulation of the specified data array as an array of triangles. Each triangle is a three-element array of elements from data. Since the triangulation is computed as the dual of the Voronoi diagram, and the Voronoi diagram is clipped by the extent, a subset of the Delaunay triangulation is returned.

property left

left: VoronoiSite<T>;

• The Voronoi site on the left side of the edge.

property right

right: VoronoiSite<T> | null;

• The Voronoi site on the right side of the edge; null for a clipped border edge.

method extent

extent: {
    (): [[number, number], [number, number]] | null;
    (extent: [[number, number], [number, number]]): this;
};

• Returns the current clip extent which defaults to null.

  The extent bounds are specified as an array [[x0, y0], [x1, y1]], where x0 is the left side of the extent, y0 is the top, x1 is the right and y1 is the bottom.

  A clip extent is required when using voronoi.polygons.

• Set the clip extent of the Voronoi layout to the specified bounds and return the layout.

  A clip extent is required when using voronoi.polygons.

  Parameter extent

  The extent bounds are specified as an array [[x0, y0], [x1, y1]], where x0 is the left side of the extent, y0 is the top, x1 is the right and y1 is the bottom.

method links

links: (data: T[]) => Array<VoronoiLink<T>>;

• Return the Delaunay triangulation of the specified data array as an array of links. Each link has source and target attributes referring to elements in data.

  Parameter data

  Array of data points.

method polygons

polygons: (data: T[]) => Array<VoronoiPolygon<T>>;

• Return an array of polygons clipped to the extent, one for each input point in the specified data points, corresponding to the cells in the computed Voronoi diagram.

  Each polygon is represented as an array of points [x, y] where x and y are the point coordinates, and a data field that refers to the corresponding element in data. Polygons are open: they do not contain a closing point that duplicates the first point; a triangle, for example, is an array of three points. Polygons are also counterclockwise, assuming the origin ⟨0,0⟩ is in the top-left corner.

  If the cell’s site is coincident with an earlier site, the associated polygon is null.

  Important: Using polygon requires the extent to be set for the layout.

  Parameter data

  Array of data points.

method size

size: { (): [number, number] | null; (size: [number, number]): this };

• Get the clip size of the Voronoi layout. Size is an alias for voronoi.extent where the minimum x and y of the extent are ⟨0,0⟩.

• Set the clip size and return the layout.

  Size is an alias for voronoi.extent where the minimum x and y of the extent are ⟨0,0⟩.

  Parameter size

  An array representing the x- and y-size of the clip extent, where the minimum x and y of the extent are ⟨0,0⟩.

method triangles

triangles: (data: T[]) => Array<VoronoiTriangle<T>>;

• Return the Delaunay triangulation of the specified data array as an array of triangles. Each triangle is a three-element array of elements from data.

  Parameter data

  Array of data points.

method x

x: { (): (d: T) => number; (x: (d: T) => number): this };

• Return the current x-coordinate accessor, which defaults to accessing the first element of an array (i.e. at index 0).

• Set the x-coordinate accessor and return the layout.

  Parameter x

  An accessor function which takes a data element as input and return a numeric value for the x-coordinate.

method y

y: { (): (d: T) => number; (y: (d: T) => number): this };

• Return the current y-coordinate accessor, which defaults to accessing the second element of an array (i.e. at index 1).

• Set the y-coordinate accessor and return the layout.

  Parameter y

  An accessor function which takes a data element as input and return a numeric value for the y-coordinate.

call signature

(data: T[]): VoronoiDiagram<T>;

• Computes the Voronoi diagram for the specified data points.

  Parameter data

  Array of data elements

property source

source: T;

• The source node, an element in data.

property target

target: T;

• The target node, an element in data.

property 0

0: number;

property 1

1: number;

property 0

0: [number, number];

property 1

1: [number, number];

property data

data: T;

• The input data corresponding to this Voronoi polygon.

property data

data: T;

• The input data corresponding to this site.

property index

index: number;

• The Voronoi Site’s index, corresponding to the associated input point.