com.github.gwtd3.api.svg

Class Brush

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.svg.Brush

All Implemented Interfaces:

IsFunction

public class Brush
extends com.google.gwt.core.client.JavaScriptObject
implements IsFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Brush.BrushEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Brush()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	empty() Returns true if and only if the brush extent is empty.
<T> Array<T>	extent()
Brush	on(Brush.BrushEvent event, DatumFunction<Void> listener) Respond to events when the brush is moved.
Brush	x(Scale<?> scale) Set the brush’s x-scale.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Brush

protected Brush()

Method Detail

x

public final Brush x(Scale<?> scale)

Set the brush’s x-scale.

Parameters:

scale - the x-scale.

Returns:

the current brush.

on

public final Brush on(Brush.BrushEvent event,
       DatumFunction<Void> listener)

Respond to events when the brush is moved.

Brushes support three types of events:

• brushstart - on mousedown
• brush - on mousemove, if the brush extent has changed
• brushend - on mouseup

Parameters:

event - the event.

listener - the event listener.

Returns:

the current brush.

empty

public final boolean empty()

Returns true if and only if the brush extent is empty.

When a brush is created, it is initially empty; the brush may also become empty with a single click on the background without moving, or if the extent is cleared.

A brush is considered empty if it has zero-width or zero-height. When the brush is empty, its extent is not strictly defined.

Returns:

true if the brush extent is empty.

extent

public final <T> Array<T> extent()

Returns:

the brush’s extent.