org.moxieapps.gwt.highcharts.client.events

Class ChartSelectionEvent

java.lang.Object

org.moxieapps.gwt.highcharts.client.events.MouseEvent

org.moxieapps.gwt.highcharts.client.events.ChartSelectionEvent

public class ChartSelectionEvent
extends MouseEvent

Provides access to the raw information provided by Highcharts when a user selects a portion of the chart, including the axis values of the selection. This class should not be instantiated directly, but instead you should create a ChartSelectionEventHandler and register it via the BaseChart.setSelectionEventHandler(ChartSelectionEventHandler) method in order to access selection events.

Since:

1.1.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Constructor Summary

Constructors

Constructor and Description
ChartSelectionEvent(com.google.gwt.core.client.JavaScriptObject event) This constructor is intended for internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
double	getXAxisMax() Return the maximum value of the selection range of the first X axis.
double	getXAxisMax(int axisIndex) Return the maximum value of the selection range on the requested X axis.
long	getXAxisMaxAsLong() Return the maximum value of the selection range of the first X axis, converting the value to a long value first.
long	getXAxisMaxAsLong(int axisIndex) Return the maximum value of the selection range on the requested X axis, converting the value to a long value first.
double	getXAxisMin() Return the minimum value of the selection range of the first X axis.
double	getXAxisMin(int axisIndex) Return the minimum value of the selection range on the requested X axis.
long	getXAxisMinAsLong() Return the minimum value of the selection range of the first X axis, converting the value to a long value first.
long	getXAxisMinAsLong(int axisIndex) Return the minimum value of the selection range on the requested X axis, converting the value to a long value first.
double	getYAxisMax() Return the maximum value of the selection range of the first Y axis.
double	getYAxisMax(int axisIndex) Return the maximum value of the selection range on the requested Y axis.
long	getYAxisMaxAsLong() Return the maximum value of the selection range of the first Y axis, converting the value to a long value first.
long	getYAxisMaxAsLong(int axisIndex) Return the maximum value of the selection range on the requested Y axis, converting the value to a long value first.
double	getYAxisMin() Return the minimum value of the selection range of the first Y axis.
double	getYAxisMin(int axisIndex) Return the minimum value of the selection range on the requested Y axis.
long	getYAxisMinAsLong() Return the minimum value of the selection range of the first Y axis, converting the value to a long value first.
long	getYAxisMinAsLong(int axisIndex) Return the minimum value of the selection range on the requested Y axis, converting the value to a long value first.

Methods inherited from class org.moxieapps.gwt.highcharts.client.events.MouseEvent

getClientX, getClientY, getNativeButton, getNativeEvent, getRelativeX, getRelativeY, getScreenX, getScreenY, isAltKeyDown, isControlKeyDown, isMetaKeyDown, isShiftKeyDown

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartSelectionEvent

public ChartSelectionEvent(com.google.gwt.core.client.JavaScriptObject event)

This constructor is intended for internal use only. You should not create selection events directly, but instead should register a ChartSelectionEventHandler.

Parameters:

event - The native javascript object containing the details of the original event that was fired.

Method Detail

getXAxisMin

public double getXAxisMin()

Return the minimum value of the selection range of the first X axis. See the getXAxisMin(int) method if you need the value of a different X axis.

Returns:

The minimum value of the selected range on the first X axis.

getXAxisMinAsLong

public long getXAxisMinAsLong()

Return the minimum value of the selection range of the first X axis, converting the value to a long value first. See the getXAxisMinAsLong(int) method if you need the value of a different X axis, or the getXAxisMin() method if you need a floating point value instead.

Returns:

The minimum value of the selected range on the first X axis, as a long.

getXAxisMin

public double getXAxisMin(int axisIndex)

Return the minimum value of the selection range on the requested X axis. Will throw an exception if the given axis index is invalid.

Parameters:

axisIndex - The index (zero based) of the X axis for which you'd like to retrieve the minimum value of the selection event.

Returns:

The minimum value of the selection range on the requested X axis.

getXAxisMinAsLong

public long getXAxisMinAsLong(int axisIndex)

Return the minimum value of the selection range on the requested X axis, converting the value to a long value first. Will throw an exception if the given axis index is invalid.

Parameters:

axisIndex - The index (zero based) of the X axis for which you'd like to retrieve the minimum value of the selection event.

Returns:

The minimum value of the selection range on the requested X axis, as a long.

getXAxisMax

public double getXAxisMax()

Return the maximum value of the selection range of the first X axis. See the getXAxisMax(int) method if you need the value of a different X axis.

Returns:

The maximum value of the selected range on the first X axis.

getXAxisMaxAsLong

public long getXAxisMaxAsLong()

Return the maximum value of the selection range of the first X axis, converting the value to a long value first. See the getXAxisMaxAsLong(int) method if you need the value of a different X axis, or the getXAxisMax() method if you need a floating point value instead.

Returns:

The maximum value of the selected range on the first X axis, as a long.

getXAxisMax

public double getXAxisMax(int axisIndex)

Return the maximum value of the selection range on the requested X axis. Will throw an exception if the given axis index is invalid.

Parameters:

axisIndex - The index (zero based) of the X axis for which you'd like to retrieve the maximum value of the selection event.

Returns:

The maximum value of the selection range on the requested X axis.

getXAxisMaxAsLong

public long getXAxisMaxAsLong(int axisIndex)

Return the maximum value of the selection range on the requested X axis, converting the value to a long value first. Will throw an exception if the given axis index is invalid.

Parameters:

axisIndex - The index (zero based) of the X axis for which you'd like to retrieve the maximum value of the selection event.

Returns:

The maximum value of the selection range on the requested X axis, as a long.

getYAxisMin

public double getYAxisMin()

Return the minimum value of the selection range of the first Y axis. See the getYAxisMin(int) method if you need the value of a different Y axis.

Returns:

The minimum value of the selected range on the first Y axis.

getYAxisMinAsLong

public long getYAxisMinAsLong()

Return the minimum value of the selection range of the first Y axis, converting the value to a long value first. See the getYAxisMinAsLong(int) method if you need the value of a different Y axis, or the getYAxisMin() method if you need a floating point value instead.

Returns:

The minimum value of the selected range on the first Y axis, as a long.

getYAxisMin

public double getYAxisMin(int axisIndex)

Return the minimum value of the selection range on the requested Y axis. Will throw an exception if the given axis index is invalid.

Parameters:

axisIndex - The index (zero based) of the Y axis for which you'd like to retrieve the minimum value of the selection event.

Returns:

The minimum value of the selection range on the requested Y axis.

getYAxisMinAsLong

public long getYAxisMinAsLong(int axisIndex)

Return the minimum value of the selection range on the requested Y axis, converting the value to a long value first. Will throw an exception if the given axis index is invalid.

Parameters:

axisIndex - The index (zero based) of the Y axis for which you'd like to retrieve the minimum value of the selection event.

Returns:

The minimum value of the selection range on the requested Y axis, as a long.

getYAxisMax

public double getYAxisMax()

Return the maximum value of the selection range of the first Y axis. See the getYAxisMax(int) method if you need the value of a different Y axis.

Returns:

The maximum value of the selected range on the first Y axis.

getYAxisMaxAsLong

public long getYAxisMaxAsLong()

Return the maximum value of the selection range of the first Y axis, converting the value to a long value first. See the getYAxisMaxAsLong(int) method if you need the value of a different Y axis, or the getYAxisMax() method if you need a floating point value instead.

Returns:

The maximum value of the selected range on the first Y axis, as a long.

getYAxisMax

public double getYAxisMax(int axisIndex)

Return the maximum value of the selection range on the requested Y axis. Will throw an exception if the given axis index is invalid.

Parameters:

axisIndex - The index (zero based) of the Y axis for which you'd like to retrieve the maximum value of the selection event.

Returns:

The maximum value of the selection range on the requested Y axis.

getYAxisMaxAsLong

public long getYAxisMaxAsLong(int axisIndex)

Return the maximum value of the selection range on the requested Y axis, converting the value to a long value first. Will throw an exception if the given axis index is invalid.

Parameters:

axisIndex - The index (zero based) of the Y axis for which you'd like to retrieve the maximum value of the selection event.

Returns:

The maximum value of the selection range on the requested Y axis, as a long.