org.moxieapps.gwt.highcharts.client.events
Class SeriesEvent
java.lang.Object
org.moxieapps.gwt.highcharts.client.events.MouseEvent
org.moxieapps.gwt.highcharts.client.events.SeriesEvent
- Direct Known Subclasses:
- SeriesCheckboxClickEvent, SeriesClickEvent, SeriesHideEvent, SeriesLegendItemClickEvent, SeriesMouseOutEvent, SeriesMouseOverEvent, SeriesShowEvent
public abstract class SeriesEvent
- extends MouseEvent
The base class of all events that are triggered on a series, and includes methods for accessing the general
properties of the series, such as its name or id.
- Since:
- 1.1.0
- Author:
- squinn@moxiegroup.com (Shawn Quinn)
Constructor Summary |
protected |
SeriesEvent(com.google.gwt.core.client.JavaScriptObject event,
com.google.gwt.core.client.JavaScriptObject series)
We can only be created by instantiating one of our sub classes. |
Method Summary |
String |
getSeriesId()
Retrieve the unique id of the series that received the event. |
String |
getSeriesName()
Return the name of the series that the event was received on. |
Methods inherited from class org.moxieapps.gwt.highcharts.client.events.MouseEvent |
getClientX, getClientY, getNativeButton, getNativeEvent, getRelativeX, getRelativeY, getScreenX, getScreenY, isAltKeyDown, isControlKeyDown, isMetaKeyDown, isShiftKeyDown |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SeriesEvent
protected SeriesEvent(com.google.gwt.core.client.JavaScriptObject event,
com.google.gwt.core.client.JavaScriptObject series)
- We can only be created by instantiating one of our sub classes.
- Parameters:
event
- The native javascript object containing the details of the original event that was fired.series
- The native javascript object that represents the series instance that the event was triggered on.
getSeriesId
public String getSeriesId()
- Retrieve the unique id of the series that received the event. This id can then be used
to obtain the Series instance itself via the
BaseChart.getSeries(String)
method.
- Returns:
- The unique id of the series that the event was triggered on.
getSeriesName
public String getSeriesName()
- Return the name of the series that the event was received on.
- Returns:
- The name of the series that the event was received on.
Copyright © 2015. All Rights Reserved.