|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.moxieapps.gwt.highcharts.client.labels.DataLabelsData
public class DataLabelsData
An object that represents the state information that will be passed to any custom
DataLabelsFormatter
to allow for custom strings to be rendered as the data labels of a series.
See the DataLabelsFormatter.format(DataLabelsData)
method for more details on the capabilities
that custom formatters can provide.
Constructor Summary | |
---|---|
DataLabelsData(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 DataLabelsFormatter and this API will pass you the
appropriate instance of this object at runtime. |
Method Summary | |
---|---|
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 |
getPercentage()
Return the point's percentage of the total. |
Point |
getPoint()
Create a new GWT point instance that is connected to the Highcharts JS point instance associated with this data label. |
String |
getPointName()
Return the name of the point (e.g. |
String |
getSeriesName()
Return the name of the series that the data label is a part of (e.g. |
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. |
double |
getXAsDouble()
Return the x value of the point as a double. |
long |
getXAsLong()
Return the x value of the point as a long. |
String |
getXAsString()
Return the x value of the point as a string. |
double |
getYAsDouble()
Return the y value of the point as a double. |
long |
getYAsLong()
Return the y value of the point as a long. |
String |
getYAsString()
Return the y value of the point as a string. |
boolean |
hasXValue()
Returns 'true' if the X value associated with this data label is non null. |
boolean |
hasYValue()
Returns 'true' if the Y value associated with this data label is non null. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DataLabelsData(com.google.gwt.core.client.JavaScriptObject data)
DataLabelsFormatter
and this API will pass you the
appropriate instance of this object at runtime.
data
- A reference to the native Highcharts javascript object.Method Detail |
---|
public double getPercentage()
public String getSeriesName()
public String getPointName()
public Point getPoint()
public double getTotal()
public long getTotalAsLong()
public boolean hasXValue()
public double getXAsDouble()
public long getXAsLong()
public String getXAsString()
public boolean hasYValue()
public double getYAsDouble()
public long getYAsLong()
public String getYAsString()
public com.google.gwt.core.client.JavaScriptObject getNativeData()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |