com.github.gwtd3.api.svg

Class Axis

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.svg.Axis

All Implemented Interfaces:

IsFunction

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

D3’s axis component displays reference lines for Scales automatically.

This lets you focus on displaying the data, while the axis component takes care of the tedious task of drawing axes and labeled ticks.

The axis component is designed to work with D3’s QuantitativeScale, TimeScale and OrdinalScale scales.

Author:

Anthony Schiochet, citaire

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Axis.Orientation Orientation of the ticks in relation to the axis.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Axis()

Method Summary

Methods

Modifier and Type	Method and Description
Axis	apply(Selection selection) Apply the axis to a selection.
Axis	apply(Transition transition) Apply the axis to a transition.
int	innerTickSize()
Axis	innerTickSize(int innerTickSizeInPixels) Sets the inner tick size to the specified value and returns the axis.
Axis.Orientation	orient() Returns the current orientation, which defaults to Axis.Orientation.BOTTOM.
Axis	orient(Axis.Orientation o) Sets the axis orientation and returns the axis.
int	outerTickSize()
Axis	outerTickSize(int outerTickSizeInPixels) Sets the outer tick size to the specified value and returns the axis.
<S extends Scale<S>> S	scale() Return the associated scale, which defaults to a linear scale.
<S extends Scale<S>> Axis	scale(S s) Set the associated scale.
Formatter	tickFormat() Returns the current format function, which defaults to null.
Axis	tickFormat(DatumFunction<String> formatFunction) Set the function to be used to format tick values.
Axis	tickFormat(Formatter format) Override the tick formatting for labels.
int	tickPadding() Returns the current padding which defaults to 3 pixels
Axis	tickPadding(int padding) Sets the padding to the specified value in pixels and returns the axis.
Array<?>	ticks() Get the arguments that will be passed to the associated scale Scale#ticks() method to compute the tick values.
Axis	ticks(int count) Specify the argument that will be passed to the associated scale Scale#ticks() method to compute the tick values.
Axis	ticks(int count, DatumFunction<String> formatSpecifier) Same as ticks(int) but suitable for LogScale.tickFormat(int, DatumFunction).
Axis	ticks(Interval interval, int steps) Same as ticks(int) but suitable for TimeScale.ticks(Interval, int).
Axis	ticks(int count, String formatSpecifier) Same as ticks(int) but suitable for LogScale.tickFormat(int, String).
int	tickSize()
Axis	tickSize(int outerInnerTickSizeInPixels) Sets the outer and inner ticks to the specified value.
Axis	tickSize(int majorMinor, int end) Deprecated.
Axis	tickSize(int major, int minor, int end) Deprecated.
int	tickSubdivide() Deprecated. this method has no effect anymore !
Axis	tickSubdivide(int count) Deprecated. this method has no effect anymore ! use
Array<?>	tickValues() Return the currently-set tick values, which defaults to null.
Axis	tickValues(double... values) Alias for tickValues(JavaScriptObject).
Axis	tickValues(com.google.gwt.core.client.JavaScriptObject values) Specify the values to be used for ticks, rather than using the scale's automatic tick generator.
Axis	tickValues(List<?> values) Alias for tickValues(JavaScriptObject).
Axis	tickValues(String... values) * Alias for tickValues(JavaScriptObject).

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

Axis

protected Axis()

Method Detail

scale

public final <S extends Scale<S>> S scale()

Return the associated scale, which defaults to a linear scale.

Returns:

the scale.

scale

public final <S extends Scale<S>> Axis scale(S s)

Set the associated scale.

Parameters:

the - scale.

Returns:

the current axis

orient

public final Axis.Orientation orient()

Returns the current orientation, which defaults to Axis.Orientation.BOTTOM.

Returns:

the current orientation

See Also:

orient(Orientation)

orient

public final Axis orient(Axis.Orientation o)

Sets the axis orientation and returns the axis.

The orientation of an axis is the position of the ticks and their labels in relation to the axis path.

For a vertical axis, specify Axis.Orientation.LEFT or Axis.Orientation.RIGHT; for a horizontal axis, specify Axis.Orientation.TOP or Axis.Orientation.BOTTOM.

If instead you want to determine the position of the axis with respect to the plot, use the transform attribute.

Parameters:

o - the orientation

Returns:

the current axis

ticks

public final Array<?> ticks()

Get the arguments that will be passed to the associated scale Scale#ticks() method to compute the tick values.

Parameters:

count -

Returns:

the arguments

ticks

public final Axis ticks(int count)

Specify the argument that will be passed to the associated scale Scale#ticks() method to compute the tick values. This version specify the desired tick count.

The count parameter is also passed to the Scale#tickFormat(int, String) method to generate the default tick format.

This version suits for LinearScale and LogScale.

Parameters:

count - the argument to be passed to the underlying scale.

Returns:

the current axis

ticks

public final Axis ticks(int count,
         String formatSpecifier)

Same as ticks(int) but suitable for LogScale.tickFormat(int, String).

Parameters:

count - the count to be passed to the underlying scale.

formatSpecifier - the format argument to be passed to the underlying scale.

Returns:

the current axis

ticks

public final Axis ticks(int count,
         DatumFunction<String> formatSpecifier)

Same as ticks(int) but suitable for LogScale.tickFormat(int, DatumFunction).

Parameters:

count - the count to be passed to the underlying scale.

formatSpecifier - the format argument to be passed to the underlying scale.

Returns:

the current axis

ticks

public final Axis ticks(Interval interval,
         int steps)

Same as ticks(int) but suitable for TimeScale.ticks(Interval, int).

Parameters:

interval - the time interval to be passed to the underlying scale.

steps - the steps argument to be passed to the underlying scale.

Returns:

the current axis

tickSize

public final int tickSize()

Returns:

the current tick size, which defaults to 6

tickSize

public final Axis tickSize(int outerInnerTickSizeInPixels)

Sets the outer and inner ticks to the specified value.

Parameters:

outerInnerTickSizeInPixels - the tick size in pixels

Returns:

the current axis

innerTickSize

public final Axis innerTickSize(int innerTickSizeInPixels)

Sets the inner tick size to the specified value and returns the axis.

The inner tick size controls the length of the tick lines, offset from the native position of the axis.

Parameters:

innerTickSizeInPixels - the new value

Returns:

the current axis

innerTickSize

public final int innerTickSize()

Returns:

the current inner ticks size, which defaults to 6

outerTickSize

public final Axis outerTickSize(int outerTickSizeInPixels)

Sets the outer tick size to the specified value and returns the axis.

The outer tick size controls the length of the square ends of the domain path, offset from the native position of the axis.

Thus, the “outer ticks” are not actually ticks but part of the domain path, and their position is determined by the associated scale's domain extent.

Thus, outer ticks may overlap with the first or last inner tick. An outer tick size of 0 suppresses the square ends of the domain path, instead producing a straight line.

Parameters:

outerTickSizeInPixels - the new value

Returns:

the current axis

outerTickSize

public final int outerTickSize()

Returns:

the current outer ticks size, which defaults to 6

tickSize

@Deprecated
public final Axis tickSize(int majorMinor,
                       int end)

Deprecated.

Sets the major, minor and end to the given values.

Parameters:

majorMinor - the new value for major and minor ticks

end - the new end value

Returns:

the current axis

tickSize

@Deprecated
public final Axis tickSize(int major,
                       int minor,
                       int end)

Deprecated.

Sets the major, minor and end to the given values.

Parameters:

majorMinor - the new value for major and minor ticks

end - the new end value

Returns:

the current axis

tickSubdivide

@Deprecated
public final int tickSubdivide()

Deprecated. this method has no effect anymore !

Get the tick subdivision count, which defaults to zero.

Returns:

the tick subdivision count

tickSubdivide

@Deprecated
public final Axis tickSubdivide(int count)

Deprecated. this method has no effect anymore ! use

Set the tick subdivision count and returns the axis.

Sets the number of uniform subdivision ticks to make between major tick marks. The specified count specifies the number of minor ticks, which is one less than the number of subdivisions.

For example, axis.tickSubdivide(1) produces one minor tick per major tick, thus cutting the space between each major tick in two. As another example, decimal subdivision is specified as axis.tickSubdivide(9).

Parameters:

count - the tick subdivision count

Returns:

the current axis

tickPadding

public final int tickPadding()

Returns the current padding which defaults to 3 pixels

Returns:

the current padding

tickPadding

public final Axis tickPadding(int padding)

Sets the padding to the specified value in pixels and returns the axis.

Parameters:

padding - the padding in pixels

Returns:

the current axis

apply

public final Axis apply(Selection selection)

Apply the axis to a selection.

The selection must contain an SVG or G element.

Parameters:

selection - the selection to apply the axis to

Returns:

the current axis.

apply

public final Axis apply(Transition transition)

Apply the axis to a transition.

The transition must contain an SVG or G element.

Parameters:

transition - the transition to apply the axis to

Returns:

the current axis.

tickFormat

public final Axis tickFormat(Formatter format)

Override the tick formatting for labels.

Parameters:

format - the tick value formatter for labels.

Returns:

the current axis.

tickFormat

public final Axis tickFormat(DatumFunction<String> formatFunction)

Set the function to be used to format tick values.

This method can be used for example to add prefix or suffix to the result of a Formatter.format(double) method.

Note: the given function of context argument will be null instance, and the index will be -1.

Parameters:

formatFunction - the function converting each tick value to a String.

Returns:

the current Axis

tickFormat

public final Formatter tickFormat()

Returns the current format function, which defaults to null. A null format indicates that the Scale's default formatter should be used, which is generated by calling Scale#tickFormat(int). In this case, the arguments specified by ticks are likewise passed to scale tickFormat.

Parameters:

format - the tick value formatter for labels.

Returns:

the current axis.

tickValues

public final Array<?> tickValues()

Return the currently-set tick values, which defaults to null.

Returns:

the currently-set tick values

tickValues

public final Axis tickValues(com.google.gwt.core.client.JavaScriptObject values)

Specify the values to be used for ticks, rather than using the scale's automatic tick generator.

If values is null, clears any previously-set explicit tick values, reverting back to the scale's tick generator.

The explicit tick values take precedent over the tick arguments set by axis.ticks. However, any tick arguments will still be passed to the scale's tickFormat function if a tick format is not also set; thus, it may be valid to set both axis.ticks and axis.tickValues.

Parameters:

values - the values to be used for ticks

Returns:

the current axis

tickValues

public final Axis tickValues(double... values)

Alias for tickValues(JavaScriptObject).

Parameters:

values - the values

Returns:

the current axis

tickValues

public final Axis tickValues(String... values)

* Alias for tickValues(JavaScriptObject).

Parameters:

values - the values

Returns:

the current axis

tickValues

public final Axis tickValues(List<?> values)

Alias for tickValues(JavaScriptObject).

Parameters:

values - the values

Returns:

the current axis