org.moxieapps.gwt.highcharts.client.events

Interface PointClickEventHandler

public interface PointClickEventHandler

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

 chart.setSeriesPlotOptions(new SeriesPlotOptions()
    .setPointClickEventHandler(new PointClickEventHandler() {
       public boolean onClick(PointClickEvent clickEvent) {
          Window.alert("User clicked on point: " + clickEvent.getXAsLong() + ", " + clickEvent.getYAsLong());
          return true;
       }
    )
 });
 

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

Since:

1.1.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	onClick(PointClickEvent pointClickEvent) This method is fired whenever a click event occurs on an individual point.

Method Detail

onClick

boolean onClick(PointClickEvent pointClickEvent)

This method is fired whenever a click event occurs on an individual point. See the PointClickEvent class for more details on the data available when this event is fired.

If the PlotOptions.setAllowPointSelect(boolean) option is true, the default action for the point's click event is to toggle the point's select state. Returning false cancel this action.

Parameters:

pointClickEvent - The details of the event that occurred.

Returns:

The response to send back to the event handler function. Return false to cancel the default action of selecting the point when the PlotOptions.setAllowPointSelect(boolean) option is enabled.