org.moxieapps.gwt.highcharts.client.events

Interface SeriesCheckboxClickEventHandler

public interface SeriesCheckboxClickEventHandler

An interface that can be used as a callback handler when checkbox click events are fired on the series of a chart, which occurs when the checkbox next to the series' name in the legend is clicked. General usage is as follows:

 chart.setSeriesPlotOptions(new SeriesPlotOptions()
    .setSeriesCheckboxClickEventHandler(new SeriesCheckboxClickEventHandler() {
       public boolean onClick(SeriesCheckboxClickEvent clickEvent) {
          Window.alert("User clicked the checkbox state of the series: " + clickEvent.getSeriesName());
          return true;
       }
    )
 });
 

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

Since:

1.1.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Method Summary

Methods

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

Method Detail

onClick

boolean onClick(SeriesCheckboxClickEvent seriesCheckboxClickEvent)

This method is fired whenever a checkbox click event occurs on a series. See the SeriesCheckboxClickEvent class for more details on the data available when this event is fired. Return false to prevent the default action which is to toggle the select state of the series.

Parameters:

seriesCheckboxClickEvent - The details of the event that occurred.

Returns:

The response to send back to the event handler function. Return false to prevent the default action which is to toggle the select state of the series.