Package org.pepstock.charba.client.zoom

Class ScaleLimit

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.zoom.ScaleRange

org.pepstock.charba.client.zoom.ScaleLimit

public final class ScaleLimit
extends ScaleRange

Entity of ZoomPlugin.ID configuration in order to set minimum and maximum values of the scales for pan or zoom.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
default double	getMax()	Returns the maximum value of range as double.
default double	getMin()	Returns the minimum value of range as double.
double	getMinRange()	Returns the minimum allowed range. This defines the max zoom level.
boolean	isOriginalMax()	Returns true to use whatever maximum limit the scale had when the chart was first displayed.
boolean	isOriginalMin()	Returns true to use whatever minimum limit the scale had when the chart was first displayed.
void	setMinRange(double min)	Sets the minimum allowed range. This defines the max zoom level.
void	setOriginalMax(boolean enable)	Sets true to use whatever maximum limit the scale had when the chart was first displayed.
void	setOriginalMin(boolean enable)	Sets true to use whatever minimum limit the scale had when the chart was first displayed.

Methods inherited from class org.pepstock.charba.client.zoom.ScaleRange

getMax, getMin, setMax, setMin

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Method Detail

setOriginalMin

public final void setOriginalMin(boolean enable)

Sets true to use whatever minimum limit the scale had when the chart was first displayed.

Parameters:

enable - true to use whatever minimum limit the scale had when the chart was first displayed

isOriginalMin

public final boolean isOriginalMin()

Returns true to use whatever minimum limit the scale had when the chart was first displayed.

Returns:

true to use whatever minimum limit the scale had when the chart was first displayed

setOriginalMax

public final void setOriginalMax(boolean enable)

Sets true to use whatever maximum limit the scale had when the chart was first displayed.

Parameters:

enable - true to use whatever maximum limit the scale had when the chart was first displayed

isOriginalMax

public final boolean isOriginalMax()

Returns true to use whatever maximum limit the scale had when the chart was first displayed.

Returns:

true to use whatever maximum limit the scale had when the chart was first displayed

setMinRange

public void setMinRange(double min)

Sets the minimum allowed range.
This defines the max zoom level.

Parameters:

min - the minimum allowed range.
This defines the max zoom level.

getMinRange

public double getMinRange()

Returns the minimum allowed range.
This defines the max zoom level.

Returns:

the minimum allowed range.
This defines the max zoom level.

getMin

public default double getMin()

Returns the minimum value of range as double.

Returns:

the minimum value of range as double

getMax

public default double getMax()

Returns the maximum value of range as double.

Returns:

the maximum value of range as double