org.moxieapps.gwt.highcharts.client

Class Extremes

java.lang.Object

org.moxieapps.gwt.highcharts.client.Extremes

public class Extremes
extends Object

A simple value object that is used to report the current extremes of an axis whenever the Axis.getExtremes() method is invoked (normally after the chart has been rendered).

Since:

1.0.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

Method Summary

Methods

Modifier and Type	Method and Description
Number	getDataMax() Return the maximum value of the axis' associated series, or null if the extremes are requested before the chart has been rendered.
Number	getDataMin() Return the minimum value of the axis' associated series, or null if the extremes are requested before the chart has been rendered.
Number	getMax() Return the maximum axis value, either automatic or set manually.
Number	getMin() Return the minimum axis value, either automatic or set manually.

Methods inherited from class java.lang.Object

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

Method Detail

getDataMin

public Number getDataMin()

Return the minimum value of the axis' associated series, or null if the extremes are requested before the chart has been rendered.

Returns:

The maximum value of the axis' associated series.

getDataMax

public Number getDataMax()

Return the maximum value of the axis' associated series, or null if the extremes are requested before the chart has been rendered.

Returns:

The maximum value of the axis' associated series.

getMin

public Number getMin()

Return the minimum axis value, either automatic or set manually. If the max option is not set and minPadding is 0, this value will be the same as getDataMin(). Will return null if the extremes are requested before the chart has been rendered and no manual minimum has been set via Axis.setMin(Number).

Returns:

The minimum axis value, either automatic or set manually.

getMax

public Number getMax()

Return the maximum axis value, either automatic or set manually. If the max option is not set and maxPadding is 0, this value will be the same as getDataMax(). Will return null if the extremes are requested before the chart has been rendered and no manual maximum has been set via Axis.setMax(Number).

Returns:

The maximum axis value, either automatic or set manually.