com.github.gwtd3.api.geom

Class Voronoi

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.geom.Voronoi

public class Voronoi
extends com.google.gwt.core.client.JavaScriptObject

Voronoi layouts are particularly useful for invisible interactive regions, as demonstrated in Nate Vack’s Voronoi picking example. See Tovi Grossman’s paper on bubble cursors for a related concept.

Author:

anthomi

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Voronoi()

Method Summary

Methods

Modifier and Type	Method and Description
<T> Array<T>	apply(Array<T> vertices) Returns an array of polygons, one for each input vertex in the specified data array.
Voronoi	clearClipExtent() Clear the extent clipping.
Array<Array<Double>>	clipExtent() Get the current clip extent which defaults to null.
Voronoi	clipExtent(int x0, int y0, int x1, int y1) Sets the clip extent of the Voronoi layout to the specified bounds and returns the layout.
Array<Link>	links(Array<?> nodes) TODO: make a demo from http://bl.ocks.org/mbostock/1073373 TODO: documentation
Array<Link>	triangles(Array<?> nodes) TODO: make a demo from http://bl.ocks.org/mbostock/1073373 TODO: documentation
Voronoi	x(DatumFunction<Double> xAccessor) Sets the x-coordinate accessor.
Voronoi	y(DatumFunction<Double> yAccessor) Sets the y-coordinate accessor.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Voronoi

protected Voronoi()

Method Detail

clipExtent

public final Voronoi clipExtent(int x0,
                 int y0,
                 int x1,
                 int y1)

Sets the clip extent of the Voronoi layout to the specified bounds and returns the layout.

Use of a clip extent is strongly recommended, as unclipped polygons may have large coordinates which do not display correctly.

Alternatively, you can also employ custom clipping without specifying a size, either in SVG or by post-processing with Polygon.clip(Array).

To clear the clipping, see clearClipExtent()

Parameters:

x0 - the left side of the extent

y0 - the top side of the extent

x1 - the right side of the extent

y1 - the bottom side of the extent

Returns:

the current layout

clearClipExtent

public final Voronoi clearClipExtent()

Clear the extent clipping.

Returns:

clipExtent

public final Array<Array<Double>> clipExtent()

Get the current clip extent which defaults to null.

Returns:

the current clip extent which defaults to null.

apply

public final <T> Array<T> apply(Array<T> vertices)

Returns an array of polygons, one for each input vertex in the specified data array.

If any vertices are coincident or have NaN positions, the behavior of this method is undefined: most likely, invalid polygons will be returned! You should filter invalid vertices, and consolidate coincident vertices, before computing the tessellation.

Parameters:

vertices - the array of vertices

Returns:

the array of polygons

x

public final Voronoi x(DatumFunction<Double> xAccessor)

Sets the x-coordinate accessor.

The default accessor consider datum as a two element array and returns the first element.

Parameters:

xAccessor - the x accessor

Returns:

the current layout

y

public final Voronoi y(DatumFunction<Double> yAccessor)

Sets the y-coordinate accessor.

The default accessor consider datum as a two element array and returns the first element.

Parameters:

yAccessor - the y accessor

Returns:

the current layout

links

public final Array<Link> links(Array<?> nodes)

TODO: make a demo from http://bl.ocks.org/mbostock/1073373 TODO: documentation

Returns:

triangles

public final Array<Link> triangles(Array<?> nodes)

TODO: make a demo from http://bl.ocks.org/mbostock/1073373 TODO: documentation

Returns: