org.pepstock.charba.client.zoom

Class Zoom

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.zoom.AbstractConfigurationItem

org.pepstock.charba.client.zoom.Zoom

public final class Zoom
extends AbstractConfigurationItem

Base object to map zoom options for ZoomPlugin.ID plugin configuration.
It represents the container for ZOOM options.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DRAG Default drag, false.
static double	DEFAULT_SENSITIVITY Default sensitivity, 3.0.
static double	DEFAULT_SPEED Default speed, 0.1.

Fields inherited from class org.pepstock.charba.client.zoom.AbstractConfigurationItem

DEFAULT_ENABLED, DEFAULT_MODE

Method Summary

Modifier and Type	Method and Description
Drag	getDrag() Returns the customized drag-to-zoom effect or null is not set.
double	getSensitivity() Returns the minimal zoom level before actually applying zoom, on category scale.
double	getSpeed() Returns the speed of element via mouse wheel (percentage of element on a wheel event).
boolean	isDrag() Returns true to enable drag-to-zoom behavior.
void	setDrag(boolean drag) Sets true to enable drag-to-zoom behavior.
void	setDrag(Drag drag) Sets a customized drag-to-zoom effect.
void	setSensitivity(double sensitivity) Sets the minimal zoom level before actually applying zoom, on category scale.
void	setSpeed(double speed) Sets the speed of element via mouse wheel (percentage of element on a wheel event). Must be a value from 0 and 1.

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

getCompleteCallback, getMode, getModeCallback, getProgressCallback, getRangeMax, getRangeMin, isEnabled, setCompleteCallback, setEnabled, setMode, setMode, setProgressCallback

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

checkValue, empty, getArrayValue, getNativeChart, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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

Field Detail

DEFAULT_SPEED

public static final double DEFAULT_SPEED

Default speed, 0.1.

See Also:

Constant Field Values

DEFAULT_DRAG

public static final boolean DEFAULT_DRAG

Default drag, false.

See Also:

Constant Field Values

DEFAULT_SENSITIVITY

public static final double DEFAULT_SENSITIVITY

Default sensitivity, 3.0.

See Also:

Constant Field Values

Method Detail

setDrag

public void setDrag(boolean drag)

Sets true to enable drag-to-zoom behavior.

Parameters:

drag - true to enable drag-to-zoom behavior

setDrag

public void setDrag(Drag drag)

Sets a customized drag-to-zoom effect.

Parameters:

drag - a customized drag-to-zoom effect

isDrag

public boolean isDrag()

Returns true to enable drag-to-zoom behavior.

Returns:

true to enable drag-to-zoom behavior

getDrag

public Drag getDrag()

Returns the customized drag-to-zoom effect or null is not set.

Returns:

the customized drag-to-zoom effect or null is not set

setSpeed

public void setSpeed(double speed)

Sets the speed of element via mouse wheel (percentage of element on a wheel event).
Must be a value from 0 and 1.

Parameters:

speed - the speed of element via mouse wheel

getSpeed

public double getSpeed()

Returns the speed of element via mouse wheel (percentage of element on a wheel event).

Returns:

the speed of element via mouse wheel

setSensitivity

public void setSensitivity(double sensitivity)

Sets the minimal zoom level before actually applying zoom, on category scale.

Parameters:

sensitivity - the minimal zoom level before actually applying zoom, on category scale

getSensitivity

public double getSensitivity()

Returns the minimal zoom level before actually applying zoom, on category scale.

Returns:

the minimal zoom level before actually applying zoom, on category scale