Zoomer (ExtJFX 0.0.1 API)

java.lang.Object
- cern.extjfx.chart.XYChartPlugin<Number,Number>
- - cern.extjfx.chart.plugins.Zoomer

```
public class Zoomer
extends XYChartPlugin<Number,Number>
```
Zoom capabilities along X, Y or both axis. For every zoom-in operation the current X and Y range is remembered and restored upon following zoom-out operation.
- zoom-in - triggered on MOUSE_PRESSED event that is accepted by zoom-in filter. It shows a zooming rectangle determining the zoom window once mouse button is released.
- zoom-out - triggered on MOUSE_CLICKED event that is accepted by zoom-out filter. It restores the previous ranges on both axis.
- zoom-origin - triggered on MOUSE_CLICKED event that is accepted by zoom-origin filter. It restores the initial ranges on both axis as it was at the moment of the first zoom-in operation.
Zoomer works properly only if both X and Y axis are instances of NumericAxis.
CSS class name of the zoom rectangle: "chart-zoom-rect".

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`BooleanProperty`	`animated` When `true` zooming will be animated.
`ObjectProperty<AxisMode>`	`axisMode` The mode defining axis along which the zoom can be performed.
`ObjectProperty<Cursor>`	`dragCursor` Mouse cursor to be used during drag operation.
`ObjectProperty<Duration>`	`zoomDuration` Duration of the animated zoom (in and out).

Properties inherited from class cern.extjfx.chart.XYChartPlugin
chartPaneProperty

Field Summary

Fields
Modifier and Type	Field and Description
`static Predicate<MouseEvent>`	`DEFAULT_ZOOM_IN_MOUSE_FILTER` Default zoom-in mouse filter passing on left mouse button (only).
`static Predicate<MouseEvent>`	`DEFAULT_ZOOM_ORIGIN_MOUSE_FILTER` Default zoom-origin mouse filter passing on right mouse button with `control key down`.
`static Predicate<MouseEvent>`	`DEFAULT_ZOOM_OUT_MOUSE_FILTER` Default zoom-out mouse filter passing on right mouse button (only).
`static String`	`STYLE_CLASS_ZOOM_RECT` Name of the CCS class of the zoom rectangle.

Constructor Summary

Constructors
Constructor and Description
`Zoomer()` Creates a new instance of Zoomer with animation disabled and with `zoomMode` initialized to `AxisMode.XY`.
`Zoomer(AxisMode zoomMode)` Creates a new instance of Zoomer with animation disabled.
`Zoomer(AxisMode zoomMode, boolean animated)` Creates a new instance of Zoomer.
`Zoomer(boolean animated)` Creates a new instance of Zoomer with `zoomMode` initialized to `AxisMode.XY`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BooleanProperty`	`animatedProperty()` When `true` zooming will be animated.
`ObjectProperty<AxisMode>`	`axisModeProperty()` The mode defining axis along which the zoom can be performed.
`void`	`clear()` Clears the stack of zoom windows saved during zoom-in operations.
`ObjectProperty<Cursor>`	`dragCursorProperty()` Mouse cursor to be used during drag operation.
`AxisMode`	`getAxisMode()` Returns the value of the `axisModeProperty()`.
`Cursor`	`getDragCursor()` Returns the value of the `dragCursorProperty()`
`Duration`	`getZoomDuration()` Returns the value of the `zoomDurationProperty()`.
`Predicate<MouseEvent>`	`getZoomInMouseFilter()` Returns zoom-in mouse event filter.
`Predicate<MouseEvent>`	`getZoomOriginMouseFilter()` Returns zoom-origin mouse filter.
`Predicate<MouseEvent>`	`getZoomOutMouseFilter()` Returns zoom-out mouse filter.
`boolean`	`isAnimated()` Returns the value of the `animatedProperty()`.
`void`	`setAnimated(boolean value)` Sets the value of the `animatedProperty()`.
`void`	`setAxisMode(AxisMode mode)` Sets the value of the `axisModeProperty()`.
`void`	`setDragCursor(Cursor cursor)` Sets value of the `dragCursorProperty()`.
`void`	`setZoomDuration(Duration duration)` Sets the value of the `zoomDurationProperty()`.
`void`	`setZoomInMouseFilter(Predicate<MouseEvent> zoomInMouseFilter)` Sets filter on `DRAG_DETECTED` events that should start zoom-in operation.
`void`	`setZoomOriginMouseFilter(Predicate<MouseEvent> zoomOriginMouseFilter)` Sets filter on `MOUSE_CLICKED` events that should trigger zoom-origin operation.
`void`	`setZoomOutMouseFilter(Predicate<MouseEvent> zoomOutMouseFilter)` Sets filter on `MOUSE_CLICKED` events that should trigger zoom-out operation.
`ObjectProperty<Duration>`	`zoomDurationProperty()` Duration of the animated zoom (in and out).
`boolean`	`zoomOut()` Invokes zoom out action on chart if there was a zoom active.

Methods inherited from class cern.extjfx.chart.XYChartPlugin
chartPaneProperty, getChartChildren, getChartPane, getCharts, getLocationInPlotArea, layoutChildren, registerMouseEventHandler, setChartPane, toDataPoint, toDisplayPoint

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - axisMode
```
public final ObjectProperty<AxisMode> axisModeProperty
```
    The mode defining axis along which the zoom can be performed. By default initialized to AxisMode.XY.
    
    See Also:
    
    getAxisMode(), setAxisMode(AxisMode)
  - dragCursor
```
public final ObjectProperty<Cursor> dragCursorProperty
```
    Mouse cursor to be used during drag operation.
    
    See Also:
    
    getDragCursor(), setDragCursor(Cursor)
  - animated
```
public final BooleanProperty animatedProperty
```
    When true zooming will be animated. By default it's false.
    
    See Also:
    
    isAnimated(), setAnimated(boolean)
  - zoomDuration
```
public final ObjectProperty<Duration> zoomDurationProperty
```
    Duration of the animated zoom (in and out). Used only when animatedProperty() is set to true. By default initialized to 500ms.
    
    See Also:
    
    getZoomDuration(), setZoomDuration(Duration)
- Field Detail
  - STYLE_CLASS_ZOOM_RECT
```
public static final String STYLE_CLASS_ZOOM_RECT
```
    Name of the CCS class of the zoom rectangle.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ZOOM_IN_MOUSE_FILTER
```
public static final Predicate<MouseEvent> DEFAULT_ZOOM_IN_MOUSE_FILTER
```
    Default zoom-in mouse filter passing on left mouse button (only).
  - DEFAULT_ZOOM_OUT_MOUSE_FILTER
```
public static final Predicate<MouseEvent> DEFAULT_ZOOM_OUT_MOUSE_FILTER
```
    Default zoom-out mouse filter passing on right mouse button (only).
  - DEFAULT_ZOOM_ORIGIN_MOUSE_FILTER
```
public static final Predicate<MouseEvent> DEFAULT_ZOOM_ORIGIN_MOUSE_FILTER
```
    Default zoom-origin mouse filter passing on right mouse button with control key down.
- Constructor Detail
  - Zoomer
```
public Zoomer()
```
    Creates a new instance of Zoomer with animation disabled and with zoomMode initialized to AxisMode.XY.
  - Zoomer
```
public Zoomer(AxisMode zoomMode)
```
    Creates a new instance of Zoomer with animation disabled.
    
    Parameters:
    
    zoomMode - initial value of zoomMode property
  - Zoomer
```
public Zoomer(boolean animated)
```
    Creates a new instance of Zoomer with zoomMode initialized to AxisMode.XY.
    
    Parameters:
    
    animated - initial value of animated property
  - Zoomer
```
public Zoomer(AxisMode zoomMode,
              boolean animated)
```
    Creates a new instance of Zoomer.
    
    Parameters:
    
    zoomMode - initial value of axisMode property
    
    animated - initial value of animated property
- Method Detail
  - getZoomInMouseFilter
```
public Predicate<MouseEvent> getZoomInMouseFilter()
```
    Returns zoom-in mouse event filter.
    
    Returns:
    
    zoom-in mouse event filter
    
    See Also:
    
    setZoomInMouseFilter(Predicate)
  - setZoomInMouseFilter
```
public void setZoomInMouseFilter(Predicate<MouseEvent> zoomInMouseFilter)
```
    Sets filter on DRAG_DETECTED events that should start zoom-in operation.
    
    Parameters:
    
    zoomInMouseFilter - the filter to accept zoom-in mouse event. If null then any DRAG_DETECTED event will start zoom-in operation. By default it's set to DEFAULT_ZOOM_IN_MOUSE_FILTER.
    
    See Also:
    
    getZoomInMouseFilter()
  - getZoomOutMouseFilter
```
public Predicate<MouseEvent> getZoomOutMouseFilter()
```
    Returns zoom-out mouse filter.
    
    Returns:
    
    zoom-out mouse filter
    
    See Also:
    
    setZoomOutMouseFilter(Predicate)
  - setZoomOutMouseFilter
```
public void setZoomOutMouseFilter(Predicate<MouseEvent> zoomOutMouseFilter)
```
    Sets filter on MOUSE_CLICKED events that should trigger zoom-out operation.
    
    Parameters:
    
    zoomOutMouseFilter - the filter to accept zoom-out mouse event. If null then any MOUSE_CLICKED event will start zoom-out operation. By default it's set to DEFAULT_ZOOM_OUT_MOUSE_FILTER.
    
    See Also:
    
    getZoomOutMouseFilter()
  - getZoomOriginMouseFilter
```
public Predicate<MouseEvent> getZoomOriginMouseFilter()
```
    Returns zoom-origin mouse filter.
    
    Returns:
    
    zoom-origin mouse filter
    
    See Also:
    
    setZoomOriginMouseFilter(Predicate)
  - setZoomOriginMouseFilter
```
public void setZoomOriginMouseFilter(Predicate<MouseEvent> zoomOriginMouseFilter)
```
    Sets filter on MOUSE_CLICKED events that should trigger zoom-origin operation.
    
    Parameters:
    
    zoomOriginMouseFilter - the filter to accept zoom-origin mouse event. If null then any MOUSE_CLICKED event will start zoom-origin operation. By default it's set to DEFAULT_ZOOM_ORIGIN_MOUSE_FILTER.
    
    See Also:
    
    getZoomOriginMouseFilter()
  - axisModeProperty
```
public final ObjectProperty<AxisMode> axisModeProperty()
```
    The mode defining axis along which the zoom can be performed. By default initialized to AxisMode.XY.
    
    See Also:
    
    getAxisMode(), setAxisMode(AxisMode)
  - setAxisMode
```
public final void setAxisMode(AxisMode mode)
```
    Sets the value of the axisModeProperty().
    
    Parameters:
    
    mode - the mode to be used
  - getAxisMode
```
public final AxisMode getAxisMode()
```
    Returns the value of the axisModeProperty().
    
    Returns:
    
    current mode
  - dragCursorProperty
```
public final ObjectProperty<Cursor> dragCursorProperty()
```
    Mouse cursor to be used during drag operation.
    
    See Also:
    
    getDragCursor(), setDragCursor(Cursor)
  - setDragCursor
```
public final void setDragCursor(Cursor cursor)
```
    Sets value of the dragCursorProperty().
    
    Parameters:
    
    cursor - the cursor to be used by the plugin
  - getDragCursor
```
public final Cursor getDragCursor()
```
    Returns the value of the dragCursorProperty()
    
    Returns:
    
    the current cursor
  - animatedProperty
```
public final BooleanProperty animatedProperty()
```
    When true zooming will be animated. By default it's false.
    
    See Also:
    
    isAnimated(), setAnimated(boolean)
  - setAnimated
```
public final void setAnimated(boolean value)
```
    Sets the value of the animatedProperty().
    
    Parameters:
    
    value - if true zoom will be animated
    
    See Also:
    
    setZoomDuration(Duration)
  - isAnimated
```
public final boolean isAnimated()
```
    Returns the value of the animatedProperty().
    
    Returns:
    
    true if zoom is animated, false otherwise
    
    See Also:
    
    getZoomDuration()
  - zoomDurationProperty
```
public final ObjectProperty<Duration> zoomDurationProperty()
```
    Duration of the animated zoom (in and out). Used only when animatedProperty() is set to true. By default initialized to 500ms.
    
    See Also:
    
    getZoomDuration(), setZoomDuration(Duration)
  - setZoomDuration
```
public final void setZoomDuration(Duration duration)
```
    Sets the value of the zoomDurationProperty().
    
    Parameters:
    
    duration - duration of the zoom
  - getZoomDuration
```
public final Duration getZoomDuration()
```
    Returns the value of the zoomDurationProperty().
    
    Returns:
    
    the current zoom duration
  - zoomOut
```
public boolean zoomOut()
```
    Invokes zoom out action on chart if there was a zoom active.
    
    Returns:
    
    true if there was a zoom active and we could zoom out, false otherwise.
  - clear
```
public void clear()
```
    Clears the stack of zoom windows saved during zoom-in operations.

Class Zoomer

Property Summary

Properties inherited from class cern.extjfx.chart.XYChartPlugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class cern.extjfx.chart.XYChartPlugin

Methods inherited from class java.lang.Object

Property Detail

axisMode

dragCursor

animated

zoomDuration

Field Detail

STYLE_CLASS_ZOOM_RECT

DEFAULT_ZOOM_IN_MOUSE_FILTER

DEFAULT_ZOOM_OUT_MOUSE_FILTER

DEFAULT_ZOOM_ORIGIN_MOUSE_FILTER

Constructor Detail

Zoomer

Zoomer

Zoomer

Zoomer

Method Detail

getZoomInMouseFilter

setZoomInMouseFilter

getZoomOutMouseFilter

setZoomOutMouseFilter

getZoomOriginMouseFilter

setZoomOriginMouseFilter

axisModeProperty

setAxisMode

getAxisMode

dragCursorProperty

setDragCursor

getDragCursor

animatedProperty

setAnimated

isAnimated

zoomDurationProperty

setZoomDuration

getZoomDuration

zoomOut

clear