org.moxieapps.gwt.highcharts.client.labels

Class StackLabelsData

java.lang.Object

org.moxieapps.gwt.highcharts.client.labels.StackLabelsData

public class StackLabelsData
extends Object

An object that represents the state information that will be passed to any custom StackLabelsFormatter to allow for custom strings to be rendered as the stack labels on a Y axis. See the StackLabelsFormatter.format(StackLabelsData) 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
StackLabelsData(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 StackLabelsFormatter 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	getTotal() Return the total value at this point's x value.
long	getTotalAsLong() Return the total value at this point's x value as a long.

Methods inherited from class java.lang.Object

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

Constructor Detail

StackLabelsData

public StackLabelsData(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 StackLabelsFormatter 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

getTotal

public double getTotal()

Return the total value at this point's x value. Stacked series only.

Returns:

The total value at this point's x value (only applicable in stacked series).

getTotalAsLong

public long getTotalAsLong()

Return the total value at this point's x value as a long. Stacked series only.

Returns:

Return the total value at this point's x value as a long.

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