org.moxieapps.gwt.highcharts.client.labels

Class AxisLabelsData

java.lang.Object

org.moxieapps.gwt.highcharts.client.labels.AxisLabelsData

public class AxisLabelsData
extends Object

An object that represents the state information that will be passed to any custom AxisLabelsFormatter to allow for custom strings to be rendered as the labels on an axis. See the AxisLabelsFormatter.format(AxisLabelsData) method for more details on the capabilities that custom formatters can provide.

Since:

1.0.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Constructor Summary

Constructors

Constructor and Description
AxisLabelsData(com.google.gwt.core.client.JavaScriptObject data) This constructor needs to be public scope but you should not construct this object directly, but instead simply implement a custom AxisLabelsFormatter and this API will pass you the appropriate instance of this object at runtime.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.core.client.JavaScriptObject	getNativeData() Returns a pointer to the native Highchart's instance data object that this GWT instance is wrapping.
double	getValueAsDouble() Return the value of the label as a double.
long	getValueAsLong() Return the value of the label as a long.
String	getValueAsString() Return the value of the label as a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AxisLabelsData

public AxisLabelsData(com.google.gwt.core.client.JavaScriptObject data)

This constructor needs to be public scope but you should not construct this object directly, but instead simply implement a custom AxisLabelsFormatter and this API will pass you the appropriate instance of this object at runtime.

Parameters:

data - A reference to the native Highcharts javascript object.

Method Detail

getValueAsDouble

public double getValueAsDouble()

Return the value of the label as a double. An exception will be thrown if the native value of the object is not a number.

Returns:

The value of the label as a double.

getValueAsLong

public long getValueAsLong()

Return the value of the label as a long. An exception will be thrown if the native value of the object is not a number.

Returns:

The value of the label as a long.

getValueAsString

public String getValueAsString()

Return the value of the label as a string. An exception will be thrown if the native value of the object is not a string.

Returns:

The value of the label as a string.

getNativeData

public com.google.gwt.core.client.JavaScriptObject getNativeData()

Returns a pointer to the native Highchart's instance data object that this GWT instance is wrapping. For advanced JSNI use-cases only.

Returns:

The native Highcharts object instance that this GWT instance is associated with.

Since:

1.5.0