org.moxieapps.gwt.highcharts.client.events

Interface PointLegendItemClickEventHandler

public interface PointLegendItemClickEventHandler

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

 chart.setPiePlotOptions(new PiePlotOptions()
    .setPointLegendItemClickEventHandler(new PointLegendItemClickEventHandler() {
       public boolean onClick(PointLegendItemClickEvent event) {
          Window.alert("Legend item clicked: " + event.getXAsLong() + ", " + event.getYAsLong());
          return true;
       }
    )
 });
 

See the documentation on the PointLegendItemClickEvent class for more details on the data available when a point legend item click event occurs on a pie series.

Since:

1.1.2

Author:

squinn@moxiegroup.com (Shawn Quinn)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	onClick(PointLegendItemClickEvent pointLegendItemClickEvent) This method is fired whenever a click event occurs on an individual legend item in a pie series.

Method Detail

onClick

boolean onClick(PointLegendItemClickEvent pointLegendItemClickEvent)

This method is fired whenever a click event occurs on an individual legend item in a pie series. See the PointLegendItemClickEvent class for more details on the data available when this event is fired.

Return false to prevent the selection from occurring.

Parameters:

pointLegendItemClickEvent - The details of the event that occurred.

Returns:

The response to send back to the event handler function. Return false to prevent the action.