org.moxieapps.gwt.highcharts.client.events
Class SeriesLegendItemClickEvent

java.lang.Object
  org.moxieapps.gwt.highcharts.client.events.MouseEvent
      org.moxieapps.gwt.highcharts.client.events.SeriesEvent
          org.moxieapps.gwt.highcharts.client.events.SeriesLegendItemClickEvent

public class SeriesLegendItemClickEvent
extends SeriesEvent

Provides access to the raw information provided by Highcharts when a user clicks on the legend item associated with a series. This class should not be instantiated directly, but instead you should create a SeriesLegendItemClickEventHandler and register it via the SeriesPlotOptions.setSeriesLegendItemClickEventHandler(SeriesLegendItemClickEventHandler) method in order to access legend item click events.

Since:

1.1.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Constructor Summary

SeriesLegendItemClickEvent(com.google.gwt.core.client.JavaScriptObject event, com.google.gwt.core.client.JavaScriptObject series)
This constructor is intended for internal use only.

Method Summary

boolean

isVisible() Returns true if the series is now visible, false if it is invisible

Methods inherited from class org.moxieapps.gwt.highcharts.client.events.SeriesEvent

getSeriesId, getSeriesName

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

Constructor Detail

SeriesLegendItemClickEvent

public SeriesLegendItemClickEvent(com.google.gwt.core.client.JavaScriptObject event,
                                  com.google.gwt.core.client.JavaScriptObject series)

This constructor is intended for internal use only. You should not create click events directly, but instead should register a SeriesLegendItemClickEventHandler.

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.

Method Detail

isVisible

public boolean isVisible()

Returns true if the series is now visible, false if it is invisible

Returns:

Whether or not the series is visible.