Zoomer (chartfx-chart 8.1.0 API)

java.lang.Object
- de.gsi.chart.plugins.ChartPlugin
- - de.gsi.chart.plugins.Zoomer

```
public class Zoomer
extends ChartPlugin
```
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.
CSS class name of the zoom rectangle: "chart-zoom-rect".
Author:

Grzegorz Kruk, rstein - adapted to XYChartPane, corrected some features (mouse zoom events outside canvas, auto-ranging on zoom-out, scrolling, toolbar)

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.
`BooleanProperty`	`pannerEnabled` When `true` pressing the middle mouse button and dragging pans the plot
`BooleanProperty`	`sliderVisible` When `true` an additional horizontal range slider is shown in a HiddeSidesPane at the bottom.
`BooleanProperty`	`updateTickUnit` When `true` zooming will be animated.
`ObjectProperty<Cursor>`	`zoomCursor` Mouse cursor to be used during zoom operation.
`ObjectProperty<Duration>`	`zoomDuration` Duration of the animated zoom (in and out).

Properties inherited from class de.gsi.chart.plugins.ChartPlugin
addButtonsToToolBarProperty, chartProperty

Field Summary

Fields
Modifier and Type	Field and Description
`static Predicate<MouseEvent>`	`DEFAULT_MOUSE_FILTER` Default pan mouse filter passing on left mouse button with `control key down`.
`Predicate<ScrollEvent>`	`defaultScrollFilter` Default zoom scroll filter with `control key down`.
`Predicate<MouseEvent>`	`defaultZoomInMouseFilter` Default zoom-in mouse filter passing on left mouse button (only).
`Predicate<MouseEvent>`	`defaultZoomOriginFilter` Default zoom-origin mouse filter passing on right mouse button with `control key down`.
`Predicate<MouseEvent>`	`defaultZoomOutMouseFilter` Default zoom-out mouse filter passing on right mouse button (only).
`static String`	`STYLE_CLASS_ZOOM_RECT`
`static String`	`ZOOMER_OMIT_AXIS`

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 Static 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.
`void`	`clear(Axis axis)` Clears the stack of zoom states saved during zoom-in operations for a specific given axis.
`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()`
`org.controlsfx.control.RangeSlider`	`getRangeSlider()`
`Cursor`	`getZoomCursor()` Returns the value of the `zoomCursorProperty()`
`Duration`	`getZoomDuration()` Returns the value of the `zoomDurationProperty()`.
`Predicate<MouseEvent>`	`getZoomInMouseFilter()` Returns zoom-in mouse event filter.
`HBox`	`getZoomInteractorBar()`
`Predicate<MouseEvent>`	`getZoomOriginMouseFilter()` Returns zoom-origin mouse filter.
`Predicate<MouseEvent>`	`getZoomOutMouseFilter()` Returns zoom-out mouse filter.
`Predicate<ScrollEvent>`	`getZoomScrollFilter()` Returns zoom-scroll filter.
`boolean`	`isAnimated()` Returns the value of the `animatedProperty()`.
`static boolean`	`isOmitZoom(Axis axis)`
`boolean`	`isPannerEnabled()` Gets the value of the property pannerEnabled.
`boolean`	`isSliderVisible()` Returns the value of the `sliderVisibleProperty()`.
`boolean`	`isUpdateTickUnit()` Returns the value of the `animatedProperty()`.
`ObservableList<Axis>`	`omitAxisZoomList()`
`BooleanProperty`	`pannerEnabledProperty()` When `true` pressing the middle mouse button and dragging pans the plot
`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()`.
`static void`	`setOmitZoom(Axis axis, boolean state)`
`void`	`setPannerEnabled(boolean state)` Sets the value of the `sliderVisibleProperty()`.
`void`	`setSliderVisible(boolean state)` Sets the value of the `sliderVisibleProperty()`.
`void`	`setUpdateTickUnit(boolean value)` Sets the value of the `animatedProperty()`.
`void`	`setZoomCursor(Cursor cursor)` Sets value of the `zoomCursorProperty()`.
`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.
`void`	`setZoomScrollFilter(Predicate<ScrollEvent> zoomScrollFilter)` Sets filter on `MOUSE_CLICKED` events that should trigger zoom-origin operation.
`BooleanProperty`	`sliderVisibleProperty()` When `true` an additional horizontal range slider is shown in a HiddeSidesPane at the bottom.
`BooleanProperty`	`updateTickUnitProperty()` When `true` zooming will be animated.
`ObjectProperty<Cursor>`	`zoomCursorProperty()` Mouse cursor to be used during zoom operation.
`ObjectProperty<Duration>`	`zoomDurationProperty()` Duration of the animated zoom (in and out).
`boolean`	`zoomOrigin()`

Methods inherited from class de.gsi.chart.plugins.ChartPlugin
addButtonsToToolBarProperty, chartProperty, getChart, getChartChildren, getLocationInPlotArea, isAddButtonsToToolBar, layoutChildren, registerInputEventHandler, setAddButtonsToToolBar, setChart, toDataPoint, toDisplayPoint

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

- Property Detail
  - animated
```
public final BooleanProperty animatedProperty
```
    When true zooming will be animated. By default it's false.
    
    See Also:
    
    isAnimated(), setAnimated(boolean)
  - axisMode
```
public final ObjectProperty<AxisMode> axisModeProperty
```
    The mode defining axis along which the zoom can be performed. By default initialised 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)
  - pannerEnabled
```
public final BooleanProperty pannerEnabledProperty
```
    When true pressing the middle mouse button and dragging pans the plot
    
    See Also:
    
    isPannerEnabled(), setPannerEnabled(boolean)
  - sliderVisible
```
public final BooleanProperty sliderVisibleProperty
```
    When true an additional horizontal range slider is shown in a HiddeSidesPane at the bottom. By default it's true.
    
    See Also:
    
    isSliderVisible(), setSliderVisible(boolean)
  - updateTickUnit
```
public final BooleanProperty updateTickUnitProperty
```
    When true zooming will be animated. By default it's false.
    
    See Also:
    
    isUpdateTickUnit(), setUpdateTickUnit(boolean)
  - zoomCursor
```
public final ObjectProperty<Cursor> zoomCursorProperty
```
    Mouse cursor to be used during zoom operation.
    
    See Also:
    
    getZoomCursor(), setZoomCursor(Cursor)
  - zoomDuration
```
public final ObjectProperty<Duration> zoomDurationProperty
```
    Duration of the animated zoom (in and out). Used only when animatedProperty() is set to true. By default initialised to 500ms.
    
    See Also:
    
    getZoomDuration(), setZoomDuration(Duration)
- Field Detail
  - ZOOMER_OMIT_AXIS
```
public static final String ZOOMER_OMIT_AXIS
```
    See Also:
    
    Constant Field Values
  - STYLE_CLASS_ZOOM_RECT
```
public static final String STYLE_CLASS_ZOOM_RECT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MOUSE_FILTER
```
public static final Predicate<MouseEvent> DEFAULT_MOUSE_FILTER
```
    Default pan mouse filter passing on left mouse button with control key down.
  - defaultZoomInMouseFilter
```
public final Predicate<MouseEvent> defaultZoomInMouseFilter
```
    Default zoom-in mouse filter passing on left mouse button (only).
  - defaultZoomOutMouseFilter
```
public final Predicate<MouseEvent> defaultZoomOutMouseFilter
```
    Default zoom-out mouse filter passing on right mouse button (only).
  - defaultZoomOriginFilter
```
public final Predicate<MouseEvent> defaultZoomOriginFilter
```
    Default zoom-origin mouse filter passing on right mouse button with control key down.
  - defaultScrollFilter
```
public final Predicate<ScrollEvent> defaultScrollFilter
```
    Default zoom scroll filter 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(AxisMode zoomMode,
              boolean animated)
```
    Creates a new instance of Zoomer.
    
    Parameters:
    
    zoomMode - initial value of axisMode property
    
    animated - initial value of animated 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
- Method Detail
  - animatedProperty
```
public final BooleanProperty animatedProperty()
```
    When true zooming will be animated. By default it's false.
    
    See Also:
    
    isAnimated(), setAnimated(boolean)
  - axisModeProperty
```
public final ObjectProperty<AxisMode> axisModeProperty()
```
    The mode defining axis along which the zoom can be performed. By default initialised to AxisMode.XY.
    
    See Also:
    
    getAxisMode(), setAxisMode(AxisMode)
  - clear
```
public void clear()
```
    Clears the stack of zoom windows saved during zoom-in operations.
  - clear
```
public void clear(Axis axis)
```
    Clears the stack of zoom states saved during zoom-in operations for a specific given axis.
    
    Parameters:
    
    axis - axis zoom history that shall be removed
  - dragCursorProperty
```
public final ObjectProperty<Cursor> dragCursorProperty()
```
    Mouse cursor to be used during drag operation.
    
    See Also:
    
    getDragCursor(), setDragCursor(Cursor)
  - getAxisMode
```
public final AxisMode getAxisMode()
```
    Returns the value of the axisModeProperty().
    
    Returns:
    
    current mode
  - getDragCursor
```
public final Cursor getDragCursor()
```
    Returns the value of the dragCursorProperty()
    
    Returns:
    
    the current cursor
  - getRangeSlider
```
public org.controlsfx.control.RangeSlider getRangeSlider()
```
  - getZoomCursor
```
public final Cursor getZoomCursor()
```
    Returns the value of the zoomCursorProperty()
    
    Returns:
    
    the current cursor
  - getZoomDuration
```
public final Duration getZoomDuration()
```
    Returns the value of the zoomDurationProperty().
    
    Returns:
    
    the current zoom duration
  - getZoomInMouseFilter
```
public Predicate<MouseEvent> getZoomInMouseFilter()
```
    Returns zoom-in mouse event filter.
    
    Returns:
    
    zoom-in mouse event filter
    
    See Also:
    
    setZoomInMouseFilter(Predicate)
  - getZoomInteractorBar
```
public HBox getZoomInteractorBar()
```
  - getZoomOriginMouseFilter
```
public Predicate<MouseEvent> getZoomOriginMouseFilter()
```
    Returns zoom-origin mouse filter.
    
    Returns:
    
    zoom-origin mouse filter
    
    See Also:
    
    setZoomOriginMouseFilter(Predicate)
  - getZoomOutMouseFilter
```
public Predicate<MouseEvent> getZoomOutMouseFilter()
```
    Returns zoom-out mouse filter.
    
    Returns:
    
    zoom-out mouse filter
    
    See Also:
    
    setZoomOutMouseFilter(Predicate)
  - getZoomScrollFilter
```
public Predicate<ScrollEvent> getZoomScrollFilter()
```
    Returns zoom-scroll filter.
    
    Returns:
    
    predicate of filter
  - isAnimated
```
public final boolean isAnimated()
```
    Returns the value of the animatedProperty().
    
    Returns:
    
    true if zoom is animated, false otherwise
    
    See Also:
    
    getZoomDuration()
  - isPannerEnabled
```
public final boolean isPannerEnabled()
```
    Gets the value of the property pannerEnabled.
  - isSliderVisible
```
public final boolean isSliderVisible()
```
    Returns the value of the sliderVisibleProperty().
    
    Returns:
    
    true if horizontal range slider is shown
  - isUpdateTickUnit
```
public final boolean isUpdateTickUnit()
```
    Returns the value of the animatedProperty().
    
    Returns:
    
    true if zoom is animated, false otherwise
    
    See Also:
    
    getZoomDuration()
  - omitAxisZoomList
```
public final ObservableList<Axis> omitAxisZoomList()
```
    Returns:
    
    list of axes that shall be ignored when performing zoom-in or outs
  - pannerEnabledProperty
```
public final BooleanProperty pannerEnabledProperty()
```
    When true pressing the middle mouse button and dragging pans the plot
    
    See Also:
    
    isPannerEnabled(), setPannerEnabled(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)
  - setAxisMode
```
public final void setAxisMode(AxisMode mode)
```
    Sets the value of the axisModeProperty().
    
    Parameters:
    
    mode - the mode to be used
  - setDragCursor
```
public final void setDragCursor(Cursor cursor)
```
    Sets value of the dragCursorProperty().
    
    Parameters:
    
    cursor - the cursor to be used by the plugin
  - setPannerEnabled
```
public final void setPannerEnabled(boolean state)
```
    Sets the value of the sliderVisibleProperty().
    
    Parameters:
    
    state - if true the panner (middle mouse button is enabled
  - setSliderVisible
```
public final void setSliderVisible(boolean state)
```
    Sets the value of the sliderVisibleProperty().
    
    Parameters:
    
    state - if true the horizontal range slider is shown
  - setUpdateTickUnit
```
public final void setUpdateTickUnit(boolean value)
```
    Sets the value of the animatedProperty().
    
    Parameters:
    
    value - if true zoom will be animated
    
    See Also:
    
    setZoomDuration(Duration)
  - setZoomCursor
```
public final void setZoomCursor(Cursor cursor)
```
    Sets value of the zoomCursorProperty().
    
    Parameters:
    
    cursor - the cursor to be used by the plugin
  - setZoomDuration
```
public final void setZoomDuration(Duration duration)
```
    Sets the value of the zoomDurationProperty().
    
    Parameters:
    
    duration - duration of the zoom
  - 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 defaultZoomInMouseFilter.
    
    See Also:
    
    getZoomInMouseFilter()
  - 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 defaultZoomOriginFilter.
    
    See Also:
    
    getZoomOriginMouseFilter()
  - 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 defaultZoomOutMouseFilter.
    
    See Also:
    
    getZoomOutMouseFilter()
  - setZoomScrollFilter
```
public void setZoomScrollFilter(Predicate<ScrollEvent> zoomScrollFilter)
```
    Sets filter on MOUSE_CLICKED events that should trigger zoom-origin operation.
    
    Parameters:
    
    zoomScrollFilter - filter
  - sliderVisibleProperty
```
public final BooleanProperty sliderVisibleProperty()
```
    When true an additional horizontal range slider is shown in a HiddeSidesPane at the bottom. By default it's true.
    
    See Also:
    
    isSliderVisible(), setSliderVisible(boolean)
  - updateTickUnitProperty
```
public final BooleanProperty updateTickUnitProperty()
```
    When true zooming will be animated. By default it's false.
    
    See Also:
    
    isUpdateTickUnit(), setUpdateTickUnit(boolean)
  - zoomCursorProperty
```
public final ObjectProperty<Cursor> zoomCursorProperty()
```
    Mouse cursor to be used during zoom operation.
    
    See Also:
    
    getZoomCursor(), setZoomCursor(Cursor)
  - zoomDurationProperty
```
public final ObjectProperty<Duration> zoomDurationProperty()
```
    Duration of the animated zoom (in and out). Used only when animatedProperty() is set to true. By default initialised to 500ms.
    
    See Also:
    
    getZoomDuration(), setZoomDuration(Duration)
  - zoomOrigin
```
public boolean zoomOrigin()
```
  - isOmitZoom
```
public static boolean isOmitZoom(Axis axis)
```
    Parameters:
    
    axis - the axis to be modified
    
    Returns:
    
    true if axis is zoomable, false otherwise
  - setOmitZoom
```
public static void setOmitZoom(Axis axis,
                               boolean state)
```
    Parameters:
    
    axis - the axis to be modified
    
    state - true: axis is not taken into account when zooming

Class Zoomer

Property Summary

Properties inherited from class de.gsi.chart.plugins.ChartPlugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class de.gsi.chart.plugins.ChartPlugin

Methods inherited from class java.lang.Object

Property Detail

animated

axisMode

dragCursor

pannerEnabled

sliderVisible

updateTickUnit

zoomCursor

zoomDuration

Field Detail

ZOOMER_OMIT_AXIS

STYLE_CLASS_ZOOM_RECT

DEFAULT_MOUSE_FILTER

defaultZoomInMouseFilter

defaultZoomOutMouseFilter

defaultZoomOriginFilter

defaultScrollFilter

Constructor Detail

Zoomer

Zoomer

Zoomer

Zoomer

Method Detail

animatedProperty

axisModeProperty

clear

clear

dragCursorProperty

getAxisMode

getDragCursor

getRangeSlider

getZoomCursor

getZoomDuration

getZoomInMouseFilter

getZoomInteractorBar

getZoomOriginMouseFilter

getZoomOutMouseFilter

getZoomScrollFilter

isAnimated

isPannerEnabled

isSliderVisible

isUpdateTickUnit

omitAxisZoomList

pannerEnabledProperty

setAnimated

setAxisMode

setDragCursor

setPannerEnabled

setSliderVisible

setUpdateTickUnit

setZoomCursor

setZoomDuration

setZoomInMouseFilter

setZoomOriginMouseFilter

setZoomOutMouseFilter

setZoomScrollFilter

sliderVisibleProperty

updateTickUnitProperty

zoomCursorProperty

zoomDurationProperty

zoomOrigin

isOmitZoom

setOmitZoom