com.googlecode.wickedcharts.highcharts.options.interaction
Class SelectionFunction

java.lang.Object
  com.googlecode.wickedcharts.highcharts.options.Function
      com.googlecode.wickedcharts.highcharts.options.interaction.SelectionFunction

All Implemented Interfaces:

IProcessableOption, Serializable

public abstract class SelectionFunction
extends Function
implements IProcessableOption

This function may be added to a ChartOptions object via Events.setSelection(Function). When the user zooms in or out of chart (i.e. when he selects a portion of the chart), a SelectionEvent is triggered and transmitted to the server. You can react to this event on the server side by implementing the onSelect(SelectionEvent) method.

Author:

Tom Hombergs (tom.hombergs@gmail.com)

See Also:

Serialized Form

Field Summary

static String

PROCESSING_KEY

Constructor Summary

SelectionFunction(Options parentOptions)

Method Summary

String	getProcessingKey()
abstract void	onSelect(SelectionEvent event) This method is called on the server side when the user selected a portion of the chart (i.e. when he zoomed in or out).

Methods inherited from class com.googlecode.wickedcharts.highcharts.options.Function

addParameter, getFunction, setFunction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROCESSING_KEY

public static final String PROCESSING_KEY

See Also:

Constant Field Values

Constructor Detail

SelectionFunction

public SelectionFunction(Options parentOptions)

Method Detail

getProcessingKey

public String getProcessingKey()

Specified by:

getProcessingKey in interface IProcessableOption

onSelect

public abstract void onSelect(SelectionEvent event)

This method is called on the server side when the user selected a portion of the chart (i.e. when he zoomed in or out).

Parameters:

event - the selection event containing some information about which portions of the chart have been selected.