com.github.gwtd3.api.scales

Class Scale<S extends Scale<S>>

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.scales.Scale<S>

Type Parameters:

S - the subclass of scale

Direct Known Subclasses:

OrdinalScale, QuantitativeScale

public abstract class Scale<S extends Scale<S>>
extends com.google.gwt.core.client.JavaScriptObject

Scales are functions that map from an input domain to an output range. There are 2 kinds of scales:

• Quantitative Scales - for continuous input domains, such as numbers.
• Ordinal Scales - for discrete input domains, such as names or categories.

Scales are an optional feature in D3; you don't have to use them, if you prefer to do the math yourself. However, using scales can greatly simplify the code needed to map a dimension of data to a visual representation.

Author:

Anthony Schiochet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Scale()

Method Summary

Methods

Modifier and Type	Method and Description
Value	apply(double d) Given a value x in the input domain, returns the corresponding value in the output range.
Value	apply(com.google.gwt.core.client.JavaScriptObject d) Given a value x in the input domain, returns the corresponding value in the output range.
Value	apply(String d) Given a value x in the input domain, returns the corresponding value in the output range.
S	copy() Returns an exact copy of this scale.
<T> Array<T>	domain() Returns the current scale's input domain.
S	domain(double... numbers) Sets the scale's input domain to the specified array of numbers.
S	domain(com.google.gwt.core.client.JavaScriptObject array) Sets the scale's input domain to the specified array.
S	domain(String... strings) Sets the scale's input domain to the specified array of strings.
<T> Array<T>	range() Return the current output range of this scale.
S	range(double... numbers) Set the scale's output range.
S	range(com.google.gwt.core.client.JavaScriptObject array) Set the scale's output range.
S	range(String... strings) Set the scale's output range.

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

Scale

protected Scale()

Method Detail

domain

public final S domain(double... numbers)

Sets the scale's input domain to the specified array of numbers.

Parameters:

numbers - the array of numbers

Returns:

the current scale

domain

public final S domain(String... strings)

Sets the scale's input domain to the specified array of strings.

Parameters:

strings - the array of strings

Returns:

the current scale

domain

public final S domain(com.google.gwt.core.client.JavaScriptObject array)

Sets the scale's input domain to the specified array.

Parameters:

strings - the array

Returns:

the current scale

domain

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

Returns the current scale's input domain.

Returns:

the current domain

range

public final S range(double... numbers)

Set the scale's output range.

Scale subclasses may interpret the output range differently. Please refer to subclass documentation.

Parameters:

numbers - the array of values.

Returns:

the current scale for chaining

range

public final S range(String... strings)

Set the scale's output range.

Scale subclasses may interpret the output range differently. Please refer to subclass documentation.

Parameters:

strings - the array of values.

Returns:

the current scale for chaining

range

public final S range(com.google.gwt.core.client.JavaScriptObject array)

Set the scale's output range.

Scale subclasses may interpret the output range differently. Please refer to subclass documentation.

Parameters:

array - the array of values.

Returns:

the current scale for chaining

range

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

Return the current output range of this scale.

Returns:

the current output range

copy

public final S copy()

Returns an exact copy of this scale.

Changes to this scale will not affect the returned scale, and vice versa.

Returns:

the copy

apply

public final Value apply(com.google.gwt.core.client.JavaScriptObject d)

Given a value x in the input domain, returns the corresponding value in the output range.

Note: some Interpolators reuse return values. For example, if the domain values are arbitrary objects, then D3#interpolateObject(JavaScriptObject, JavaScriptObject) is automatically applied and the scale reuses the returned object.

Often, the return value of a scale is immediately used to set an attribute or style, and you don’t have to worry about this; however, if you need to store the scale’s return value, use string coercion or create a copy as appropriate.

Parameters:

d - the input value

Returns:

the output value

apply

public final Value apply(double d)

Given a value x in the input domain, returns the corresponding value in the output range.

Note: some Interpolators reuse return values. For example, if the domain values are arbitrary objects, then D3#interpolateObject(JavaScriptObject, JavaScriptObject) is automatically applied and the scale reuses the returned object.

Often, the return value of a scale is immediately used to set an attribute or style, and you don’t have to worry about this; however, if you need to store the scale’s return value, use string coercion or create a copy as appropriate.

Parameters:

d - the input value

Returns:

the output value

apply

public final Value apply(String d)

Given a value x in the input domain, returns the corresponding value in the output range.

Note: some Interpolators reuse return values. For example, if the domain values are arbitrary objects, then D3#interpolateObject(JavaScriptObject, JavaScriptObject) is automatically applied and the scale reuses the returned object.

Often, the return value of a scale is immediately used to set an attribute or style, and you don’t have to worry about this; however, if you need to store the scale’s return value, use string coercion or create a copy as appropriate.

Parameters:

d - the input value

Returns:

the output value