org.moxieapps.gwt.highcharts.client.events

Interface SeriesClickEventHandler

public interface SeriesClickEventHandler

An interface that can be used as a callback handler when click events are fired on the series of a chart. General usage is as follows:

 chart.setSeriesPlotOptions(new SeriesPlotOptions()
    .setSeriesClickEventHandler(new SeriesClickEventHandler() {
       public boolean onClick(SeriesClickEvent clickEvent) {
          Window.alert("User clicked on the series near the point: " + clickEvent.getNearestPointName());
          return true;
       }
    )
 });
 

See the documentation on the ChartClickEvent class for more details on the data available when a click event occurs.

Since:

1.1.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	onClick(SeriesClickEvent seriesClickEvent) This method is fired whenever a click event occurs on a series.

Method Detail

onClick

boolean onClick(SeriesClickEvent seriesClickEvent)

This method is fired whenever a click event occurs on a series. See the SeriesClickEvent class for more details on the data available when this event is fired.

Parameters:

seriesClickEvent - The details of the event that occurred.

Returns:

The response to send back to the event handler function