CanvasControl (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- javafx.scene.Node
- - javafx.scene.Parent
  - - javafx.scene.layout.Region
    - - javafx.scene.control.Control
      - com.yworks.yfiles.view.CanvasControl

All Implemented Interfaces:

ILookup, javafx.css.Styleable, EventTarget, Skinnable

Direct Known Subclasses:

GraphControl, GraphOverviewControl
```
public class CanvasControl
extends Control
implements ILookup
```
The CanvasControl can be used to efficiently display all kinds of data.
The control supports high performance zooming and panning of visual content and provides a high level view of the visual tree. The control uses double precision world-coordinates to render items that are composed using a visual tree. In its most simple form the scene graph is a tree-like structure of elements that will be rendered in depth-first-search order.

The scene graph tree is made up of ICanvasObject elements. Multiple elements are grouped in ICanvasObjectGroup elements. An ICanvasObject consists of a user object and an ICanvasObjectDescriptor that is used by the rendering engine to query interfaces that perform the actual creation of the Nodes, hit testing, and bounds calculation.

This control comes with a number of default com.yworks.yfiles.view.CanvasControl.getCommandBindings() that work on the view port:
The handlers for ICommand.INCREASE_ZOOM and ICommand.DECREASE_ZOOM use the parameter passed to the command as the factor by which the Zoom value is multiplied or divided, respectively. The parameter is not required. If it is not present a default value is used. The handler for the ICommand.ZOOM command needs a parameter. The parameter can either be a number which is interpreted as the new zoom level, or it can be a suitable object. Supported objects are RectD, PointD and ILookup. If a rectangle is specified as the parameter for the ICommand.ZOOM command, the handler adjusts the Viewport such that the rectangle tightly fits into it. If a point is specified, the handler sets the Center to that point. If the parameter implements ILookup, then the handler tries to get a IBoundsProvider from the lookup and uses the bounds obtained from the bounds provider as the rectangle to zoom to.

All commands can be removed from the com.yworks.yfiles.view.CanvasControl.getCommandBindings() if desired.

Related Information in the Developers Guide:
CanvasControl is discussed in detail in the section The Control for Displaying Graphs.
See Also:

IVisualCreator, IHitTestable, IVisibilityTestable

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`BooleanProperty`	`autoDragEnabled` A property that causes the control to automatically pan the view when the mouse gets dragged outside of the bounds of the control.
`ObjectProperty<InsetsD>`	`autoDragInsets` The property for the `auto drag insets`.
`ObjectProperty<IEventRecognizer>`	`centerZoomEventRecognizer` The property for the `getCenterZoomEventRecognizer()` event recognizer} that determines whether the zooming to the center of the view, rather than at the mouse location should be used.
`ReadOnlyIntegerProperty`	`computedHorizontalScrollBarState` Returns an `IntegerProperty` that holds the state of the horizontal scroll bar.
`ReadOnlyIntegerProperty`	`computedVerticalScrollBarState` Returns an `IntegerProperty` that holds the state of the vertical scroll bar.
`ObjectProperty<RectD>`	`contentRect` Returns an `ObjectProperty` that holds a rectangle containing the whole graph content of this `CanvasControl`.
`ObjectProperty<SizeD>`	`doubleClickSize` The property for the `area in view coordinates` the mouse needs to stay in before multiple clicks are considered multiple single clicks instead of multi-clicks.
`ObjectProperty<Duration>`	`doubleClickTime` The property for the `double click time` that indicates the amount of time that may pass within which two subsequent mouse clicks are considered multi clicks.
`ObjectProperty<Duration>`	`doubleTapDuration` The property for the `double tap time` that indicates the amount of time that may pass within which two subsequent touch taps are considered multi taps.
`ObjectProperty<SizeD>`	`doubleTapSize` The property for the `area in view coordinates` the touch pointer needs to stay in before multiple taps are considered multiple single taps instead of multi-taps.
`ObjectProperty<SizeD>`	`dragSize` The property for the `the area in view coordinates` the mouse may stay in before a movement is considered a drag.
`ObjectProperty<Duration>`	`dragTime` The property for the `drag time` that indicates the amount of time that may pass before a mouse movement is considered a drag when the mouse stays within its `DragSize` area.
`BooleanProperty`	`editable` Property that sets the editable state of this canvas.
`ObjectProperty<InsetsD>`	`fitContentViewMargins` The property for the `insets in view coordinates` that should be used by the `fitContent()` operation.
`DoubleProperty`	`hitTestRadius` The property for the `radius of the area around the mouse in view coordinates` in which a `IHitTestable` may lie to be considered a valid hit.
`DoubleProperty`	`horizontalOffset` Returns a `DoubleProperty` that holds the current value of the horizontal scroll bar.
`ObjectProperty<ScrollPane.ScrollBarPolicy>`	`horizontalScrollBarPolicy` Returns an `ObjectProperty` that holds the visibility policy for the horizontal scroll bar.
`ObjectProperty<IInputMode>`	`inputMode` The property for the `the single input mode instance that is installed in this canvas`.
`ReadOnlyDoubleProperty`	`largeHorizontalChange` Returns a `DoubleProperty` that holds the change of the horizontal scroll bar when the track of the bar is clicked.
`ReadOnlyDoubleProperty`	`largeVerticalChange` Returns a `DoubleProperty` that holds the change of the vertical scroll bar when the track of the bar is clicked.
`ObjectProperty<Duration>`	`longPressDuration` The property for the `long press time` that indicates the amount of time that may pass before a touch down is considered a long press when the pointer stays within its `getDragSize()` area.
`ReadOnlyDoubleProperty`	`maximumHorizontalOffset` Returns a `DoubleProperty` that holds the the maximum value for the vertical scroll bar.
`ReadOnlyDoubleProperty`	`maximumVerticalOffset` Returns a `DoubleProperty` that holds the maximum value for the vertical scroll bar.
`DoubleProperty`	`maximumZoom` Returns a `DoubleProperty` that holds the maximum zoom level that is valid for this canvas control.
`ReadOnlyDoubleProperty`	`minimumHorizontalOffset` Returns a `DoubleProperty` that holds the minimum value for the horizontal scroll bar.
`ReadOnlyDoubleProperty`	`minimumVerticalOffset` Returns a `DoubleProperty` that holds the minimum value for the vertical scroll bar.
`DoubleProperty`	`minimumZoom` Returns a `DoubleProperty` that holds the minimum the minimum zoom level for this canvas control.
`BooleanProperty`	`mouseEventConsumingDisabled` Defines whether consuming mouse events during the bubbling phase for this control is disabled or not.
`ObjectProperty<MouseWheelBehaviors>`	`mouseWheelBehavior` The property for the `behavior of the mouse wheel`.
`DoubleProperty`	`mouseWheelScrollFactor` The property for the `factor` that controls how fast the viewport scrolls when the mouse wheel is turned.
`DoubleProperty`	`mouseWheelZoomFactor` The property for the `factor` by which the zoom level changes when the mouse wheel is turned.
`BooleanProperty`	`navigationCommandsEnabled` The property for the `value` indicating whether navigation related command bindings are enabled.
`ObjectProperty<EventHandler<? super CompoundKeyEvent>>`	`onCompoundKeyPressed` Defines a function to be called when the user has `pressed` a key on the `CanvasControl`.
`ObjectProperty<EventHandler<? super CompoundKeyEvent>>`	`onCompoundKeyReleased` Defines a function to be called when the user has `released` a key on the `CanvasControl`.
`ObjectProperty<EventHandler<? super CompoundKeyEvent>>`	`onCompoundKeyTyped` Defines a function to be called when the user has `typed` a key on the `CanvasControl`.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DClicked` Defines a function to be called when the user has `clicked` on the `CanvasControl` with the mouse.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DDragged` Defines a function to be called when the mouse has been `dragged` over the `CanvasControl`, i.e. the mouse is being moved while at least one of the mouse buttons is pressed.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DEntered` Defines a function to be called when the mouse has `entered` the `CanvasControl`.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DExited` Defines a function to be called when the mouse has `exited` the `CanvasControl`.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DMoved` Defines a function to be called when the mouse has been `moved` in the `CanvasControl`.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DPressed` Defines a function to be called when the mouse has been `pressed` in the `CanvasControl`.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DReleased` Defines a function to be called when the mouse has been `released` on the `CanvasControl`.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DWheelTurned` Defines a function to be called when the mouse wheel has `turned` over the `CanvasControl`.
`BooleanProperty`	`scrollCommandAnimationEnabled` The property for the `value that indicates if scrolling should be animated`.
`ReadOnlyDoubleProperty`	`smallHorizontalChange` Returns a `DoubleProperty` that holds the step size by which the horizontal scroll bar is changed when calling `ScrollBar.increment()` or `ScrollBar.decrement()`.
`ReadOnlyDoubleProperty`	`smallVerticalChange` Returns a `DoubleProperty` that holds the step size by which the vertical scroll bar is changed when calling `ScrollBar.increment()` or `ScrollBar.decrement()`.
`DoubleProperty`	`verticalOffset` Returns a `DoubleProperty` that holds the current value of the vertical scroll bar.
`ObjectProperty<ScrollPane.ScrollBarPolicy>`	`verticalScrollBarPolicy` Returns an `ObjectProperty` that holds the visibility policy for the vertical scroll bar.
`ObjectProperty<PointD>`	`viewPoint` Returns an `ObjectProperty` that holds current view point.
`ReadOnlyDoubleProperty`	`viewportHeight` Returns a `DoubleProperty` that holds the height of the current viewport.
`ReadOnlyObjectPropertyBase<RectD>`	`viewport` The property for the `view port`.
`ReadOnlyDoubleProperty`	`viewportWidth` Returns a `DoubleProperty` that holds the width of the current viewport.
`DoubleProperty`	`zoom` Gets a `DoubleProperty` that holds the current zoom factor for this canvas control.

Properties inherited from class javafx.scene.control.Control
contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent
impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SCROLL_BAR_ENABLED` Constant to describe the state of a scroll bar.
`static int`	`SCROLL_BAR_VISIBLE` Constant that describes the state of a scroll bar.

Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT

Fields inherited from interface com.yworks.yfiles.graph.ILookup
EMPTY

Constructor Summary

Constructors
Constructor and Description

CanvasControl()
Creates a new instance of CanvasControl.

Constructors
Constructor and Description
`CanvasControl()` Creates a new instance of `CanvasControl`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBackgroundGroupChangedListener(IEventHandler backgroundGroupChangedEvent)` Adds the given listener for the `BackgroundGroupChanged` event that occurs when the `BackgroundGroup` property has been changed.
`void`	`addContentGroupChangedListener(IEventHandler contentGroupChangedEvent)` Adds the given listener for the `ContentGroupChanged` event that occurs when the `ContentGroup` property has been changed.
`void`	`addFocusGroupChangedListener(IEventHandler focusGroupChangedEvent)` Adds the given listener for the `FocusGroupChanged` event that occurs when the `FocusGroup` property has been changed.
`void`	`addHighlightGroupChangedListener(IEventHandler highlightGroupChangedEvent)` Adds the given listener for the `HighlightGroupChanged` event that occurs when the `HighlightGroup` property has been changed.
`void`	`addInputModeContextChangedListener(IEventHandler<PropertyChangedEventArgs> inputModeContextChangedEvent)` Adds the given listener for the `InputModeContextChanged` event that occurs when the `InputModeContext` property has been changed.
`void`	`addInputModeGroupChangedListener(IEventHandler inputModeGroupChangedEvent)` Adds the given listener for the `InputModeGroupChanged` event that occurs when the `InputModeGroup` property has been changed.
`void`	`addSelectionGroupChangedListener(IEventHandler selectionGroupChangedEvent)` Adds the given listener for the `SelectionGroupChanged` event that occurs when the `SelectionGroup` property has been changed.
`void`	`animateScrollTo(PointD viewPoint, double zoom)` Scrolls to the provided view point and zoom level in an animated fashion.
`BooleanProperty`	`autoDragEnabledProperty()` A property that causes the control to automatically pan the view when the mouse gets dragged outside of the bounds of the control.
`ObjectProperty<InsetsD>`	`autoDragInsetsProperty()` The property for the `auto drag insets`.
`ObjectProperty<IEventRecognizer>`	`centerZoomEventRecognizerProperty()` The property for the `getCenterZoomEventRecognizer()` event recognizer} that determines whether the zooming to the center of the view, rather than at the mouse location should be used.
`void`	`coerceViewportLimits()` Helper method that ensures that the view port limit as returned by the `ViewportLimiter` are obeyed.
`int`	`compareRenderOrder(ICanvasObject canvasObject1, ICanvasObject canvasObject2)` Compares two `ICanvasObject` instances that are live in this canvas.
`ReadOnlyIntegerProperty`	`computedHorizontalScrollBarStateProperty()` Returns an `IntegerProperty` that holds the state of the horizontal scroll bar.
`ReadOnlyIntegerProperty`	`computedVerticalScrollBarStateProperty()` Returns an `IntegerProperty` that holds the state of the vertical scroll bar.
`ObjectProperty<RectD>`	`contentRectProperty()` Returns an `ObjectProperty` that holds a rectangle containing the whole graph content of this `CanvasControl`.
`protected ICanvasObjectGroup`	`createBackgroundGroup()` Factory method for the BackgroundGroup property.
`protected ICanvasObjectGroup`	`createContentGroup()` Factory method for the ContentGroup property.
`protected ICanvasObjectGroup`	`createFocusGroup()` Factory method for the `FocusGroup` property.
`protected ICanvasObjectGroup`	`createHighlightGroup()` Factory method for the HighlightGroup property.
`protected IInputModeContext`	`createInputModeContext()` Factory method for the `InputModeContext` property.
`protected ICanvasObjectGroup`	`createInputModeGroup()` Factory method for the InputModeGroup property.
`IRenderContext`	`createRenderContext()` Creates an appropriate `render context` that can be used to `create visuals` using `IVisualCreator` implementations.
`protected ICanvasObjectGroup`	`createSelectionGroup()` Factory method for the SelectionGroup property.
`static Node`	`createVisualFromTemplate(IVisualTemplate template, PointD origin, IRenderContext context)` Creates a visual representation (`Node`) using the given template.
`static Node`	`createVisualFromTemplate(IVisualTemplate template, PointD origin, IRenderContext context, RectD initialBounds)` Creates a visual representation (`Node`) using the given template.
`static Node`	`createVisualFromTemplate(IVisualTemplate template, PointD origin, IRenderContext context, RectD initialBounds, Object dataObject)` Creates a visual representation (`Node`) using the given template.
`ObjectProperty<SizeD>`	`doubleClickSizeProperty()` The property for the `area in view coordinates` the mouse needs to stay in before multiple clicks are considered multiple single clicks instead of multi-clicks.
`ObjectProperty<Duration>`	`doubleClickTimeProperty()` The property for the `double click time` that indicates the amount of time that may pass within which two subsequent mouse clicks are considered multi clicks.
`ObjectProperty<Duration>`	`doubleTapDurationProperty()` The property for the `double tap time` that indicates the amount of time that may pass within which two subsequent touch taps are considered multi taps.
`ObjectProperty<SizeD>`	`doubleTapSizeProperty()` The property for the `area in view coordinates` the touch pointer needs to stay in before multiple taps are considered multiple single taps instead of multi-taps.
`ObjectProperty<SizeD>`	`dragSizeProperty()` The property for the `the area in view coordinates` the mouse may stay in before a movement is considered a drag.
`ObjectProperty<Duration>`	`dragTimeProperty()` The property for the `drag time` that indicates the amount of time that may pass before a mouse movement is considered a drag when the mouse stays within its `DragSize` area.
`BooleanProperty`	`editableProperty()` Property that sets the editable state of this canvas.
`Node`	`exportContent(IRenderContext context)` Exports the graphical content for this `CanvasControl`.
`void`	`fitContent()` Adjusts the view port to fully encompass the `ContentRect`.
`ObjectProperty<InsetsD>`	`fitContentViewMarginsProperty()` The property for the `insets in view coordinates` that should be used by the `fitContent()` operation.
`InsetsD`	`getAutoDragInsets()` Gets the auto drag insets.
`ICanvasObjectGroup`	`getBackgroundGroup()` Gets the BackgroundGroup property.
`RectD`	`getBounds(ICanvasObject canvasObject)` Convenience method that calculates the bounds for a given canvas object in the scene graph.
`ICanvasContext`	`getCanvasContext()` Returns an implementation of `ICanvasContext` that describes the state of this `CanvasControl`.
`ICanvasObject`	`getCanvasObject(PointD location)` Returns the top most canvas object instance that is hit at the given coordinate set.
`IEnumerable<ICanvasObject>`	`getCanvasObjects()` Enumerates over all possible `ICanvasObject` instances in the tree.
`IEnumerable<ICanvasObject>`	`getCanvasObjects(ICanvasObjectGroup group)` Enumerates over all possible `ICanvasObject` instances in the tree below the given group.
`IEnumerable<ICanvasObject>`	`getCanvasObjects(PointD location)` Returns a list of all canvas objects in hit order at the given world coordinate location.
`PointD`	`getCenter()` Gets the world coordinate at the center of the control.
`IEventRecognizer`	`getCenterZoomEventRecognizer()` Specifies an `IEventRecognizer` that determines whether the zooming to the center of the view, rather than at the mouse location should be used.
`int`	`getComputedHorizontalScrollBarState()` Determines the state of the horizontal scroll bar.
`int`	`getComputedVerticalScrollBarState()` Determines the state of the vertical scroll bar.
`ICanvasObjectGroup`	`getContentGroup()` Gets the ContentGroup property.
`RectD`	`getContentRect()` Gets the Rectangle in world coordinates that holds the contents.
`VisualGroup`	`getContentVisualGroup()` Returns the container holding the content of the CanvasControl.
`IListEnumerable<Touch2DPoint>`	`getCurrentTouchDevices()` Gets a list of the active `Touch2DPoint`s at the time of invocation.
`SizeD`	`getDoubleClickSize()` The area in view coordinates the mouse needs to stay in before multiple clicks are considered multiple single clicks instead of multi-clicks.
`Duration`	`getDoubleClickTime()` The value of the double click time.
`Duration`	`getDoubleTapDuration()` Gets the value of the double tap time.
`SizeD`	`getDoubleTapSize()` Gets the area in view coordinates the touch pointer needs to stay in before multiple taps are considered multiple single taps instead of multi-taps.
`SizeD`	`getDragSize()` Gets the area in view coordinates the mouse may stay in before a movement is considered a drag.
`Duration`	`getDragTime()` Gets the value of the drag time.
`InsetsD`	`getFitContentViewMargins()` Gets the insets in view coordinates that should be used by the `fitContent()` operation.
`ICanvasObjectGroup`	`getFocusGroup()` Gets the HighlightGroup property.
`ICanvasObjectGroup`	`getHighlightGroup()` Gets the HighlightGroup property.
`double`	`getHitTestRadius()` Specifies the radius of the area around the mouse in view coordinates in which a `IHitTestable` may lie to be considered a valid hit.
`double`	`getHorizontalOffset()`
`ScrollPane.ScrollBarPolicy`	`getHorizontalScrollBarPolicy()` Specifies the visibility policy for the vertical scrollbar.
`IInputMode`	`getInputMode()` Specifies the single `IInputMode` instance that shall be installed for this canvas.
`IInputModeContext`	`getInputModeContext()` Gets the InputModeContext property.
`LookupChain`	`getInputModeContextLookupChain()` Retrieves the `LookupChain` that can be used do decorate the `ILookup.lookup(Class)` call in the `InputModeContext`.
`ICanvasObjectGroup`	`getInputModeGroup()` Gets the InputModeGroup property.
`double`	`getLargeHorizontalChange()` Returns the change of the horizontal scroll bar when the track of the bar is clicked.
`double`	`getLargeVerticalChange()` Returns the change of the vertical scroll bar when the track of the bar is clicked.
`PointD`	`getLastEventLocation()` Gets the last location provided by a pointing device (for instance mouse or touch).
`Mouse2DEvent`	`getLastMouse2DEvent()` Gets the last `mouse event` triggered by this instance.
`Touch2DEvent`	`getLastTouch2DEvent()` Gets the last `touch event` triggered by this instance.
`Duration`	`getLongPressDuration()` Gets the value of the long press time.
`double`	`getMaximumHorizontalOffset()` Returns the maximum value for the horizontal scroll bar.
`double`	`getMaximumVerticalOffset()` Returns the maximum value for the vertical scroll bar.
`double`	`getMaximumZoom()` Gets the maximum zoom level that is valid for `Zoom`.
`double`	`getMinimumHorizontalOffset()` Returns the minimum value for the horizontal scroll bar.
`double`	`getMinimumVerticalOffset()` Returns the minimum value for the vertical scroll bar.
`double`	`getMinimumZoom()` Gets the minimum zoom factor for this canvas control.
`MouseWheelBehaviors`	`getMouseWheelBehavior()` Determines the behavior of the mouse wheel.
`double`	`getMouseWheelScrollFactor()` Gets a factor that controls how fast the viewport scrolls when the mouse wheel is turned.
`double`	`getMouseWheelZoomFactor()` Gets the factor by which the zoom level changes when the mouse wheel is turned.
`EventHandler<? super CompoundKeyEvent>`	`getOnCompoundKeyPressed()` Returns the value of the property onCompoundKeyPressed.
`EventHandler<? super CompoundKeyEvent>`	`getOnCompoundKeyReleased()` Returns the value of the property onCompoundKeyReleased.
`EventHandler<? super CompoundKeyEvent>`	`getOnCompoundKeyTyped()` Returns the value of the property onCompoundKeyTyped.
`EventHandler<? super Mouse2DEvent>`	`getOnMouse2DClicked()` Returns the value of the property onMouse2DClicked.
`EventHandler<? super Mouse2DEvent>`	`getOnMouse2DDragged()` Returns the value of the property onMouse2DDragged.
`EventHandler<? super Mouse2DEvent>`	`getOnMouse2DEntered()` Returns the value of the property onMouse2DEntered.
`EventHandler<? super Mouse2DEvent>`	`getOnMouse2DExited()` Returns the value of the property onMouse2DExited.
`EventHandler<? super Mouse2DEvent>`	`getOnMouse2DMoved()` Returns the value of the property onMouse2DMoved.
`EventHandler<? super Mouse2DEvent>`	`getOnMouse2DPressed()` Returns the value of the property onMouse2DPressed.
`EventHandler<? super Mouse2DEvent>`	`getOnMouse2DReleased()` Returns the value of the property onMouse2DReleased.
`EventHandler<? super Mouse2DEvent>`	`getOnMouse2DWheelTurned()` Returns the value of the property onMouse2DWheelTurned.
`ICanvasObjectGroup`	`getRootGroup()` Gets the root of the scene graph.
`ICanvasObjectGroup`	`getSelectionGroup()` Gets the SelectionGroup property.
`SizeD`	`getSize()` Returns the size of this `CanvasControl`.
`double`	`getSmallHorizontalChange()` Returns the step size by which the horizontal scroll bar is changed when calling `ScrollBar.increment()` or `ScrollBar.decrement()`.
`double`	`getSmallVerticalChange()` Returns the step size by which the vertical scroll bar is changed when calling `ScrollBar.increment()` or `ScrollBar.decrement()`.
`double`	`getVerticalOffset()` Returns the current value of the vertical scroll bar.
`ScrollPane.ScrollBarPolicy`	`getVerticalScrollBarPolicy()` Specifies the visibility policy for the vertical scrollbar.
`PointD`	`getViewPoint()` Gets the current view point.
`RectD`	`getViewport()` Returns the currently visible viewing region in world coordinates.
`double`	`getViewportHeight()` Returns the height of the current viewport.
`ViewportLimiter`	`getViewportLimiter()` Gets the `ViewportLimiter` instance that can be used to limit the explorable region.
`double`	`getViewportWidth()` Returns the width of the current viewport.
`Node`	`getVisual(ICanvasObject canvasObject)` Gets the `Node` that is currently visualizing the given `ICanvasObject`.
`VisualCachingPolicy`	`getVisualCaching()` Gets the policy for caching `Node`s which are temporarily removed from the visual tree.
`IVisualCreator`	`getVisualCreator(ICanvasObject canvasObject)` Convenience method that retrieves the `IVisualCreator` for a given `ICanvasObject`.
`double`	`getZoom()` Gets the zoom factor for this `CanvasControl`.
`Duration`	`getZoomAnimationDuration()` Gets the duration of the zooming animation.
`void`	`growContentRect(RectD rectangle)` Assures that the `content rectangle` encompasses the given rectangle.
`IEnumerable<ICanvasObject>`	`hitElementsAt(IInputModeContext context, PointD location)` Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific `ICanvasContext` as the argument to the `IHitTestable.isHit(IInputModeContext, PointD)` method.
`IEnumerable<ICanvasObject>`	`hitElementsAt(IInputModeContext context, PointD location, ICanvasObjectGroup root)` Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific `ICanvasContext` as the argument to the `IHitTestable.isHit(IInputModeContext, PointD)` method.
`IEnumerable<ICanvasObject>`	`hitElementsAt(IInputModeContext context, PointD location, ICanvasObjectGroup root, Predicate<ICanvasObject> filter)` Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific `ICanvasContext` as the argument to the `IHitTestable.isHit(IInputModeContext, PointD)` method.
`IEnumerable<ICanvasObject>`	`hitElementsAt(PointD location)` Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.
`IEnumerable<ICanvasObject>`	`hitElementsAt(PointD location, ICanvasObjectGroup root)` Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.
`IEnumerable<ICanvasObject>`	`hitElementsAt(PointD location, ICanvasObjectGroup root, Predicate<ICanvasObject> filter)` Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.
`DoubleProperty`	`hitTestRadiusProperty()` The property for the `radius of the area around the mouse in view coordinates` in which a `IHitTestable` may lie to be considered a valid hit.
`DoubleProperty`	`horizontalOffsetProperty()` Returns a `DoubleProperty` that holds the current value of the horizontal scroll bar.
`ObjectProperty<ScrollPane.ScrollBarPolicy>`	`horizontalScrollBarPolicyProperty()` Returns an `ObjectProperty` that holds the visibility policy for the horizontal scroll bar.
`protected Object`	`inputModeContextLookup(Class type)` Callback that is used by the default implementation of `InputModeContext` to resolve `ILookup.lookup(Class)` calls.
`ObjectProperty<IInputMode>`	`inputModeProperty()` The property for the `the single input mode instance that is installed in this canvas`.
`void`	`invalidate()` Invalidates the current control.
`boolean`	`isAllKeyboardInputCapturingEnabled()` Gets a value indicating whether all keyboard input should be captured by this control, even if it hosts UI elements that would otherwise capture those events.
`boolean`	`isAllPointerInputCapturingEnabled()` Gets a value indicating whether all mouse or touch input should be captured by this control, even if it hosts UI elements that would otherwise capture those events.
`boolean`	`isAutoDragEnabled()` Gets a property that causes the control to automatically pan the view when the mouse gets dragged outside of the bounds of the control.
`boolean`	`isDeviceDown()` Checks if at least one finger is on the touch screen.
`boolean`	`isEditable()` Property that sets the editable state of this canvas.
`boolean`	`isHit(ICanvasObject canvasObject, PointD location)` Convenience method that calculates the hit tests a given canvas object in the scene graph.
`boolean`	`isKeyboardFocusWithin()` Determines whether the keyboard focus is within the visual tree.
`boolean`	`isMouseEventConsumingDisabled()` Returns whether the behavior of consuming mouse events during the bubbling phase is disabled.
`boolean`	`isNavigationCommandsEnabled()` Gets a value indicating whether navigation related command bindings are enabled.
`boolean`	`isScrollCommandAnimationEnabled()` Gets a value indicating whether `ICommand`s for scrolling like for example `ICommand.SCROLL_PAGE_DOWN`, the scrolling should be performed in animated fashion.
`boolean`	`isZoomAnimationEnabled()` Gets a value indicating whether zooming operations (e.g. turning the mouse wheel, executing `ICommand.ZOOM` etc.) should be performed in animated fashion.
`ReadOnlyDoubleProperty`	`largeHorizontalChangeProperty()` Returns a `DoubleProperty` that holds the change of the horizontal scroll bar when the track of the bar is clicked.
`ReadOnlyDoubleProperty`	`largeVerticalChangeProperty()` Returns a `DoubleProperty` that holds the change of the vertical scroll bar when the track of the bar is clicked.
`protected void`	`layoutChildren()`
`ObjectProperty<Duration>`	`longPressDurationProperty()` The property for the `long press time` that indicates the amount of time that may pass before a touch down is considered a long press when the pointer stays within its `getDragSize()` area.
`<TLookup> TLookup`	`lookup(Class<TLookup> type)` Returns an instance that implements the given type or `null`.
`void`	`makeVisible(RectD bounds)` Ensures that the provided bounds are visible in this control by adjusting the viewport correspondingly.
`ReadOnlyDoubleProperty`	`maximumHorizontalOffsetProperty()` Returns a `DoubleProperty` that holds the the maximum value for the vertical scroll bar.
`ReadOnlyDoubleProperty`	`maximumVerticalOffsetProperty()` Returns a `DoubleProperty` that holds the maximum value for the vertical scroll bar.
`DoubleProperty`	`maximumZoomProperty()` Returns a `DoubleProperty` that holds the maximum zoom level that is valid for this canvas control.
`ReadOnlyDoubleProperty`	`minimumHorizontalOffsetProperty()` Returns a `DoubleProperty` that holds the minimum value for the horizontal scroll bar.
`ReadOnlyDoubleProperty`	`minimumVerticalOffsetProperty()` Returns a `DoubleProperty` that holds the minimum value for the vertical scroll bar.
`DoubleProperty`	`minimumZoomProperty()` Returns a `DoubleProperty` that holds the minimum the minimum zoom level for this canvas control.
`BooleanProperty`	`mouseEventConsumingDisabledProperty()` Defines whether consuming mouse events during the bubbling phase for this control is disabled or not.
`ObjectProperty<MouseWheelBehaviors>`	`mouseWheelBehaviorProperty()` The property for the `behavior of the mouse wheel`.
`protected void`	`mouseWheelScroll(Mouse2DEvent e)` This method will be called by the `onMouse2DWheelTurned(Mouse2DEvent)` method, if the `MouseWheelBehavior` property is set to `MouseWheelBehaviors.SCROLL`.
`DoubleProperty`	`mouseWheelScrollFactorProperty()` The property for the `factor` that controls how fast the viewport scrolls when the mouse wheel is turned.
`protected void`	`mouseWheelZoom(Mouse2DEvent e)` This method will be called by the `onMouse2DWheelTurned(Mouse2DEvent)` method, if the `MouseWheelBehavior` property is set to `MouseWheelBehaviors.ZOOM`.
`DoubleProperty`	`mouseWheelZoomFactorProperty()` The property for the `factor` by which the zoom level changes when the mouse wheel is turned.
`BooleanProperty`	`navigationCommandsEnabledProperty()` The property for the `value` indicating whether navigation related command bindings are enabled.
`ObjectProperty<EventHandler<? super CompoundKeyEvent>>`	`onCompoundKeyPressedProperty()` Defines a function to be called when the user has `pressed` a key on the `CanvasControl`.
`ObjectProperty<EventHandler<? super CompoundKeyEvent>>`	`onCompoundKeyReleasedProperty()` Defines a function to be called when the user has `released` a key on the `CanvasControl`.
`ObjectProperty<EventHandler<? super CompoundKeyEvent>>`	`onCompoundKeyTypedProperty()` Defines a function to be called when the user has `typed` a key on the `CanvasControl`.
`protected void`	`onKeyDown(KeyEvent event)` This will transform the key event to `ModifierKeys` and redispatch the last mouse event.
`protected void`	`onKeyPress(KeyEvent event)` This implementation will do nothing.
`protected void`	`onKeyUp(KeyEvent event)` This will transform the key event to `ModifierKeys` and redispatch the last mouse event.
`protected void`	`onMouse2DClicked(Mouse2DEvent e)` Callback method that is called when the mouse has been clicked.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DClickedProperty()` Defines a function to be called when the user has `clicked` on the `CanvasControl` with the mouse.
`protected void`	`onMouse2DDragged(Mouse2DEvent e)` Callback method that is called when the mouse gets dragged.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DDraggedProperty()` Defines a function to be called when the mouse has been `dragged` over the `CanvasControl`, i.e. the mouse is being moved while at least one of the mouse buttons is pressed.
`protected void`	`onMouse2DEntered(Mouse2DEvent e)` Callback method that is called when the mouse enters the control.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DEnteredProperty()` Defines a function to be called when the mouse has `entered` the `CanvasControl`.
`protected void`	`onMouse2DExited(Mouse2DEvent e)` Callback method that is called when the mouse exits the control.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DExitedProperty()` Defines a function to be called when the mouse has `exited` the `CanvasControl`.
`protected void`	`onMouse2DMoved(Mouse2DEvent e)` Callback method that is called when the mouse has been moved and no button has been pressed.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DMovedProperty()` Defines a function to be called when the mouse has been `moved` in the `CanvasControl`.
`protected void`	`onMouse2DPressed(Mouse2DEvent e)` Callback method that is called when a mouse button has been pressed.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DPressedProperty()` Defines a function to be called when the mouse has been `pressed` in the `CanvasControl`.
`protected void`	`onMouse2DReleased(Mouse2DEvent e)` Callback method that is called when a mouse button has been released.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DReleasedProperty()` Defines a function to be called when the mouse has been `released` on the `CanvasControl`.
`protected void`	`onMouse2DWheelTurned(Mouse2DEvent e)` Callback method that is called when the mouse wheel has been turned.
`ObjectProperty<EventHandler<? super Mouse2DEvent>>`	`onMouse2DWheelTurnedProperty()` Defines a function to be called when the mouse wheel has `turned` over the `CanvasControl`.
`protected void`	`onPrepareRenderContextEvent(RenderContextEvent args)` Raises the `RenderContextEvent.PREPARE` event.
`protected void`	`onSizeChanged(IEventArgs args)` Handles a size change of this `CanvasControl`.
`protected void`	`onTouch2DDown(Touch2DEvent e)` Callback method that is called when a finger has been put on the touch screen.
`protected void`	`onTouch2DEntered(Touch2DEvent e)` Callback method that is called when a finger on the touch screen enters the control.
`protected void`	`onTouch2DExited(Touch2DEvent e)` Callback method that is called when a finger on the touch screen exits the control.
`protected void`	`onTouch2DLongPress(Touch2DEvent e)` Callback method that is called when a long press gesture has been performed with a finger on the touch screen.
`protected void`	`onTouch2DLostCapture(Touch2DEvent e)` Callback method that is called when the touch capture is lost.
`protected void`	`onTouch2DMoved(Touch2DEvent e)` Callback method that is called when a finger has been moved on the touch screen.
`protected void`	`onTouch2DTapped(Touch2DEvent e)` Callback method that is called when a tap gesture has been performed with a finger on the touch screen.
`protected void`	`onTouch2DUp(Touch2DEvent e)` Callback method that is called when a finger has been removed from the surface of the touch screen.
`protected void`	`onTouchDown(TouchEvent e)`
`protected void`	`onTouchEnter(TouchEvent e)`
`protected void`	`onTouchLeave(TouchEvent e)`
`protected void`	`onTouchMove(TouchEvent e)`
`protected void`	`onTouchUp(TouchEvent e)`
`protected void`	`raiseUpdatedEvent()` Raises a `CanvasEvent` of type `CanvasEvent.UPDATED`.
`protected void`	`raiseUpdatingEvent()` Raises the `CanvasEvent.UPDATING` event.
`protected void`	`redispatchMouse2DEvent(ModifierKeys newModifiers)` Redispatches a previously fired mouse event appropriately, e.g. if the view port has changed.
`void`	`removeBackgroundGroupChangedListener(IEventHandler backgroundGroupChangedEvent)` Removes the given listener for the `BackgroundGroupChanged` event that occurs when the `BackgroundGroup` property has been changed.
`void`	`removeContentGroupChangedListener(IEventHandler contentGroupChangedEvent)` Removes the given listener for the `ContentGroupChanged` event that occurs when the `ContentGroup` property has been changed.
`void`	`removeFocusGroupChangedListener(IEventHandler focusGroupChangedEvent)` Removes the given listener for the `FocusGroupChanged` event that occurs when the `FocusGroup` property has been changed.
`void`	`removeHighlightGroupChangedListener(IEventHandler highlightGroupChangedEvent)` Removes the given listener for the `HighlightGroupChanged` event that occurs when the `HighlightGroup` property has been changed.
`void`	`removeInputModeContextChangedListener(IEventHandler<PropertyChangedEventArgs> inputModeContextChangedEvent)` Removes the given listener for the `InputModeContextChanged` event that occurs when the `InputModeContext` property has been changed.
`void`	`removeInputModeGroupChangedListener(IEventHandler inputModeGroupChangedEvent)` Removes the given listener for the `InputModeGroupChanged` event that occurs when the `InputModeGroup` property has been changed.
`void`	`removeSelectionGroupChangedListener(IEventHandler selectionGroupChangedEvent)` Removes the given listener for the `SelectionGroupChanged` event that occurs when the `SelectionGroup` property has been changed.
`void`	`resize(double width, double height)`
`BooleanProperty`	`scrollCommandAnimationEnabledProperty()` The property for the `value that indicates if scrolling should be animated`.
`void`	`setAllKeyboardInputCapturingEnabled(boolean value)` Sets a value indicating whether all keyboard input should be captured by this control, even if it hosts UI elements that would otherwise capture those events.
`void`	`setAllPointerInputCapturingEnabled(boolean value)` Sets a value indicating whether all mouse or touch input should be captured by this control, even if it hosts UI elements that would otherwise capture those events.
`void`	`setAutoDragEnabled(boolean value)` Sets a property that causes the control to automatically pan the view when the mouse gets dragged outside of the bounds of the control.
`void`	`setAutoDragInsets(InsetsD value)` Sets the auto drag insets.
`void`	`setBackgroundGroup(ICanvasObjectGroup value)` Sets the BackgroundGroup property.
`void`	`setCenter(PointD value)` Sets the world coordinate at the center of the control.
`void`	`setCenterZoomEventRecognizer(IEventRecognizer value)` Specifies an `IEventRecognizer` that determines whether the zooming to the center of the view, rather than at the mouse location should be used.
`void`	`setContentGroup(ICanvasObjectGroup value)` Sets the ContentGroup property.
`void`	`setContentRect(double x, double y, double w, double h)` Sets the content rectangle.
`void`	`setContentRect(RectD value)` Sets the Rectangle in world coordinates that holds the contents.
`void`	`setDoubleClickSize(SizeD value)` The area in view coordinates the mouse needs to stay in before multiple clicks are considered multiple single clicks instead of multi-clicks.
`void`	`setDoubleClickTime(Duration value)` The value of the double click time.
`void`	`setDoubleTapDuration(Duration value)` Sets the value of the double tap time.
`void`	`setDoubleTapSize(SizeD value)` Sets the area in view coordinates the touch pointer needs to stay in before multiple taps are considered multiple single taps instead of multi-taps.
`void`	`setDragSize(SizeD value)` Sets the area in view coordinates the mouse may stay in before a movement is considered a drag.
`void`	`setDragTime(Duration value)` Sets the value of the drag time.
`void`	`setEditable(boolean value)` Property that sets the editable state of this canvas.
`void`	`setFitContentViewMargins(InsetsD value)` Sets the insets in view coordinates that should be used by the `fitContent()` operation.
`void`	`setFocusGroup(ICanvasObjectGroup value)` Sets the HighlightGroup property.
`void`	`setHighlightGroup(ICanvasObjectGroup value)` Sets the HighlightGroup property.
`void`	`setHitTestRadius(double value)` Specifies the radius of the area around the mouse in view coordinates in which a `IHitTestable` may lie to be considered a valid hit.
`void`	`setHorizontalScrollBarPolicy(ScrollPane.ScrollBarPolicy value)` Specifies the visibility policy for the vertical scrollbar.
`void`	`setInputMode(IInputMode value)` Sets the single `IInputMode` instance that shall be installed for this canvas.
`void`	`setInputModeContext(IInputModeContext value)` Sets the InputModeContext property.
`void`	`setInputModeGroup(ICanvasObjectGroup value)` Sets the InputModeGroup property.
`void`	`setLongPressDuration(Duration value)` Sets the value of the long press time.
`void`	`setMaximumZoom(double value)` Sets the maximum zoom level that is valid for `Zoom`.
`void`	`setMinimumZoom(double value)` Sets the minimum zoom factor for this `CanvasControl`.
`void`	`setMouseEventConsumingDisabled(boolean mouseEventConsumingDisabled)` Sets the behavior of consuming mouse events during the bubbling phase.
`void`	`setMouseWheelBehavior(MouseWheelBehaviors value)` Determines the behavior of the mouse wheel.
`void`	`setMouseWheelScrollFactor(double value)` Sets a factor that controls how fast the viewport scrolls when the mouse wheel is turned.
`void`	`setMouseWheelZoomFactor(double value)` Sets the factor by which the zoom level changes when the mouse wheel is turned.
`void`	`setNavigationCommandsEnabled(boolean value)` Sets a value indicating whether navigation related command bindings are enabled.
`void`	`setOnCompoundKeyPressed(EventHandler<? super CompoundKeyEvent> value)` Sets the value of the property onCompoundKeyPressed.
`void`	`setOnCompoundKeyReleased(EventHandler<? super CompoundKeyEvent> value)` Sets the value of the property onCompoundKeyReleased.
`void`	`setOnCompoundKeyTyped(EventHandler<? super CompoundKeyEvent> value)` Sets the value of the property onCompoundKeyTyped.
`void`	`setOnMouse2DClicked(EventHandler<? super Mouse2DEvent> value)` Sets the value of the property onMouse2DClicked.
`void`	`setOnMouse2DDragged(EventHandler<? super Mouse2DEvent> value)` Sets the value of the property onMouse2DDragged.
`void`	`setOnMouse2DEntered(EventHandler<? super Mouse2DEvent> value)` Sets the value of the property onMouse2DEntered.
`void`	`setOnMouse2DExited(EventHandler<? super Mouse2DEvent> value)` Sets the value of the property onMouse2DExited.
`void`	`setOnMouse2DMoved(EventHandler<? super Mouse2DEvent> value)` Sets the value of the property onMouse2DMoved.
`void`	`setOnMouse2DPressed(EventHandler<? super Mouse2DEvent> value)` Sets the value of the property onMouse2DPressed.
`void`	`setOnMouse2DReleased(EventHandler<? super Mouse2DEvent> value)` Sets the value of the property onMouse2DReleased.
`void`	`setOnMouse2DWheelTurned(EventHandler<? super Mouse2DEvent> value)` Sets the value of the property onMouse2DWheelTurned.
`void`	`setScrollCommandAnimationEnabled(boolean value)` Sets a value indicating whether `ICommand`s for scrolling like for example `ICommand.SCROLL_PAGE_DOWN`, the scrolling should be performed in animated fashion.
`void`	`setSelectionGroup(ICanvasObjectGroup value)` Sets the SelectionGroup property.
`static void`	`setTemplateLocation(Node visual, PointD viewCoordinates)` Moves a node to the given coordinates.
`void`	`setVerticalScrollBarPolicy(ScrollPane.ScrollBarPolicy value)` Specifies the visibility policy for the vertical scrollbar.
`void`	`setViewPoint(PointD value)` Sets the current view point.
`void`	`setViewportLimiter(ViewportLimiter value)` Sets the `ViewportLimiter` instance that can be used to limit the explorable region.
`void`	`setVisualCaching(VisualCachingPolicy value)` Sets the policy for caching `Node`s which are temporarily removed from the visual tree.
`void`	`setZoom(double value)` Sets the zoom factor for this `CanvasControl`.
`void`	`setZoomAnimationDuration(Duration duration)` Sets the duration of the zooming animation.
`void`	`setZoomAnimationEnabled(boolean value)` Sets a value indicating whether zooming operations (e.g. turning the mouse wheel, executing `ICommand.ZOOM` etc.) should be performed in animated fashion.
`ReadOnlyDoubleProperty`	`smallHorizontalChangeProperty()` Returns a `DoubleProperty` that holds the step size by which the horizontal scroll bar is changed when calling `ScrollBar.increment()` or `ScrollBar.decrement()`.
`ReadOnlyDoubleProperty`	`smallVerticalChangeProperty()` Returns a `DoubleProperty` that holds the step size by which the vertical scroll bar is changed when calling `ScrollBar.increment()` or `ScrollBar.decrement()`.
`PointD`	`toViewCoordinates(PointD worldPoint)` Converts world coordinates to view coordinates expressed in the control's coordinate system.
`PointD`	`toWorldCoordinates(PointD viewPoint)` Converts view coordinates (expressed in the control's coordinate system) to world coordinates.
`void`	`updateContentRect()` Updates the `ContentRect` to encompass the bounds by all elements in the current scene graph plus the given margins.
`void`	`updateContentRect(InsetsD margins)` Updates the `ContentRect` to encompass the bounds by all elements in the current scene graph plus the given margins.
`void`	`updateContentRect(InsetsD margins, ICanvasObjectGroup group)` Updates the `ContentRect` to encompass the bounds by all elements in the current scene graph plus the given margins.
`void`	`updateImmediately()` Updates the visual tree that displays the contents of this control.
`DoubleProperty`	`verticalOffsetProperty()` Returns a `DoubleProperty` that holds the current value of the vertical scroll bar.
`ObjectProperty<ScrollPane.ScrollBarPolicy>`	`verticalScrollBarPolicyProperty()` Returns an `ObjectProperty` that holds the visibility policy for the vertical scroll bar.
`ObjectProperty<PointD>`	`viewPointProperty()` Returns an `ObjectProperty` that holds current view point.
`ReadOnlyDoubleProperty`	`viewportHeightProperty()` Returns a `DoubleProperty` that holds the height of the current viewport.
`ReadOnlyObjectPropertyBase<RectD>`	`viewportProperty()` The property for the `view port`.
`ReadOnlyDoubleProperty`	`viewportWidthProperty()` Returns a `DoubleProperty` that holds the width of the current viewport.
`DoubleProperty`	`zoomProperty()` Gets a `DoubleProperty` that holds the current zoom factor for this canvas control.
`void`	`zoomTo(PointD center, double zoom)` Sets the zoom level and view port center to the given values.
`void`	`zoomTo(RectD bounds)` Sets the zoom level and view port center so that the given rectangle in world coordinates fits the viewport.

Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

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

Methods inherited from interface com.yworks.yfiles.graph.ILookup
createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, safeLookup

- Property Detail
  - autoDragEnabled
```
public final BooleanProperty autoDragEnabledProperty
```
    A property that causes the control to automatically pan the view when the mouse gets dragged outside of the bounds of the control.
  - autoDragInsets
```
public final ObjectProperty<InsetsD> autoDragInsetsProperty
```
    The property for the auto drag insets.
    
    Returns:
  - centerZoomEventRecognizer
```
public final ObjectProperty<IEventRecognizer> centerZoomEventRecognizerProperty
```
    The property for the getCenterZoomEventRecognizer() event recognizer} that determines whether the zooming to the center of the view, rather than at the mouse location should be used.
  - computedHorizontalScrollBarState
```
public final ReadOnlyIntegerProperty computedHorizontalScrollBarStateProperty
```
    Returns an IntegerProperty that holds the state of the horizontal scroll bar. State can be any combination of SCROLL_BAR_ENABLED and SCROLL_BAR_VISIBLE.
    
    Returns:
    
    the state property of the horizontal scroll bar.
  - computedVerticalScrollBarState
```
public final ReadOnlyIntegerProperty computedVerticalScrollBarStateProperty
```
    Returns an IntegerProperty that holds the state of the vertical scroll bar. State can be any combination of SCROLL_BAR_ENABLED and SCROLL_BAR_VISIBLE.
    
    Returns:
    
    the state property of the vertical scroll bar.
  - contentRect
```
public final ObjectProperty<RectD> contentRectProperty
```
    Returns an ObjectProperty that holds a rectangle containing the whole graph content of this CanvasControl.
    
    Returns:
    
    the content rectangle property of the canvas control.
  - doubleClickSize
```
public final ObjectProperty<SizeD> doubleClickSizeProperty
```
    The property for the area in view coordinates the mouse needs to stay in before multiple clicks are considered multiple single clicks instead of multi-clicks.
  - doubleClickTime
```
public final ObjectProperty<Duration> doubleClickTimeProperty
```
    The property for the double click time that indicates the amount of time that may pass within which two subsequent mouse clicks are considered multi clicks.
  - doubleTapDuration
```
public final ObjectProperty<Duration> doubleTapDurationProperty
```
    The property for the double tap time that indicates the amount of time that may pass within which two subsequent touch taps are considered multi taps.
  - doubleTapSize
```
public final ObjectProperty<SizeD> doubleTapSizeProperty
```
    The property for the area in view coordinates the touch pointer needs to stay in before multiple taps are considered multiple single taps instead of multi-taps.
  - dragSize
```
public final ObjectProperty<SizeD> dragSizeProperty
```
    The property for the the area in view coordinates the mouse may stay in before a movement is considered a drag.
  - dragTime
```
public final ObjectProperty<Duration> dragTimeProperty
```
    The property for the drag time that indicates the amount of time that may pass before a mouse movement is considered a drag when the mouse stays within its DragSize area.
  - editable
```
public final BooleanProperty editableProperty
```
    Property that sets the editable state of this canvas. IInputMode implementations should honor this property. Events will still be delivered to the IInputModes, however they should not modify the model.
    
    Returns:
    
    The Editable.
    
    See Also:
    
    setEditable(boolean)
  - fitContentViewMargins
```
public final ObjectProperty<InsetsD> fitContentViewMarginsProperty
```
    The property for the insets in view coordinates that should be used by the fitContent() operation.
  - hitTestRadius
```
public final DoubleProperty hitTestRadiusProperty
```
    The property for the radius of the area around the mouse in view coordinates in which a IHitTestable may lie to be considered a valid hit.
  - horizontalOffset
```
public final DoubleProperty horizontalOffsetProperty
```
    Returns a DoubleProperty that holds the current value of the horizontal scroll bar.
    
    Returns:
    
    the horizontal scroll bar's value property.
  - horizontalScrollBarPolicy
```
public final ObjectProperty<ScrollPane.ScrollBarPolicy> horizontalScrollBarPolicyProperty
```
    Returns an ObjectProperty that holds the visibility policy for the horizontal scroll bar. Scroll bars don't need to be displayed in order to move the viewport. This can be achieved programmatically or using special IInputMode instances. The default is ScrollPane.ScrollBarPolicy#AS_NEEDED.
    
    Returns:
    
    the vertical scroll bar visibility property.
    
    See Also:
    
    MoveViewportInputMode, getHorizontalScrollBarPolicy(), ScrollPane.ScrollBarPolicy#ALWAYS, ScrollPane.ScrollBarPolicy#AS_NEEDED, ScrollPane.ScrollBarPolicy#NEVER
  - inputMode
```
public final ObjectProperty<IInputMode> inputModeProperty
```
    The property for the the single input mode instance that is installed in this canvas.
  - largeHorizontalChange
```
public final ReadOnlyDoubleProperty largeHorizontalChangeProperty
```
    Returns a DoubleProperty that holds the change of the horizontal scroll bar when the track of the bar is clicked.
    
    Returns:
    
    the of the horizontal scroll bar when the track of the bar is clicked.
  - largeVerticalChange
```
public final ReadOnlyDoubleProperty largeVerticalChangeProperty
```
    Returns a DoubleProperty that holds the change of the vertical scroll bar when the track of the bar is clicked.
    
    Returns:
    
    the of the vertical scroll bar when the track of the bar is clicked.
  - longPressDuration
```
public final ObjectProperty<Duration> longPressDurationProperty
```
    The property for the long press time that indicates the amount of time that may pass before a touch down is considered a long press when the pointer stays within its getDragSize() area.
  - maximumHorizontalOffset
```
public final ReadOnlyDoubleProperty maximumHorizontalOffsetProperty
```
    Returns a DoubleProperty that holds the the maximum value for the vertical scroll bar.
    
    Returns:
    
    the maximum value vor the vertical scroll bar.
  - maximumVerticalOffset
```
public final ReadOnlyDoubleProperty maximumVerticalOffsetProperty
```
    Returns a DoubleProperty that holds the maximum value for the vertical scroll bar.
    
    Returns:
    
    the maximum vertical scroll bar value property.
  - maximumZoom
```
public final DoubleProperty maximumZoomProperty
```
    Returns a DoubleProperty that holds the maximum zoom level that is valid for this canvas control. This property sets an upper bound for the allowed values of the getZoom(). Default value is 1000d.
    
    Returns:
    
    the maximum zoom level.
    
    See Also:
    
    getZoom(), getMinimumZoom()
  - minimumHorizontalOffset
```
public final ReadOnlyDoubleProperty minimumHorizontalOffsetProperty
```
    Returns a DoubleProperty that holds the minimum value for the horizontal scroll bar.
    
    Returns:
    
    the minimum horizontal scroll bar value property.
  - minimumVerticalOffset
```
public final ReadOnlyDoubleProperty minimumVerticalOffsetProperty
```
    Returns a DoubleProperty that holds the minimum value for the vertical scroll bar.
    
    Returns:
    
    the minimum vertical scroll bar value property.
  - minimumZoom
```
public final DoubleProperty minimumZoomProperty
```
    Returns a DoubleProperty that holds the minimum the minimum zoom level for this canvas control. This property sets a lower bound for the allowed values of the getZoom() property. If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates. The default is 0.01d but values as small as 0.0000001d are possible.
    
    Returns:
    
    the minimum zoom level.
    
    See Also:
    
    getZoom(), getMaximumZoom()
  - mouseEventConsumingDisabled
```
public final BooleanProperty mouseEventConsumingDisabledProperty
```
    Defines whether consuming mouse events during the bubbling phase for this control is disabled or not. If set to true, parents of the CanvasControl receive mouse events in the bubbling phase. This can lead to unwanted behavior, e.g. the CanvasControl losing focus and thus not receiving input events and so on.
    Per default, this property is set to false.
  - mouseWheelBehavior
```
public final ObjectProperty<MouseWheelBehaviors> mouseWheelBehaviorProperty
```
    The property for the behavior of the mouse wheel.
  - mouseWheelScrollFactor
```
public final DoubleProperty mouseWheelScrollFactorProperty
```
    The property for the factor that controls how fast the viewport scrolls when the mouse wheel is turned.
  - mouseWheelZoomFactor
```
public final DoubleProperty mouseWheelZoomFactorProperty
```
    The property for the factor by which the zoom level changes when the mouse wheel is turned.
  - navigationCommandsEnabled
```
public final BooleanProperty navigationCommandsEnabledProperty
```
    The property for the value indicating whether navigation related command bindings are enabled.
  - onCompoundKeyPressed
```
public final ObjectProperty<EventHandler<? super CompoundKeyEvent>> onCompoundKeyPressedProperty
```
    Defines a function to be called when the user has pressed a key on the CanvasControl.
    This event delivers CompoundKeyEvent.
  - onCompoundKeyReleased
```
public final ObjectProperty<EventHandler<? super CompoundKeyEvent>> onCompoundKeyReleasedProperty
```
    Defines a function to be called when the user has released a key on the CanvasControl.
    This event delivers CompoundKeyEvent.
  - onCompoundKeyTyped
```
public final ObjectProperty<EventHandler<? super CompoundKeyEvent>> onCompoundKeyTypedProperty
```
    Defines a function to be called when the user has typed a key on the CanvasControl.
    This event delivers CompoundKeyEvent.
  - onMouse2DClicked
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DClickedProperty
```
    Defines a function to be called when the user has clicked on the CanvasControl with the mouse. This happens if press and release happens at the same position.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DDragged
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DDraggedProperty
```
    Defines a function to be called when the mouse has been dragged over the CanvasControl, i.e. the mouse is being moved while at least one of the mouse buttons is pressed.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DEntered
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DEnteredProperty
```
    Defines a function to be called when the mouse has entered the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DExited
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DExitedProperty
```
    Defines a function to be called when the mouse has exited the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DMoved
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DMovedProperty
```
    Defines a function to be called when the mouse has been moved in the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function. Move events are delivered if no mouse button is pressed. This event will be fired, too, if the mouse does not move but the world coordinates to which the current mouse position maps change. E.g. this will happen if the zoom level or the view point is changed.
  - onMouse2DPressed
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DPressedProperty
```
    Defines a function to be called when the mouse has been pressed in the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DReleased
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DReleasedProperty
```
    Defines a function to be called when the mouse has been released on the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DWheelTurned
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DWheelTurnedProperty
```
    Defines a function to be called when the mouse wheel has turned over the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - scrollCommandAnimationEnabled
```
public final BooleanProperty scrollCommandAnimationEnabledProperty
```
    The property for the value that indicates if scrolling should be animated.
  - smallHorizontalChange
```
public final ReadOnlyDoubleProperty smallHorizontalChangeProperty
```
    Returns a DoubleProperty that holds the step size by which the horizontal scroll bar is changed when calling ScrollBar.increment() or ScrollBar.decrement().
    
    Returns:
    
    the step size by which the horizontal scroll bar is changed.
  - smallVerticalChange
```
public final ReadOnlyDoubleProperty smallVerticalChangeProperty
```
    Returns a DoubleProperty that holds the step size by which the vertical scroll bar is changed when calling ScrollBar.increment() or ScrollBar.decrement().
    
    Returns:
    
    the step size by which the vertical scroll bar is changed.
  - verticalOffset
```
public final DoubleProperty verticalOffsetProperty
```
    Returns a DoubleProperty that holds the current value of the vertical scroll bar.
    
    Returns:
    
    the vertical scroll bar's value property.
  - verticalScrollBarPolicy
```
public final ObjectProperty<ScrollPane.ScrollBarPolicy> verticalScrollBarPolicyProperty
```
    Returns an ObjectProperty that holds the visibility policy for the vertical scroll bar. Scroll bars don't need to be displayed in order to move the viewport. This can be achieved programmatically or using special IInputMode instances. The default is ScrollPane.ScrollBarPolicy#AS_NEEDED.
    
    Returns:
    
    the vertical scroll bar visibility property.
    
    See Also:
    
    MoveViewportInputMode, getHorizontalScrollBarPolicy(), ScrollPane.ScrollBarPolicy#ALWAYS, ScrollPane.ScrollBarPolicy#AS_NEEDED, ScrollPane.ScrollBarPolicy#NEVER
  - viewPoint
```
public final ObjectProperty<PointD> viewPointProperty
```
    Returns an ObjectProperty that holds current view point. The view point is the point in world coordinates that is mapped to the top left corner point in the current viewport.
    
    Returns:
    
    the view point property.
  - viewportHeight
```
public final ReadOnlyDoubleProperty viewportHeightProperty
```
    Returns a DoubleProperty that holds the height of the current viewport.
  - viewport
```
public final ReadOnlyObjectPropertyBase<RectD> viewportProperty
```
    The property for the view port.
    The view port is the visible portion of the world rectangle in the world coordinate system.
    
    See Also:
    
    getViewport()
  - viewportWidth
```
public final ReadOnlyDoubleProperty viewportWidthProperty
```
    Returns a DoubleProperty that holds the width of the current viewport.
  - zoom
```
public final DoubleProperty zoomProperty
```
    Gets a DoubleProperty that holds the current zoom factor for this canvas control.
    A zoom level of 1.0f will make each unit in world-coordinate space appear exactly one unit in screen coordinates wide. The default is 1.0f. If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates.
    
    The valid range is bounded by getMinimumZoom() and getMaximumZoom()
    
    Returns:
    
    The Zoom.@see com.yworks.yfiles.canvas.CanvasControl#onZoomChanged(com.yworks.util.EventArgs)
    
    See Also:
    
    getMinimumZoom(), getMaximumZoom()
- Field Detail
  - SCROLL_BAR_ENABLED
```
public static final int SCROLL_BAR_ENABLED
```
    Constant to describe the state of a scroll bar. When the scroll bar is enabled, it is able to receive mouse input and can be displayed.
    
    See Also:
    
    Constant Field Values
  - SCROLL_BAR_VISIBLE
```
public static final int SCROLL_BAR_VISIBLE
```
    Constant that describes the state of a scroll bar. When the scroll bar is visible, will be displayed at the bottom and on the right of the canvas control.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CanvasControl
```
public CanvasControl()
```
    Creates a new instance of CanvasControl.
    The canvas will be empty with no associated InputModes.
- Method Detail
  - addBackgroundGroupChangedListener
```
public final void addBackgroundGroupChangedListener(IEventHandler backgroundGroupChangedEvent)
```
    Adds the given listener for the BackgroundGroupChanged event that occurs when the BackgroundGroup property has been changed.
    
    Parameters:
    
    backgroundGroupChangedEvent - The listener to add.
    
    See Also:
    
    removeBackgroundGroupChangedListener(IEventHandler)
  - addContentGroupChangedListener
```
public final void addContentGroupChangedListener(IEventHandler contentGroupChangedEvent)
```
    Adds the given listener for the ContentGroupChanged event that occurs when the ContentGroup property has been changed.
    
    Parameters:
    
    contentGroupChangedEvent - The listener to add.
    
    See Also:
    
    removeContentGroupChangedListener(IEventHandler)
  - addFocusGroupChangedListener
```
public final void addFocusGroupChangedListener(IEventHandler focusGroupChangedEvent)
```
    Adds the given listener for the FocusGroupChanged event that occurs when the FocusGroup property has been changed.
    
    Parameters:
    
    focusGroupChangedEvent - The listener to add.
    
    See Also:
    
    removeFocusGroupChangedListener(IEventHandler)
  - addHighlightGroupChangedListener
```
public final void addHighlightGroupChangedListener(IEventHandler highlightGroupChangedEvent)
```
    Adds the given listener for the HighlightGroupChanged event that occurs when the HighlightGroup property has been changed.
    
    Parameters:
    
    highlightGroupChangedEvent - The listener to add.
    
    See Also:
    
    removeHighlightGroupChangedListener(IEventHandler)
  - addInputModeContextChangedListener
```
public final void addInputModeContextChangedListener(IEventHandler<PropertyChangedEventArgs> inputModeContextChangedEvent)
```
    Adds the given listener for the InputModeContextChanged event that occurs when the InputModeContext property has been changed.
    
    Parameters:
    
    inputModeContextChangedEvent - The listener to add.
    
    See Also:
    
    removeInputModeContextChangedListener(IEventHandler)
  - addInputModeGroupChangedListener
```
public final void addInputModeGroupChangedListener(IEventHandler inputModeGroupChangedEvent)
```
    Adds the given listener for the InputModeGroupChanged event that occurs when the InputModeGroup property has been changed.
    
    Parameters:
    
    inputModeGroupChangedEvent - The listener to add.
    
    See Also:
    
    removeInputModeGroupChangedListener(IEventHandler)
  - addSelectionGroupChangedListener
```
public final void addSelectionGroupChangedListener(IEventHandler selectionGroupChangedEvent)
```
    Adds the given listener for the SelectionGroupChanged event that occurs when the SelectionGroup property has been changed.
    
    Parameters:
    
    selectionGroupChangedEvent - The listener to add.
    
    See Also:
    
    removeSelectionGroupChangedListener(IEventHandler)
  - animateScrollTo
```
public void animateScrollTo(PointD viewPoint,
                            double zoom)
```
    Scrolls to the provided view point and zoom level in an animated fashion.
    
    Parameters:
    
    viewPoint - The new ViewPoint
    
    zoom - The new zoom level.
  - autoDragEnabledProperty
```
public final BooleanProperty autoDragEnabledProperty()
```
    A property that causes the control to automatically pan the view when the mouse gets dragged outside of the bounds of the control.
  - autoDragInsetsProperty
```
public final ObjectProperty<InsetsD> autoDragInsetsProperty()
```
    The property for the auto drag insets.
    
    Returns:
  - centerZoomEventRecognizerProperty
```
public final ObjectProperty<IEventRecognizer> centerZoomEventRecognizerProperty()
```
    The property for the getCenterZoomEventRecognizer() event recognizer} that determines whether the zooming to the center of the view, rather than at the mouse location should be used.
  - coerceViewportLimits
```
public void coerceViewportLimits()
```
    Helper method that ensures that the view port limit as returned by the ViewportLimiter are obeyed.
    This method will zoomTo(RectD) the limited bounds if necessary.
    
    See Also:
    
    getViewportLimiter()
  - compareRenderOrder
```
public final int compareRenderOrder(ICanvasObject canvasObject1,
                                    ICanvasObject canvasObject2)
```
    Compares two ICanvasObject instances that are live in this canvas.
    The comparison will yield values greater than zero if and only if the second object is rendered after the first one.
    
    Parameters:
    
    canvasObject1 - the first object to compare
    
    canvasObject2 - the second object to compare
    
    Returns:
    
    0 if canvasObject1 == canvasObject2
    >0 if canvasObject1 is painted before canvasObject2 <0 if canvasObject1 is painted after canvasObject2
  - computedHorizontalScrollBarStateProperty
```
public final ReadOnlyIntegerProperty computedHorizontalScrollBarStateProperty()
```
    Returns an IntegerProperty that holds the state of the horizontal scroll bar. State can be any combination of SCROLL_BAR_ENABLED and SCROLL_BAR_VISIBLE.
    
    Returns:
    
    the state property of the horizontal scroll bar.
  - computedVerticalScrollBarStateProperty
```
public final ReadOnlyIntegerProperty computedVerticalScrollBarStateProperty()
```
    Returns an IntegerProperty that holds the state of the vertical scroll bar. State can be any combination of SCROLL_BAR_ENABLED and SCROLL_BAR_VISIBLE.
    
    Returns:
    
    the state property of the vertical scroll bar.
  - contentRectProperty
```
public final ObjectProperty<RectD> contentRectProperty()
```
    Returns an ObjectProperty that holds a rectangle containing the whole graph content of this CanvasControl.
    
    Returns:
    
    the content rectangle property of the canvas control.
  - createBackgroundGroup
```
protected ICanvasObjectGroup createBackgroundGroup()
```
    Factory method for the BackgroundGroup property.
    This method will be called upon first access to the BackgroundGroup property.
    
    Returns:
    
    a new instance of ICanvasObjectGroup
  - createContentGroup
```
protected ICanvasObjectGroup createContentGroup()
```
    Factory method for the ContentGroup property.
    This method will be called upon first access to the ContentGroup property.
    
    Returns:
    
    a new instance of ICanvasObjectGroup
  - createFocusGroup
```
protected ICanvasObjectGroup createFocusGroup()
```
    Factory method for the FocusGroup property.
    This method will be called upon first access to the FocusGroup property.
    
    Returns:
    
    a new instance of ICanvasObjectGroup
  - createHighlightGroup
```
protected ICanvasObjectGroup createHighlightGroup()
```
    Factory method for the HighlightGroup property.
    This method will be called upon first access to the HighlightGroup property.
    
    Returns:
    
    a new instance of ICanvasObjectGroup
  - createInputModeContext
```
protected IInputModeContext createInputModeContext()
```
    Factory method for the InputModeContext property.
    This method will be called upon first access to the InputModeContext property.
    
    Returns:
    
    a new instance of InputModeContext that has this instance set as it's CanvasControl and uses this instance's inputModeContextLookup(Class) callback to satisfy requests.
  - createInputModeGroup
```
protected ICanvasObjectGroup createInputModeGroup()
```
    Factory method for the InputModeGroup property.
    This method will be called upon first access to the InputModeGroup property.
    
    Returns:
    
    a new instance of ICanvasObjectGroup
  - createRenderContext
```
public IRenderContext createRenderContext()
```
    Creates an appropriate render context that can be used to create visuals using IVisualCreator implementations.
    This method is a convenience method to obtain a context for special visual creator implementations and normally needs not be used by application developers.
    
    Returns:
    
    A new context instance that is bound to this instance.
  - createSelectionGroup
```
protected ICanvasObjectGroup createSelectionGroup()
```
    Factory method for the SelectionGroup property.
    This method will be called upon first access to the SelectionGroup property.
    
    Returns:
    
    a new instance of ICanvasObjectGroup
  - createVisualFromTemplate
```
public static final Node createVisualFromTemplate(IVisualTemplate template,
                                                  PointD origin,
                                                  IRenderContext context)
```
    Creates a visual representation (Node) using the given template.
    
    Parameters:
    
    template - the template for the new Node.
    
    origin -
  - createVisualFromTemplate
```
public static final Node createVisualFromTemplate(IVisualTemplate template,
                                                  PointD origin,
                                                  IRenderContext context,
                                                  RectD initialBounds)
```
    Creates a visual representation (Node) using the given template.
    
    Parameters:
    
    template - the template for the new Node.
    
    origin -
  - createVisualFromTemplate
```
public static final Node createVisualFromTemplate(IVisualTemplate template,
                                                  PointD origin,
                                                  IRenderContext context,
                                                  RectD initialBounds,
                                                  Object dataObject)
```
    Creates a visual representation (Node) using the given template.
    
    Parameters:
    
    template - the template for the new Node.
    
    origin -
  - doubleClickSizeProperty
```
public final ObjectProperty<SizeD> doubleClickSizeProperty()
```
    The property for the area in view coordinates the mouse needs to stay in before multiple clicks are considered multiple single clicks instead of multi-clicks.
  - doubleClickTimeProperty
```
public final ObjectProperty<Duration> doubleClickTimeProperty()
```
    The property for the double click time that indicates the amount of time that may pass within which two subsequent mouse clicks are considered multi clicks.
  - doubleTapDurationProperty
```
public final ObjectProperty<Duration> doubleTapDurationProperty()
```
    The property for the double tap time that indicates the amount of time that may pass within which two subsequent touch taps are considered multi taps.
  - doubleTapSizeProperty
```
public final ObjectProperty<SizeD> doubleTapSizeProperty()
```
    The property for the area in view coordinates the touch pointer needs to stay in before multiple taps are considered multiple single taps instead of multi-taps.
  - dragSizeProperty
```
public final ObjectProperty<SizeD> dragSizeProperty()
```
    The property for the the area in view coordinates the mouse may stay in before a movement is considered a drag.
  - dragTimeProperty
```
public final ObjectProperty<Duration> dragTimeProperty()
```
    The property for the drag time that indicates the amount of time that may pass before a mouse movement is considered a drag when the mouse stays within its DragSize area.
  - editableProperty
```
public final BooleanProperty editableProperty()
```
    Property that sets the editable state of this canvas. IInputMode implementations should honor this property. Events will still be delivered to the IInputModes, however they should not modify the model.
    
    Returns:
    
    The Editable.
    
    See Also:
    
    setEditable(boolean)
  - exportContent
```
public Node exportContent(IRenderContext context)
```
    Exports the graphical content for this CanvasControl.
    This method will create the visual content using the world coordinate system.
    
    Parameters:
    
    context - The context to use.
    
    Returns:
    
    A composite Visual that represents the contents of this control.
  - fitContent
```
public void fitContent()
```
    Adjusts the view port to fully encompass the ContentRect.
    The zoom level will not be greater than 1.0d (see the remarks). If the view port is limited by the ViewportLimiter the zoom level might be greater than 1.0d to respect the limits.
    
    See Also:
    
    updateContentRect(InsetsD, ICanvasObjectGroup), getZoom(), zoomTo(PointD, double)
  - fitContentViewMarginsProperty
```
public final ObjectProperty<InsetsD> fitContentViewMarginsProperty()
```
    The property for the insets in view coordinates that should be used by the fitContent() operation.
  - getAutoDragInsets
```
public final InsetsD getAutoDragInsets()
```
    Gets the auto drag insets.
    If the mouse is being dragged within the insets of the control specified using this property, the control will automatically scroll.
    
    Returns:
    
    The new auto drag insets.
    
    See Also:
    
    isAutoDragEnabled(), setAutoDragInsets(InsetsD)
  - getBackgroundGroup
```
public final ICanvasObjectGroup getBackgroundGroup()
```
    Gets the BackgroundGroup property.
    The background group is the ICanvasObjectGroup that should be used by the application code to put background elements in.
    
    If the field has not yet been initialized upon first access, the factory method createBackgroundGroup() will be called. Upon change the onBackgroundGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Returns:
    
    The BackgroundGroup.
    
    See Also:
    
    getContentGroup(), setBackgroundGroup(ICanvasObjectGroup)
  - getBounds
```
public final RectD getBounds(ICanvasObject canvasObject)
```
    Convenience method that calculates the bounds for a given canvas object in the scene graph.
    This method queries the descriptor for the IBoundsProvider for the user object and returns the result.
    
    Parameters:
    
    canvasObject - the canvas object to query the bounds from
    
    Returns:
    
    the non-null bounds
  - getCanvasContext
```
public final ICanvasContext getCanvasContext()
```
    Returns an implementation of ICanvasContext that describes the state of this CanvasControl.
    
    Returns:
    
    The CanvasContext.
    
    See Also:
    
    IHitTestable, IBoundsProvider
  - getCanvasObject
```
public final ICanvasObject getCanvasObject(PointD location)
```
    Returns the top most canvas object instance that is hit at the given coordinate set.
    This will return the canvas object that is painted last at the given position.
    
    Parameters:
    
    location - the coordinates of the query in the world coordinate system
  - getCanvasObjects
```
public final IEnumerable<ICanvasObject> getCanvasObjects()
```
    Enumerates over all possible ICanvasObject instances in the tree.
    
    Returns:
    
    An enumerable for all ICanvasObjects in the tree.
  - getCanvasObjects
```
public final IEnumerable<ICanvasObject> getCanvasObjects(ICanvasObjectGroup group)
```
    Enumerates over all possible ICanvasObject instances in the tree below the given group.
    
    Returns:
    
    An enumerable for all ICanvasObjects in the tree below the given group.
  - getCanvasObjects
```
public final IEnumerable<ICanvasObject> getCanvasObjects(PointD location)
```
    Returns a list of all canvas objects in hit order at the given world coordinate location.
    The order of the elements in the list is the natural hit test order, i.e. elements painted on top of others will be reported first in the list.
    
    Parameters:
    
    location - the coordinates of the query in the world coordinate system
    
    Returns:
    
    an enumerable of canvas object that are hit in reverse painting order
  - getCenter
```
public final PointD getCenter()
```
    Gets the world coordinate at the center of the control.
    This can be used to move the view port.
    
    Returns:
    
    The Center.
    
    See Also:
    
    setCenter(PointD)
  - getCenterZoomEventRecognizer
```
public final IEventRecognizer getCenterZoomEventRecognizer()
```
    Specifies an IEventRecognizer that determines whether the zooming to the center of the view, rather than at the mouse location should be used.
    The default is IEventRecognizer.SHORTCUT_PRESSED.
    
    Returns:
    
    The CenterZoomEventRecognizer.
    
    See Also:
    
    setCenterZoomEventRecognizer(IEventRecognizer)
  - getComputedHorizontalScrollBarState
```
public final int getComputedHorizontalScrollBarState()
```
    Determines the state of the horizontal scroll bar. State can be any combination of SCROLL_BAR_ENABLED and SCROLL_BAR_VISIBLE.
    
    Returns:
    
    the state of the horizontal scroll bar.
  - getComputedVerticalScrollBarState
```
public final int getComputedVerticalScrollBarState()
```
    Determines the state of the vertical scroll bar. State can be any combination of SCROLL_BAR_ENABLED and SCROLL_BAR_VISIBLE.
    
    Returns:
    
    the state of the vertical scroll bar.
  - getContentGroup
```
public final ICanvasObjectGroup getContentGroup()
```
    Gets the ContentGroup property.
    The content group is the ICanvasObjectGroup that should be used by the application code to put actual content in.
    
    If the field has not yet been initialized upon first access, the factory method createContentGroup() will be called. Upon change the onContentGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Returns:
    
    The ContentGroup.
    
    See Also:
    
    setContentGroup(ICanvasObjectGroup)
  - getContentRect
```
public final RectD getContentRect()
```
    Gets the Rectangle in world coordinates that holds the contents.
    This influences the display of the scroll bars. If the content rectangle is not currently visible in the viewport, scroll bars will be displayed, unless they are turned off completely. Note that in general the content rectangle is not updated automatically but declared as a fixed rectangle. Rather the application programmer needs to set this value or call respective automatic update methods.
    
    Returns:
    
    The ContentRect.
    
    See Also:
    
    setContentRect(RectD)
  - getContentVisualGroup
```
public VisualGroup getContentVisualGroup()
```
    Returns the container holding the content of the CanvasControl.
  - getCurrentTouchDevices
```
public final IListEnumerable<Touch2DPoint> getCurrentTouchDevices()
```
    Gets a list of the active Touch2DPoints at the time of invocation.
    Note that this is not a live view, but rather a snapshot.
    
    Returns:
    
    A snapshot of the currently active Touch2DPoint instances, which may be empty.
  - getDoubleClickSize
```
public final SizeD getDoubleClickSize()
```
    The area in view coordinates the mouse needs to stay in before multiple clicks are considered multiple single clicks instead of multi-clicks.
    If the mouse stays within this within than DoubleClickTime, multiple clicks will be considered double or multi-clicks. The default value is (10, 10).
    
    Returns:
    
    The DoubleClickSize.
    
    See Also:
    
    getDoubleClickTime(), setDoubleClickSize(SizeD)
  - getDoubleClickTime
```
public final Duration getDoubleClickTime()
```
    The value of the double click time.
    This value indicates the amount of time that may pass within which two subsequent mouse clicks are considered multi clicks. The higher the value the easier it will be to double-click. The default value is 500 milliseconds.
    
    Returns:
    
    The DoubleClickTime.
    
    See Also:
    
    getDoubleClickSize(), setDoubleClickTime(Duration)
  - getDoubleTapDuration
```
public final Duration getDoubleTapDuration()
```
    Gets the value of the double tap time.
    This value indicates the amount of time that may pass within which two subsequent touch taps are considered multi taps. The higher the value the easier it will be to double-tap. The default value is 500 milliseconds.
    
    Returns:
    
    The DoubleTapDuration.
    
    See Also:
    
    getDoubleTapSize(), setDoubleTapDuration(Duration)
  - getDoubleTapSize
```
public final SizeD getDoubleTapSize()
```
    Gets the area in view coordinates the touch pointer needs to stay in before multiple taps are considered multiple single taps instead of multi-taps.
    If the touch pointer stays within this within than DoubleTapDuration, multiple taps will be considered double or multi-taps. The default value is (20, 20).
    
    Returns:
    
    The DoubleTapSize.
    
    See Also:
    
    getDoubleTapDuration(), setDoubleTapSize(SizeD)
  - getDragSize
```
public final SizeD getDragSize()
```
    Gets the area in view coordinates the mouse may stay in before a movement is considered a drag. If the mouse is moved within this area longer than DragTime milliseconds, the movement will be considered a drag, nevertheless.
    The larger the area the later a mouse movement will be recognized as a drag. This influences the click-sensitivity, since a mouse button release is only considered a click if there was no drag since the last mouse button press. The default value is (5, 5).
    
    Returns:
    
    The DragSize.
    
    See Also:
    
    getDragSize(), onMouse2DDragged(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), setDragSize(SizeD)
  - getDragTime
```
public final Duration getDragTime()
```
    Gets the value of the drag time.
    This value indicates the amount of time that may pass before a mouse movement is considered a drag when the mouse stays within its DragSize area. The higher the value the later a mouse movement will be recognized as a drag. This influences the click-sensitivity, since a mouse button release is only considered a click if there was no drag since the last mouse button press. The default value is 300 milliseconds.
    
    Returns:
    
    The DragTime.
    
    See Also:
    
    getDragSize(), onMouse2DDragged(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), setDragTime(Duration)
  - getFitContentViewMargins
```
public final InsetsD getFitContentViewMargins()
```
    Gets the insets in view coordinates that should be used by the fitContent() operation.
    This influences the amount of visible whitespace in the view coordinate system around the ContentRect after a fitContent() operation. The default value is (10,10,10,10).
    
    Note limits that are enforced by the ViewportLimiter have a higher priority than these insets.
    
    Returns:
    
    The FitContentViewMargins.
    
    See Also:
    
    setFitContentViewMargins(InsetsD)
  - getFocusGroup
```
public final ICanvasObjectGroup getFocusGroup()
```
    Gets the HighlightGroup property.
    If the field has not yet been initialized upon first access, the factory method createHighlightGroup() will be called. Upon change the onHighlightGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Returns:
    
    The FocusGroup.
    
    See Also:
    
    setFocusGroup(ICanvasObjectGroup)
  - getHighlightGroup
```
public final ICanvasObjectGroup getHighlightGroup()
```
    Gets the HighlightGroup property.
    If the field has not yet been initialized upon first access, the factory method createHighlightGroup() will be called. Upon change the onHighlightGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Returns:
    
    The HighlightGroup.
    
    See Also:
    
    setHighlightGroup(ICanvasObjectGroup)
  - getHitTestRadius
```
public final double getHitTestRadius()
```
    Specifies the radius of the area around the mouse in view coordinates in which a IHitTestable may lie to be considered a valid hit.
    This value can be queried from within the IHitTestable implementation from the HitTestRadius property. The default value is 3.0d
    
    Returns:
    
    The HitTestRadius.
    
    See Also:
    
    setHitTestRadius(double)
  - getHorizontalOffset
```
public final double getHorizontalOffset()
```
  - getHorizontalScrollBarPolicy
```
public ScrollPane.ScrollBarPolicy getHorizontalScrollBarPolicy()
```
    Specifies the visibility policy for the vertical scrollbar.
    Scrollbars don't need to be displayed in order to move the viewport. This can be achieved programmatically or using special IInputMode instances. The default is ScrollPane.ScrollBarPolicy#AS_NEEDED.
    
    Returns:
    
    The HorizontalScrollBarPolicy.
    
    See Also:
    
    MoveViewportInputMode, getVerticalScrollBarPolicy(), setHorizontalScrollBarPolicy(ScrollPane.ScrollBarPolicy)
  - getInputMode
```
public final IInputMode getInputMode()
```
    Specifies the single IInputMode instance that shall be installed for this canvas.
    
    Returns:
    
    The InputMode.
    
    See Also:
    
    setInputMode(IInputMode)
  - getInputModeContext
```
public final IInputModeContext getInputModeContext()
```
    Gets the InputModeContext property.
    This context object is passed to IInputMode instances during installation and removal.
    If the field has not yet been initialized upon first access, the factory method createInputModeContext() will be called. Upon change the onInputModeContextChanged(IInputModeContext, IInputModeContext) method will be called.
    
    Returns:
    
    The InputModeContext.
    
    See Also:
    
    setInputModeContext(IInputModeContext)
  - getInputModeContextLookupChain
```
public final LookupChain getInputModeContextLookupChain()
```
    Retrieves the LookupChain that can be used do decorate the ILookup.lookup(Class) call in the InputModeContext.
    
    Returns:
    
    The InputModeContextLookupChain.
  - getInputModeGroup
```
public final ICanvasObjectGroup getInputModeGroup()
```
    Gets the InputModeGroup property.
    This is the canvas object group where the IInputModes should add their temporary content to. This group by default is in front of the ContentGroup.
    
    If the field has not yet been initialized upon first access, the factory method createInputModeGroup() will be called. Upon change the onInputModeGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Returns:
    
    The InputModeGroup.
    
    See Also:
    
    getContentGroup(), getBackgroundGroup(), setInputModeGroup(ICanvasObjectGroup)
  - getLargeHorizontalChange
```
public final double getLargeHorizontalChange()
```
    Returns the change of the horizontal scroll bar when the track of the bar is clicked.
    
    Returns:
    
    the change of the horizontal scroll bar when the track of the bar is clicked.
  - getLargeVerticalChange
```
public final double getLargeVerticalChange()
```
    Returns the change of the vertical scroll bar when the track of the bar is clicked.
    
    Returns:
    
    the change of the vertical scroll bar when the track of the bar is clicked.
  - getLastEventLocation
```
public final PointD getLastEventLocation()
```
    Gets the last location provided by a pointing device (for instance mouse or touch).
    Unlike LastMouse2DEvent and LastTouch2DEvent this will always contain the latest location, regardless of what input method generated it.
    
    Returns:
    
    The LastEventLocation.
    
    See Also:
    
    getLastMouse2DEvent(), getLastTouch2DEvent()
  - getLastMouse2DEvent
```
public final Mouse2DEvent getLastMouse2DEvent()
```
    Gets the last mouse event triggered by this instance.
    
    Returns:
    
    The LastMouse2DEvent.
    
    See Also:
    
    onMouse2DEntered(Mouse2DEvent), onMouse2DMoved(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DPressed(Mouse2DEvent), onMouse2DReleased(Mouse2DEvent), onMouse2DDragged(Mouse2DEvent), onMouse2DWheelTurned(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent)
  - getLastTouch2DEvent
```
public final Touch2DEvent getLastTouch2DEvent()
```
    Gets the last touch event triggered by this instance.
    
    Returns:
    
    The LastTouch2DEvent.
    
    See Also:
    
    onTouch2DEntered(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DExited(Touch2DEvent), onTouch2DDown(Touch2DEvent), onTouch2DUp(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), onTouch2DTapped(Touch2DEvent)
  - getLongPressDuration
```
public final Duration getLongPressDuration()
```
    Gets the value of the long press time.
    This value indicates the amount of time that may pass before a touch down is considered a long press when the pointer stays within its DragSize area. The higher the value the later a touch pointer movement will be recognized as a long press. The default value is 1000 milliseconds.
    
    Returns:
    
    The LongPressDuration.
    
    See Also:
    
    getDragSize(), onTouch2DDown(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), setLongPressDuration(Duration)
  - getMaximumHorizontalOffset
```
public final double getMaximumHorizontalOffset()
```
    Returns the maximum value for the horizontal scroll bar.
    
    Returns:
    
    the maximum value for the horizontal scroll bar.
  - getMaximumVerticalOffset
```
public final double getMaximumVerticalOffset()
```
    Returns the maximum value for the vertical scroll bar.
    
    Returns:
    
    the maximum value for the vertical scroll bar.
  - getMaximumZoom
```
public final double getMaximumZoom()
```
    Gets the maximum zoom level that is valid for Zoom.
    Default value is 1000d
    
    Returns:
    
    The MaximumZoom.
    
    See Also:
    
    setMaximumZoom(double)
  - getMinimumHorizontalOffset
```
public final double getMinimumHorizontalOffset()
```
    Returns the minimum value for the horizontal scroll bar.
    
    Returns:
    
    the minimum value for the horizontal scroll bar.
  - getMinimumVerticalOffset
```
public final double getMinimumVerticalOffset()
```
    Returns the minimum value for the vertical scroll bar.
    
    Returns:
    
    the minimum value for the vertical scroll bar.
  - getMinimumZoom
```
public final double getMinimumZoom()
```
    Gets the minimum zoom factor for this canvas control.
    This property sets a lower bound for the allowed values of the Zoom property. If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates. The default is 0.01d but values as small as 0.0000001d are possible.
    
    Returns:
    
    The MinimumZoom.
    
    See Also:
    
    getZoom(), getMaximumZoom(), setMinimumZoom(double)
  - getMouseWheelBehavior
```
public final MouseWheelBehaviors getMouseWheelBehavior()
```
    Determines the behavior of the mouse wheel. The behavior can be switched between MouseWheelBehaviors.ZOOM, MouseWheelBehaviors.SCROLL and MouseWheelBehaviors.NONE. Additionally, this property can be configured to perform the action only when the control is focused.
    
    Returns:
    
    The MouseWheelBehavior.
    
    See Also:
    
    setMouseWheelBehavior(MouseWheelBehaviors)
  - getMouseWheelScrollFactor
```
public final double getMouseWheelScrollFactor()
```
    Gets a factor that controls how fast the viewport scrolls when the mouse wheel is turned.
    Scrolling can work either a few lines at a time (per notch of the scroll wheel) or one page at a time. This is a system setting. This property controls how many pixels represent a line if scrolling is done by line. In case scrolling is done by page, this property has no effect.
    
    The default value of 5 pixels. To speed up scrolling, set a larger value, to slow down scrolling, set a smaller value.
    
    Returns:
    
    The MouseWheelScrollFactor.
    
    See Also:
    
    getMouseWheelZoomFactor(), getMouseWheelBehavior(), Mouse2DEvent.getScrollAmount(), Mouse2DEvent.getScrollType(), setMouseWheelScrollFactor(double)
  - getMouseWheelZoomFactor
```
public final double getMouseWheelZoomFactor()
```
    Gets the factor by which the zoom level changes when the mouse wheel is turned. The default value is 1.2.
    
    Returns:
    
    The MouseWheelZoomFactor.
    
    See Also:
    
    setMouseWheelZoomFactor(double)
  - getOnCompoundKeyPressed
```
public final EventHandler<? super CompoundKeyEvent> getOnCompoundKeyPressed()
```
    Returns the value of the property onCompoundKeyPressed.
  - getOnCompoundKeyReleased
```
public final EventHandler<? super CompoundKeyEvent> getOnCompoundKeyReleased()
```
    Returns the value of the property onCompoundKeyReleased.
  - getOnCompoundKeyTyped
```
public final EventHandler<? super CompoundKeyEvent> getOnCompoundKeyTyped()
```
    Returns the value of the property onCompoundKeyTyped.
  - getOnMouse2DClicked
```
public final EventHandler<? super Mouse2DEvent> getOnMouse2DClicked()
```
    Returns the value of the property onMouse2DClicked.
  - getOnMouse2DDragged
```
public final EventHandler<? super Mouse2DEvent> getOnMouse2DDragged()
```
    Returns the value of the property onMouse2DDragged.
  - getOnMouse2DEntered
```
public final EventHandler<? super Mouse2DEvent> getOnMouse2DEntered()
```
    Returns the value of the property onMouse2DEntered.
  - getOnMouse2DExited
```
public final EventHandler<? super Mouse2DEvent> getOnMouse2DExited()
```
    Returns the value of the property onMouse2DExited.
  - getOnMouse2DMoved
```
public final EventHandler<? super Mouse2DEvent> getOnMouse2DMoved()
```
    Returns the value of the property onMouse2DMoved.
  - getOnMouse2DPressed
```
public final EventHandler<? super Mouse2DEvent> getOnMouse2DPressed()
```
    Returns the value of the property onMouse2DPressed.
  - getOnMouse2DReleased
```
public final EventHandler<? super Mouse2DEvent> getOnMouse2DReleased()
```
    Returns the value of the property onMouse2DReleased.
  - getOnMouse2DWheelTurned
```
public final EventHandler<? super Mouse2DEvent> getOnMouse2DWheelTurned()
```
    Returns the value of the property onMouse2DWheelTurned.
  - getRootGroup
```
public final ICanvasObjectGroup getRootGroup()
```
    Gets the root of the scene graph.
    This group cannot be removed.
    
    Returns:
    
    The RootGroup.
  - getSelectionGroup
```
public final ICanvasObjectGroup getSelectionGroup()
```
    Gets the SelectionGroup property.
    The selection group is the ICanvasObjectGroup that should be used by the application code to put the selection paintables in.
    
    If the field has not yet been initialized upon first access, the factory method createSelectionGroup() will be called. Upon change the onSelectionGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Returns:
    
    The SelectionGroup.
    
    See Also:
    
    setSelectionGroup(ICanvasObjectGroup)
  - getSize
```
public SizeD getSize()
```
    Returns the size of this CanvasControl.
    
    See Also:
    
    Region.getWidth(), Region.getHeight()
  - getSmallHorizontalChange
```
public final double getSmallHorizontalChange()
```
    Returns the step size by which the horizontal scroll bar is changed when calling ScrollBar.increment() or ScrollBar.decrement().
    
    Returns:
    
    the step size by which the horizontal scroll bar is changed.
  - getSmallVerticalChange
```
public final double getSmallVerticalChange()
```
    Returns the step size by which the vertical scroll bar is changed when calling ScrollBar.increment() or ScrollBar.decrement().
    
    Returns:
    
    the step size by which the vertical scroll bar is changed.
  - getVerticalOffset
```
public final double getVerticalOffset()
```
    Returns the current value of the vertical scroll bar.
    
    Returns:
    
    the current value of the vertical scroll bar.
  - getVerticalScrollBarPolicy
```
public ScrollPane.ScrollBarPolicy getVerticalScrollBarPolicy()
```
    Specifies the visibility policy for the vertical scrollbar.
    Scrollbars don't need to be displayed in order to move the viewport. This can be achieved programmatically or using special IInputMode instances. The default is ScrollPane.ScrollBarPolicy#AS_NEEDED.
    
    Returns:
    
    The VerticalScrollBarPolicy.
    
    See Also:
    
    MoveViewportInputMode, getHorizontalScrollBarPolicy(), setVerticalScrollBarPolicy(ScrollPane.ScrollBarPolicy)
  - getViewPoint
```
public final PointD getViewPoint()
```
    Gets the current view point.
    The view point is the point in world coordinates that is mapped to the top left corner point in the current viewport. Setting this point to another value will redispatch the last mouse event as the mouse will appear to have been moved or dragged in the world coordinate system.
    
    Returns:
    
    The ViewPoint.
    
    See Also:
    
    setViewPoint(PointD)
  - getViewport
```
public final RectD getViewport()
```
    Returns the currently visible viewing region in world coordinates.
    
    Returns:
    
    The Viewport.
    
    See Also:
    
    getViewPoint(), getZoom()
  - getViewportHeight
```
public final double getViewportHeight()
```
    Returns the height of the current viewport.
  - getViewportLimiter
```
public final ViewportLimiter getViewportLimiter()
```
    Gets the ViewportLimiter instance that can be used to limit the explorable region.
    By default there are no limits set on the explorable region.
    
    Returns:
    
    The ViewportLimiter.
    
    See Also:
    
    setViewportLimiter(ViewportLimiter)
  - getViewportWidth
```
public final double getViewportWidth()
```
    Returns the width of the current viewport.
  - getVisual
```
public final Node getVisual(ICanvasObject canvasObject)
```
    Gets the Node that is currently visualizing the given ICanvasObject.
    Note that depending on the current state of the viewport and the control no such instance may be available and instead this method will yield null. However if a visual is currently being displayed for the given canvas object, it will be returned. This method should be used with care. Manipulation of the given instance should normally be done through the corresponding IVisualCreator that created the visual in the first place. This method rather serves as a utility method for UI testing frameworks and similar use cases.
    
    Parameters:
    
    canvasObject - The canvas object.
    
    Returns:
    
    The Node that is currently used by the canvasObject.
  - getVisualCaching
```
public final VisualCachingPolicy getVisualCaching()
```
    Gets the policy for caching Nodes which are temporarily removed from the visual tree.
    Visuals are temporarily removed when they are moved outside the visual part of the canvas (the Viewport) and re-added when they enter the Viewport again. Caching prevents the need to re-build the visuals from scratch.
    
    Visuals are only cached if this property is set to another value than VisualCachingPolicy.NEVER and if a IDisposeVisualCallback is registered during creation.
    
    Returns:
    
    The VisualCaching.
    
    See Also:
    
    setVisualCaching(VisualCachingPolicy)
  - getVisualCreator
```
public final IVisualCreator getVisualCreator(ICanvasObject canvasObject)
```
    Convenience method that retrieves the IVisualCreator for a given ICanvasObject.
    
    Parameters:
    
    canvasObject - the canvas object to query the visual creator implementation from
    
    Returns:
    
    an instance of the visual creator interface
    
    See Also:
    
    ICanvasObjectDescriptor.getVisualCreator(Object), VoidVisualCreator.INSTANCE
  - getZoom
```
public final double getZoom()
```
    Gets the zoom factor for this CanvasControl.
    A zoom level of 1.0f will make each unit in world-coordinate space appear exactly one unit in screen coordinates wide. The default is 1.0f. If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates.
    
    The valid range is bounded by MinimumZoom and MaximumZoom
    
    Returns:
    
    The Zoom.
    
    See Also:
    
    zoomProperty(), getMinimumZoom(), getMaximumZoom(), setZoom(double)
  - getZoomAnimationDuration
```
public final Duration getZoomAnimationDuration()
```
    Gets the duration of the zooming animation. If isZoomAnimationEnabled() is set to true, this property specifies how long this animation takes.
    
    Returns:
    
    The duration of the zooming animation. The default is 0.15 seconds.
    
    See Also:
    
    isZoomAnimationEnabled(), setZoomAnimationDuration(Duration)
  - growContentRect
```
public final void growContentRect(RectD rectangle)
```
    Assures that the content rectangle encompasses the given rectangle.
    Note that this will not change the view port, it will only change the scroll bars if necessary.
    
    Parameters:
    
    rectangle - the rectangle that should be included in the content rectangle
  - hitElementsAt
```
public final IEnumerable<ICanvasObject> hitElementsAt(IInputModeContext context,
                                                      PointD location)
```
    Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the IHitTestable.isHit(IInputModeContext, PointD) method.
    Hit testing is performed using the ICanvasObjectDescriptor.getHitTestable(Object) instance returned for each visible ICanvasObject in the current scene graph. The enumeration is performed lazily.
    
    Parameters:
    
    context - The context instance to pass to IHitTestable.isHit(IInputModeContext, PointD).
    
    location - the coordinates to perform the hit test at
    
    Returns:
    
    a live enumeration of the elements that are hit
    
    See Also:
    
    IHitTestable
  - hitElementsAt
```
public final IEnumerable<ICanvasObject> hitElementsAt(IInputModeContext context,
                                                      PointD location,
                                                      ICanvasObjectGroup root)
```
    Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the IHitTestable.isHit(IInputModeContext, PointD) method.
    Hit testing is performed using the ICanvasObjectDescriptor.getHitTestable(Object) instance returned for each visible ICanvasObject in the current scene graph. The enumeration is performed lazily.
    
    Parameters:
    
    context - The context instance to pass to IHitTestable.isHit(IInputModeContext, PointD).
    
    location - the coordinates to perform the hit test at
    
    root - the root of the scene graph to use
    
    Returns:
    
    a live enumeration of the elements that are hit
    
    See Also:
    
    IHitTestable
  - hitElementsAt
```
public final IEnumerable<ICanvasObject> hitElementsAt(IInputModeContext context,
                                                      PointD location,
                                                      ICanvasObjectGroup root,
                                                      Predicate<ICanvasObject> filter)
```
    Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the IHitTestable.isHit(IInputModeContext, PointD) method.
    Hit testing is performed using the ICanvasObjectDescriptor.getHitTestable(Object) instance returned for each visible ICanvasObject in the current scene graph. The enumeration is performed lazily.
    
    Parameters:
    
    context - The context instance to pass to IHitTestable.isHit(IInputModeContext, PointD).
    
    location - the coordinates to perform the hit test at
    
    root - the root of the scene graph to use
    
    filter - The predicate that decides whether a given canvas object should be considered for testing at all or null.
    
    Returns:
    
    a live enumeration of the elements that are hit
    
    See Also:
    
    IHitTestable
  - hitElementsAt
```
public final IEnumerable<ICanvasObject> hitElementsAt(PointD location)
```
    Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.
    Hit testing is performed using the ICanvasObjectDescriptor.getHitTestable(Object) instance returned for each visible ICanvasObject in the current scene graph. The enumeration is performed lazily.
    
    Parameters:
    
    location - the coordinates to perform the hit test at
    
    Returns:
    
    a live enumeration of the elements that are hit
    
    See Also:
    
    IHitTestable, getHitTestRadius()
  - hitElementsAt
```
public final IEnumerable<ICanvasObject> hitElementsAt(PointD location,
                                                      ICanvasObjectGroup root)
```
    Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.
    Hit testing is performed using the ICanvasObjectDescriptor.getHitTestable(Object) instance returned for each visible ICanvasObject in the current scene graph. The enumeration is performed lazily.
    
    Parameters:
    
    location - the coordinates to perform the hit test at
    
    root - the root of the scene graph to use
    
    Returns:
    
    a live enumeration of the elements that are hit
    
    See Also:
    
    IHitTestable, getHitTestRadius()
  - hitElementsAt
```
public final IEnumerable<ICanvasObject> hitElementsAt(PointD location,
                                                      ICanvasObjectGroup root,
                                                      Predicate<ICanvasObject> filter)
```
    Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.
    Hit testing is performed using the ICanvasObjectDescriptor.getHitTestable(Object) instance returned for each visible ICanvasObject in the current scene graph. The enumeration is performed lazily.
    
    Parameters:
    
    location - the coordinates to perform the hit test at
    
    root - the root of the scene graph to use
    
    filter - The predicate that decides whether a given canvas object should be considered for testing at all or null.
    
    Returns:
    
    a live enumeration of the elements that are hit
    
    See Also:
    
    IHitTestable, getHitTestRadius()
  - hitTestRadiusProperty
```
public final DoubleProperty hitTestRadiusProperty()
```
    The property for the radius of the area around the mouse in view coordinates in which a IHitTestable may lie to be considered a valid hit.
  - horizontalOffsetProperty
```
public final DoubleProperty horizontalOffsetProperty()
```
    Returns a DoubleProperty that holds the current value of the horizontal scroll bar.
    
    Returns:
    
    the horizontal scroll bar's value property.
  - horizontalScrollBarPolicyProperty
```
public final ObjectProperty<ScrollPane.ScrollBarPolicy> horizontalScrollBarPolicyProperty()
```
    Returns an ObjectProperty that holds the visibility policy for the horizontal scroll bar. Scroll bars don't need to be displayed in order to move the viewport. This can be achieved programmatically or using special IInputMode instances. The default is ScrollPane.ScrollBarPolicy#AS_NEEDED.
    
    Returns:
    
    the vertical scroll bar visibility property.
    
    See Also:
    
    MoveViewportInputMode, getHorizontalScrollBarPolicy(), ScrollPane.ScrollBarPolicy#ALWAYS, ScrollPane.ScrollBarPolicy#AS_NEEDED, ScrollPane.ScrollBarPolicy#NEVER
  - inputModeContextLookup
```
protected Object inputModeContextLookup(Class type)
```
    Callback that is used by the default implementation of InputModeContext to resolve ILookup.lookup(Class) calls.
    
    Parameters:
    
    type - The Type to query
    
    Returns:
    
    The result of the query.
    
    See Also:
    
    IInputModeContext
  - inputModeProperty
```
public final ObjectProperty<IInputMode> inputModeProperty()
```
    The property for the the single input mode instance that is installed in this canvas.
  - invalidate
```
public final void invalidate()
```
    Invalidates the current control.
  - isAllKeyboardInputCapturingEnabled
```
public final boolean isAllKeyboardInputCapturingEnabled()
```
    Gets a value indicating whether all keyboard input should be captured by this control, even if it hosts UI elements that would otherwise capture those events.
    
    Returns:
    
    true if keyboard input should be captured exclusively by this control; false otherwise.
    
    See Also:
    
    isAllPointerInputCapturingEnabled(), setAllKeyboardInputCapturingEnabled(boolean)
  - isAllPointerInputCapturingEnabled
```
public final boolean isAllPointerInputCapturingEnabled()
```
    Gets a value indicating whether all mouse or touch input should be captured by this control, even if it hosts UI elements that would otherwise capture those events.
    
    Returns:
    
    true if mouse or touch input should be captured exclusively by this control; false otherwise.
    
    See Also:
    
    isAllKeyboardInputCapturingEnabled(), setAllPointerInputCapturingEnabled(boolean)
  - isAutoDragEnabled
```
public final boolean isAutoDragEnabled()
```
    Gets a property that causes the control to automatically pan the view when the mouse gets dragged outside of the bounds of the control.
    
    Returns:
    
    The AutoDragEnabled.
    
    See Also:
    
    setAutoDragEnabled(boolean)
  - isDeviceDown
```
public final boolean isDeviceDown()
```
    Checks if at least one finger is on the touch screen.
    
    Returns:
    
    True if there is at least one touch device that is down on the screen.
  - isEditable
```
public boolean isEditable()
```
    Property that sets the editable state of this canvas.
    IInputMode implementations should honor this property. Events will still be delivered to the IInputModes, however they should not modify the model.
    
    Returns:
    
    The Editable.
    
    See Also:
    
    setEditable(boolean)
  - isHit
```
public final boolean isHit(ICanvasObject canvasObject,
                           PointD location)
```
    Convenience method that calculates the hit tests a given canvas object in the scene graph.
    This method queries the descriptor for the IHitTestable for the user object and returns the result of the hit test query. If there is no IHitTestable returned by the descriptor this method returns false.
    
    Parameters:
    
    canvasObject - the canvas object to query the bounds from
    
    location - the coordinates of the query in the world coordinate system
    
    Returns:
    
    whether the canvas object is hit at the given coordinates
  - isKeyboardFocusWithin
```
public final boolean isKeyboardFocusWithin()
```
    Determines whether the keyboard focus is within the visual tree.
    
    Returns:
    
    true if keyboard focus is within the subtree; otherwise, false.
  - isMouseEventConsumingDisabled
```
public boolean isMouseEventConsumingDisabled()
```
    Returns whether the behavior of consuming mouse events during the bubbling phase is disabled.
    
    See Also:
    
    mouseEventConsumingDisabledProperty()
  - isNavigationCommandsEnabled
```
public final boolean isNavigationCommandsEnabled()
```
    Gets a value indicating whether navigation related command bindings are enabled.
    By default this feature is enabled.
    
    This property enables/disables the following commands:
    Returns:
    
    true if the commands are enabled; otherwise, false.
    
    See Also:
    
    setNavigationCommandsEnabled(boolean)
  - isScrollCommandAnimationEnabled
```
public final boolean isScrollCommandAnimationEnabled()
```
    Gets a value indicating whether ICommands for scrolling like for example ICommand.SCROLL_PAGE_DOWN, the scrolling should be performed in animated fashion.
    
    Returns:
    
    true if scrolling should be animated; false otherwise. The default is true.
    
    See Also:
    
    setScrollCommandAnimationEnabled(boolean)
  - isZoomAnimationEnabled
```
public final boolean isZoomAnimationEnabled()
```
    Gets a value indicating whether zooming operations (e.g. turning the mouse wheel, executing ICommand.ZOOM etc.) should be performed in animated fashion.
    
    Returns:
    
    true if zooming should be animated; otherwise, false. The default is false.
    
    See Also:
    
    setZoomAnimationEnabled(boolean)
  - largeHorizontalChangeProperty
```
public final ReadOnlyDoubleProperty largeHorizontalChangeProperty()
```
    Returns a DoubleProperty that holds the change of the horizontal scroll bar when the track of the bar is clicked.
    
    Returns:
    
    the of the horizontal scroll bar when the track of the bar is clicked.
  - largeVerticalChangeProperty
```
public final ReadOnlyDoubleProperty largeVerticalChangeProperty()
```
    Returns a DoubleProperty that holds the change of the vertical scroll bar when the track of the bar is clicked.
    
    Returns:
    
    the of the vertical scroll bar when the track of the bar is clicked.
  - layoutChildren
```
protected void layoutChildren()
```
    Overrides:
    
    layoutChildren in class Control
  - longPressDurationProperty
```
public final ObjectProperty<Duration> longPressDurationProperty()
```
    The property for the long press time that indicates the amount of time that may pass before a touch down is considered a long press when the pointer stays within its getDragSize() area.
  - lookup
```
public <TLookup> TLookup lookup(Class<TLookup> type)
```
    Description copied from interface: ILookup
    
    Returns an instance that implements the given type or null. Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.
    
    Specified by:
    
    lookup in interface ILookup
    
    Parameters:
    
    type - the type for which an instance shall be returned
    
    Returns:
    
    an instance that is assignable to type or null
  - makeVisible
```
public void makeVisible(RectD bounds)
```
    Ensures that the provided bounds are visible in this control by adjusting the viewport correspondingly.
    
    Parameters:
    
    bounds - The bounds to make visible.
  - maximumHorizontalOffsetProperty
```
public final ReadOnlyDoubleProperty maximumHorizontalOffsetProperty()
```
    Returns a DoubleProperty that holds the the maximum value for the vertical scroll bar.
    
    Returns:
    
    the maximum value vor the vertical scroll bar.
  - maximumVerticalOffsetProperty
```
public final ReadOnlyDoubleProperty maximumVerticalOffsetProperty()
```
    Returns a DoubleProperty that holds the maximum value for the vertical scroll bar.
    
    Returns:
    
    the maximum vertical scroll bar value property.
  - maximumZoomProperty
```
public final DoubleProperty maximumZoomProperty()
```
    Returns a DoubleProperty that holds the maximum zoom level that is valid for this canvas control. This property sets an upper bound for the allowed values of the getZoom(). Default value is 1000d.
    
    Returns:
    
    the maximum zoom level.
    
    See Also:
    
    getZoom(), getMinimumZoom()
  - minimumHorizontalOffsetProperty
```
public final ReadOnlyDoubleProperty minimumHorizontalOffsetProperty()
```
    Returns a DoubleProperty that holds the minimum value for the horizontal scroll bar.
    
    Returns:
    
    the minimum horizontal scroll bar value property.
  - minimumVerticalOffsetProperty
```
public final ReadOnlyDoubleProperty minimumVerticalOffsetProperty()
```
    Returns a DoubleProperty that holds the minimum value for the vertical scroll bar.
    
    Returns:
    
    the minimum vertical scroll bar value property.
  - minimumZoomProperty
```
public final DoubleProperty minimumZoomProperty()
```
    Returns a DoubleProperty that holds the minimum the minimum zoom level for this canvas control. This property sets a lower bound for the allowed values of the getZoom() property. If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates. The default is 0.01d but values as small as 0.0000001d are possible.
    
    Returns:
    
    the minimum zoom level.
    
    See Also:
    
    getZoom(), getMaximumZoom()
  - mouseEventConsumingDisabledProperty
```
public final BooleanProperty mouseEventConsumingDisabledProperty()
```
    Defines whether consuming mouse events during the bubbling phase for this control is disabled or not. If set to true, parents of the CanvasControl receive mouse events in the bubbling phase. This can lead to unwanted behavior, e.g. the CanvasControl losing focus and thus not receiving input events and so on.
    Per default, this property is set to false.
  - mouseWheelBehaviorProperty
```
public final ObjectProperty<MouseWheelBehaviors> mouseWheelBehaviorProperty()
```
    The property for the behavior of the mouse wheel.
  - mouseWheelScroll
```
protected void mouseWheelScroll(Mouse2DEvent e)
```
    This method will be called by the onMouse2DWheelTurned(Mouse2DEvent) method, if the MouseWheelBehavior property is set to MouseWheelBehaviors.SCROLL.
    This method will scroll the view in vertical direction. If the Shift key modifier has been pressed this method will scroll in horizontal direction.
    
    Parameters:
    
    e - the event describing the action
    
    See Also:
    
    onMouse2DWheelTurned(Mouse2DEvent), getMouseWheelBehavior(), getMouseWheelScrollFactor()
  - mouseWheelScrollFactorProperty
```
public final DoubleProperty mouseWheelScrollFactorProperty()
```
    The property for the factor that controls how fast the viewport scrolls when the mouse wheel is turned.
  - mouseWheelZoom
```
protected void mouseWheelZoom(Mouse2DEvent e)
```
    This method will be called by the onMouse2DWheelTurned(Mouse2DEvent) method, if the MouseWheelBehavior property is set to MouseWheelBehaviors.ZOOM.
    This method will adjust the current zoom level. If the Control key modifier has been pressed this method will keep the world coordinates at the current mouse position, i.e. the zoom will not necessarily be into the center of the canvas.
    
    Parameters:
    
    e - the event describing the action
    
    See Also:
    
    onMouse2DWheelTurned(Mouse2DEvent), getMouseWheelBehavior()
  - mouseWheelZoomFactorProperty
```
public final DoubleProperty mouseWheelZoomFactorProperty()
```
    The property for the factor by which the zoom level changes when the mouse wheel is turned.
  - navigationCommandsEnabledProperty
```
public final BooleanProperty navigationCommandsEnabledProperty()
```
    The property for the value indicating whether navigation related command bindings are enabled.
  - onCompoundKeyPressedProperty
```
public final ObjectProperty<EventHandler<? super CompoundKeyEvent>> onCompoundKeyPressedProperty()
```
    Defines a function to be called when the user has pressed a key on the CanvasControl.
    This event delivers CompoundKeyEvent.
  - onCompoundKeyReleasedProperty
```
public final ObjectProperty<EventHandler<? super CompoundKeyEvent>> onCompoundKeyReleasedProperty()
```
    Defines a function to be called when the user has released a key on the CanvasControl.
    This event delivers CompoundKeyEvent.
  - onCompoundKeyTypedProperty
```
public final ObjectProperty<EventHandler<? super CompoundKeyEvent>> onCompoundKeyTypedProperty()
```
    Defines a function to be called when the user has typed a key on the CanvasControl.
    This event delivers CompoundKeyEvent.
  - onKeyDown
```
protected void onKeyDown(KeyEvent event)
```
    This will transform the key event to ModifierKeys and redispatch the last mouse event.
    
    Parameters:
    
    event - the event argument
  - onKeyPress
```
protected void onKeyPress(KeyEvent event)
```
    This implementation will do nothing.
    
    Parameters:
    
    event - the event argument
  - onKeyUp
```
protected void onKeyUp(KeyEvent event)
```
    This will transform the key event to ModifierKeys and redispatch the last mouse event.
    
    Parameters:
    
    event - the event argument
  - onMouse2DClicked
```
protected void onMouse2DClicked(Mouse2DEvent e)
```
    Callback method that is called when the mouse has been clicked. This callback will be called after the onMouse2DReleased(Mouse2DEvent) method has been invoked and only if the mouse has not been moved by a great amount since the last onMouse2DPressed(Mouse2DEvent) event. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Mouse 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the mouse event describing the action
    
    See Also:
    
    onMouse2DEntered(Mouse2DEvent), onMouse2DMoved(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DPressed(Mouse2DEvent), onMouse2DReleased(Mouse2DEvent), onMouse2DDragged(Mouse2DEvent), onMouse2DWheelTurned(Mouse2DEvent)
  - onMouse2DClickedProperty
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DClickedProperty()
```
    Defines a function to be called when the user has clicked on the CanvasControl with the mouse. This happens if press and release happens at the same position.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DDragged
```
protected void onMouse2DDragged(Mouse2DEvent e)
```
    Callback method that is called when the mouse gets dragged. Moving the mouse while at least one button is pressed is considered dragging. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Mouse 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the mouse event describing the action
    
    See Also:
    
    onMouse2DEntered(Mouse2DEvent), onMouse2DMoved(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DPressed(Mouse2DEvent), onMouse2DReleased(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), onMouse2DWheelTurned(Mouse2DEvent)
  - onMouse2DDraggedProperty
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DDraggedProperty()
```
    Defines a function to be called when the mouse has been dragged over the CanvasControl, i.e. the mouse is being moved while at least one of the mouse buttons is pressed.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DEntered
```
protected void onMouse2DEntered(Mouse2DEvent e)
```
    Callback method that is called when the mouse enters the control. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Mouse 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the mouse event describing the action
    
    See Also:
    
    onMouse2DMoved(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DPressed(Mouse2DEvent), onMouse2DReleased(Mouse2DEvent), onMouse2DDragged(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), onMouse2DWheelTurned(Mouse2DEvent)
  - onMouse2DEnteredProperty
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DEnteredProperty()
```
    Defines a function to be called when the mouse has entered the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DExited
```
protected void onMouse2DExited(Mouse2DEvent e)
```
    Callback method that is called when the mouse exits the control. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Mouse 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the mouse event describing the action
    
    See Also:
    
    onMouse2DEntered(Mouse2DEvent), onMouse2DMoved(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DPressed(Mouse2DEvent), onMouse2DReleased(Mouse2DEvent), onMouse2DDragged(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), onMouse2DWheelTurned(Mouse2DEvent)
  - onMouse2DExitedProperty
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DExitedProperty()
```
    Defines a function to be called when the mouse has exited the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DMoved
```
protected void onMouse2DMoved(Mouse2DEvent e)
```
    Callback method that is called when the mouse has been moved and no button has been pressed. If a button has been pressed the onMouse2DDragged(Mouse2DEvent) method would have been called. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Mouse 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the mouse event describing the action
    
    See Also:
    
    onMouse2DEntered(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DPressed(Mouse2DEvent), onMouse2DReleased(Mouse2DEvent), onMouse2DDragged(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), onMouse2DWheelTurned(Mouse2DEvent)
  - onMouse2DMovedProperty
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DMovedProperty()
```
    Defines a function to be called when the mouse has been moved in the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function. Move events are delivered if no mouse button is pressed. This event will be fired, too, if the mouse does not move but the world coordinates to which the current mouse position maps change. E.g. this will happen if the zoom level or the view point is changed.
  - onMouse2DPressed
```
protected void onMouse2DPressed(Mouse2DEvent e)
```
    Callback method that is called when a mouse button has been pressed. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Mouse 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the mouse event describing the action
    
    See Also:
    
    onMouse2DEntered(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DReleased(Mouse2DEvent), onMouse2DDragged(Mouse2DEvent), onMouse2DMoved(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), onMouse2DWheelTurned(Mouse2DEvent)
  - onMouse2DPressedProperty
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DPressedProperty()
```
    Defines a function to be called when the mouse has been pressed in the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DReleased
```
protected void onMouse2DReleased(Mouse2DEvent e)
```
    Callback method that is called when a mouse button has been released. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Mouse 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the mouse event describing the action
    
    See Also:
    
    onMouse2DEntered(Mouse2DEvent), onMouse2DMoved(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DPressed(Mouse2DEvent), onMouse2DDragged(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), onMouse2DWheelTurned(Mouse2DEvent)
  - onMouse2DReleasedProperty
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DReleasedProperty()
```
    Defines a function to be called when the mouse has been released on the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onMouse2DWheelTurned
```
protected void onMouse2DWheelTurned(Mouse2DEvent e)
```
    Callback method that is called when the mouse wheel has been turned. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. This method will call the mouseWheelZoom(Mouse2DEvent) or mouseWheelScroll(Mouse2DEvent) methods, if the corresponding behavior is enabled. Mouse 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    In order to customize the mouse wheel behavior, set the behavior to None. Register to the ScrollEvent and execute the custom action.
    
    Parameters:
    
    e - the mouse event describing the action
    
    See Also:
    
    onMouse2DEntered(Mouse2DEvent), onMouse2DExited(Mouse2DEvent), onMouse2DPressed(Mouse2DEvent), onMouse2DMoved(Mouse2DEvent), onMouse2DDragged(Mouse2DEvent), onMouse2DReleased(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent)
  - onMouse2DWheelTurnedProperty
```
public final ObjectProperty<EventHandler<? super Mouse2DEvent>> onMouse2DWheelTurnedProperty()
```
    Defines a function to be called when the mouse wheel has turned over the CanvasControl.
    An Mouse2DEvent in world coordinates using double precision floating points is delivered to the function.
  - onPrepareRenderContextEvent
```
protected void onPrepareRenderContextEvent(RenderContextEvent args)
```
    Raises the RenderContextEvent.PREPARE event.
    
    Parameters:
    
    args - The event to raise.
  - onSizeChanged
```
protected final void onSizeChanged(IEventArgs args)
```
    Handles a size change of this CanvasControl.
    This implementation adjusts the scrollbars and update the viewport.
  - onTouch2DDown
```
protected void onTouch2DDown(Touch2DEvent e)
```
    Callback method that is called when a finger has been put on the touch screen. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Touch 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the touch event describing the action
    
    See Also:
    
    onTouch2DUp(Touch2DEvent), onTouch2DEntered(Touch2DEvent), onTouch2DExited(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DTapped(Touch2DEvent), onTouch2DLostCapture(Touch2DEvent)
  - onTouch2DEntered
```
protected void onTouch2DEntered(Touch2DEvent e)
```
    Callback method that is called when a finger on the touch screen enters the control. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Touch 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the touch event describing the action
    
    See Also:
    
    onTouch2DDown(Touch2DEvent), onTouch2DUp(Touch2DEvent), onTouch2DExited(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DTapped(Touch2DEvent), onTouch2DLostCapture(Touch2DEvent)
  - onTouch2DExited
```
protected void onTouch2DExited(Touch2DEvent e)
```
    Callback method that is called when a finger on the touch screen exits the control. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Touch 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the touch event describing the action
    
    See Also:
    
    onTouch2DDown(Touch2DEvent), onTouch2DUp(Touch2DEvent), onTouch2DEntered(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DTapped(Touch2DEvent), onTouch2DLostCapture(Touch2DEvent)
  - onTouch2DLongPress
```
protected void onTouch2DLongPress(Touch2DEvent e)
```
    Callback method that is called when a long press gesture has been performed with a finger on the touch screen. This callback will be called after the onTouch2DDown(Touch2DEvent) method has been invoked after a specified amount of time and only if the finger has not been moved by a great amount. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Touch 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the touch event describing the action
    
    See Also:
    
    onTouch2DDown(Touch2DEvent), onTouch2DUp(Touch2DEvent), onTouch2DEntered(Touch2DEvent), onTouch2DExited(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DTapped(Touch2DEvent), onTouch2DLostCapture(Touch2DEvent), getLongPressDuration()
  - onTouch2DLostCapture
```
protected void onTouch2DLostCapture(Touch2DEvent e)
```
    Callback method that is called when the touch capture is lost. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Touch 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the touch event describing the action
    
    See Also:
    
    onTouch2DDown(Touch2DEvent), onTouch2DUp(Touch2DEvent), onTouch2DEntered(Touch2DEvent), onTouch2DExited(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DTapped(Touch2DEvent)
  - onTouch2DMoved
```
protected void onTouch2DMoved(Touch2DEvent e)
```
    Callback method that is called when a finger has been moved on the touch screen. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Touch 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the touch event describing the action
    
    See Also:
    
    onTouch2DDown(Touch2DEvent), onTouch2DUp(Touch2DEvent), onTouch2DEntered(Touch2DEvent), onTouch2DExited(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), onTouch2DTapped(Touch2DEvent), onTouch2DLostCapture(Touch2DEvent)
  - onTouch2DTapped
```
protected void onTouch2DTapped(Touch2DEvent e)
```
    Callback method that is called when a tap gesture has been performed with a finger on the touch screen. This callback will be called after the onTouch2DUp(Touch2DEvent) method has been invoked and only if the finger has not been moved by a great amount since the last onTouch2DDown(Touch2DEvent) event. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Touch 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the touch event describing the action
    
    See Also:
    
    onTouch2DDown(Touch2DEvent), onTouch2DUp(Touch2DEvent), onTouch2DEntered(Touch2DEvent), onTouch2DExited(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DLostCapture(Touch2DEvent)
  - onTouch2DUp
```
protected void onTouch2DUp(Touch2DEvent e)
```
    Callback method that is called when a finger has been removed from the surface of the touch screen. This method will redispatch the event. Subclasses overriding this method should make sure to invoke the super class implementation. Touch 2D Events use the world coordinate system rather than the view-coordinate system of the control itself.
    
    Parameters:
    
    e - the touch event describing the action
    
    See Also:
    
    onTouch2DDown(Touch2DEvent), onTouch2DEntered(Touch2DEvent), onTouch2DExited(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DTapped(Touch2DEvent), onTouch2DLostCapture(Touch2DEvent)
  - onTouchDown
```
protected void onTouchDown(TouchEvent e)
```
  - onTouchEnter
```
protected void onTouchEnter(TouchEvent e)
```
  - onTouchLeave
```
protected void onTouchLeave(TouchEvent e)
```
  - onTouchMove
```
protected void onTouchMove(TouchEvent e)
```
  - onTouchUp
```
protected void onTouchUp(TouchEvent e)
```
  - raiseUpdatedEvent
```
protected void raiseUpdatedEvent()
```
    Raises a CanvasEvent of type CanvasEvent.UPDATED.
  - raiseUpdatingEvent
```
protected void raiseUpdatingEvent()
```
    Raises the CanvasEvent.UPDATING event.
  - redispatchMouse2DEvent
```
protected void redispatchMouse2DEvent(ModifierKeys newModifiers)
```
    Redispatches a previously fired mouse event appropriately, e.g. if the view port has changed.
    This is needed to supply IInputMode implementations with the necessary events even if the mouse has not actually been moved.
  - removeBackgroundGroupChangedListener
```
public final void removeBackgroundGroupChangedListener(IEventHandler backgroundGroupChangedEvent)
```
    Removes the given listener for the BackgroundGroupChanged event that occurs when the BackgroundGroup property has been changed.
    
    Parameters:
    
    backgroundGroupChangedEvent - The listener to remove.
    
    See Also:
    
    addBackgroundGroupChangedListener(IEventHandler)
  - removeContentGroupChangedListener
```
public final void removeContentGroupChangedListener(IEventHandler contentGroupChangedEvent)
```
    Removes the given listener for the ContentGroupChanged event that occurs when the ContentGroup property has been changed.
    
    Parameters:
    
    contentGroupChangedEvent - The listener to remove.
    
    See Also:
    
    addContentGroupChangedListener(IEventHandler)
  - removeFocusGroupChangedListener
```
public final void removeFocusGroupChangedListener(IEventHandler focusGroupChangedEvent)
```
    Removes the given listener for the FocusGroupChanged event that occurs when the FocusGroup property has been changed.
    
    Parameters:
    
    focusGroupChangedEvent - The listener to remove.
    
    See Also:
    
    addFocusGroupChangedListener(IEventHandler)
  - removeHighlightGroupChangedListener
```
public final void removeHighlightGroupChangedListener(IEventHandler highlightGroupChangedEvent)
```
    Removes the given listener for the HighlightGroupChanged event that occurs when the HighlightGroup property has been changed.
    
    Parameters:
    
    highlightGroupChangedEvent - The listener to remove.
    
    See Also:
    
    addHighlightGroupChangedListener(IEventHandler)
  - removeInputModeContextChangedListener
```
public final void removeInputModeContextChangedListener(IEventHandler<PropertyChangedEventArgs> inputModeContextChangedEvent)
```
    Removes the given listener for the InputModeContextChanged event that occurs when the InputModeContext property has been changed.
    
    Parameters:
    
    inputModeContextChangedEvent - The listener to remove.
    
    See Also:
    
    addInputModeContextChangedListener(IEventHandler)
  - removeInputModeGroupChangedListener
```
public final void removeInputModeGroupChangedListener(IEventHandler inputModeGroupChangedEvent)
```
    Removes the given listener for the InputModeGroupChanged event that occurs when the InputModeGroup property has been changed.
    
    Parameters:
    
    inputModeGroupChangedEvent - The listener to remove.
    
    See Also:
    
    addInputModeGroupChangedListener(IEventHandler)
  - removeSelectionGroupChangedListener
```
public final void removeSelectionGroupChangedListener(IEventHandler selectionGroupChangedEvent)
```
    Removes the given listener for the SelectionGroupChanged event that occurs when the SelectionGroup property has been changed.
    
    Parameters:
    
    selectionGroupChangedEvent - The listener to remove.
    
    See Also:
    
    addSelectionGroupChangedListener(IEventHandler)
  - resize
```
public void resize(double width,
                   double height)
```
    Overrides:
    
    resize in class Region
  - scrollCommandAnimationEnabledProperty
```
public final BooleanProperty scrollCommandAnimationEnabledProperty()
```
    The property for the value that indicates if scrolling should be animated.
  - setAllKeyboardInputCapturingEnabled
```
public final void setAllKeyboardInputCapturingEnabled(boolean value)
```
    Sets a value indicating whether all keyboard input should be captured by this control, even if it hosts UI elements that would otherwise capture those events.
    
    Parameters:
    
    value - true if keyboard input should be captured exclusively by this control; false otherwise.
    
    See Also:
    
    isAllPointerInputCapturingEnabled(), isAllKeyboardInputCapturingEnabled()
  - setAllPointerInputCapturingEnabled
```
public final void setAllPointerInputCapturingEnabled(boolean value)
```
    Sets a value indicating whether all mouse or touch input should be captured by this control, even if it hosts UI elements that would otherwise capture those events.
    
    Parameters:
    
    value - true if mouse or touch input should be captured exclusively by this control; false otherwise.
    
    See Also:
    
    isAllKeyboardInputCapturingEnabled(), isAllPointerInputCapturingEnabled()
  - setAutoDragEnabled
```
public final void setAutoDragEnabled(boolean value)
```
    Sets a property that causes the control to automatically pan the view when the mouse gets dragged outside of the bounds of the control.
    
    Parameters:
    
    value - The AutoDragEnabled to set.
    
    See Also:
    
    isAutoDragEnabled()
  - setAutoDragInsets
```
public final void setAutoDragInsets(InsetsD value)
```
    Sets the auto drag insets.
    If the mouse is being dragged within the insets of the control specified using this property, the control will automatically scroll.
    
    Parameters:
    
    value - The new auto drag insets.
    
    See Also:
    
    isAutoDragEnabled(), getAutoDragInsets()
  - setBackgroundGroup
```
public final void setBackgroundGroup(ICanvasObjectGroup value)
```
    Sets the BackgroundGroup property.
    The background group is the ICanvasObjectGroup that should be used by the application code to put background elements in.
    
    If the field has not yet been initialized upon first access, the factory method createBackgroundGroup() will be called. Upon change the onBackgroundGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Parameters:
    
    value - The BackgroundGroup to set.
    
    See Also:
    
    getContentGroup(), getBackgroundGroup()
  - setCenter
```
public final void setCenter(PointD value)
```
    Sets the world coordinate at the center of the control.
    This can be used to move the view port.
    
    Parameters:
    
    value - The Center to set.
    
    See Also:
    
    getCenter()
  - setCenterZoomEventRecognizer
```
public final void setCenterZoomEventRecognizer(IEventRecognizer value)
```
    Specifies an IEventRecognizer that determines whether the zooming to the center of the view, rather than at the mouse location should be used.
    The default is IEventRecognizer.SHORTCUT_PRESSED.
    
    Parameters:
    
    value - The CenterZoomEventRecognizer to set.
    
    See Also:
    
    getCenterZoomEventRecognizer()
  - setContentGroup
```
public final void setContentGroup(ICanvasObjectGroup value)
```
    Sets the ContentGroup property.
    The content group is the ICanvasObjectGroup that should be used by the application code to put actual content in.
    
    If the field has not yet been initialized upon first access, the factory method createContentGroup() will be called. Upon change the onContentGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Parameters:
    
    value - The ContentGroup to set.
    
    See Also:
    
    getContentGroup()
  - setContentRect
```
public final void setContentRect(double x,
                                 double y,
                                 double w,
                                 double h)
```
    Sets the content rectangle.
    The content rectangle is the space in world coordinates that the user should at least be able to scroll to. I.e. if the area currently visible in the control does not encompass the content rect, the scrollbars will be made visible, unless they are disabled.
    
    See Also:
    
    getContentRect(), getHorizontalScrollBarPolicy(), getVerticalScrollBarPolicy()
  - setContentRect
```
public final void setContentRect(RectD value)
```
    Sets the Rectangle in world coordinates that holds the contents.
    This influences the display of the scroll bars. If the content rectangle is not currently visible in the viewport, scroll bars will be displayed, unless they are turned off completely. Note that in general the content rectangle is not updated automatically but declared as a fixed rectangle. Rather the application programmer needs to set this value or call respective automatic update methods.
    
    Parameters:
    
    value - The ContentRect to set.
    
    See Also:
    
    getContentRect()
  - setDoubleClickSize
```
public final void setDoubleClickSize(SizeD value)
```
    The area in view coordinates the mouse needs to stay in before multiple clicks are considered multiple single clicks instead of multi-clicks.
    If the mouse stays within this within than DoubleClickTime, multiple clicks will be considered double or multi-clicks. The default value is (10, 10).
    
    Parameters:
    
    value - The DoubleClickSize to set.
    
    See Also:
    
    getDoubleClickTime(), getDoubleClickSize()
  - setDoubleClickTime
```
public final void setDoubleClickTime(Duration value)
```
    The value of the double click time.
    This value indicates the amount of time that may pass within which two subsequent mouse clicks are considered multi clicks. The higher the value the easier it will be to double-click. The default value is 500 milliseconds.
    
    Parameters:
    
    value - The DoubleClickTime to set.
    
    See Also:
    
    getDoubleClickSize(), getDoubleClickTime()
  - setDoubleTapDuration
```
public final void setDoubleTapDuration(Duration value)
```
    Sets the value of the double tap time.
    This value indicates the amount of time that may pass within which two subsequent touch taps are considered multi taps. The higher the value the easier it will be to double-tap. The default value is 500 milliseconds.
    
    Parameters:
    
    value - The DoubleTapDuration to set.
    
    See Also:
    
    getDoubleTapSize(), getDoubleTapDuration()
  - setDoubleTapSize
```
public final void setDoubleTapSize(SizeD value)
```
    Sets the area in view coordinates the touch pointer needs to stay in before multiple taps are considered multiple single taps instead of multi-taps.
    If the touch pointer stays within this within than DoubleTapDuration, multiple taps will be considered double or multi-taps. The default value is (20, 20).
    
    Parameters:
    
    value - The DoubleTapSize to set.
    
    See Also:
    
    getDoubleTapDuration(), getDoubleTapSize()
  - setDragSize
```
public final void setDragSize(SizeD value)
```
    Sets the area in view coordinates the mouse may stay in before a movement is considered a drag. If the mouse is moved within this area longer than DragTime milliseconds, the movement will be considered a drag, nevertheless.
    The larger the area the later a mouse movement will be recognized as a drag. This influences the click-sensitivity, since a mouse button release is only considered a click if there was no drag since the last mouse button press. The default value is (5, 5).
    
    Parameters:
    
    value - The DragSize to set.
    
    See Also:
    
    getDragSize(), onMouse2DDragged(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), getDragSize()
  - setDragTime
```
public final void setDragTime(Duration value)
```
    Sets the value of the drag time.
    This value indicates the amount of time that may pass before a mouse movement is considered a drag when the mouse stays within its DragSize area. The higher the value the later a mouse movement will be recognized as a drag. This influences the click-sensitivity, since a mouse button release is only considered a click if there was no drag since the last mouse button press. The default value is 300 milliseconds.
    
    Parameters:
    
    value - The DragTime to set.
    
    See Also:
    
    getDragSize(), onMouse2DDragged(Mouse2DEvent), onMouse2DClicked(Mouse2DEvent), getDragTime()
  - setEditable
```
public void setEditable(boolean value)
```
    Property that sets the editable state of this canvas.
    IInputMode implementations should honor this property. Events will still be delivered to the IInputModes, however they should not modify the model.
    
    Parameters:
    
    value - The Editable to set.
    
    See Also:
    
    isEditable()
  - setFitContentViewMargins
```
public final void setFitContentViewMargins(InsetsD value)
```
    Sets the insets in view coordinates that should be used by the fitContent() operation.
    This influences the amount of visible whitespace in the view coordinate system around the ContentRect after a fitContent() operation. The default value is (10,10,10,10).
    
    Note limits that are enforced by the ViewportLimiter have a higher priority than these insets.
    
    Parameters:
    
    value - The FitContentViewMargins to set.
    
    See Also:
    
    getFitContentViewMargins()
  - setFocusGroup
```
public final void setFocusGroup(ICanvasObjectGroup value)
```
    Sets the HighlightGroup property.
    If the field has not yet been initialized upon first access, the factory method createHighlightGroup() will be called. Upon change the onHighlightGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Parameters:
    
    value - The FocusGroup to set.
    
    See Also:
    
    getFocusGroup()
  - setHighlightGroup
```
public final void setHighlightGroup(ICanvasObjectGroup value)
```
    Sets the HighlightGroup property.
    If the field has not yet been initialized upon first access, the factory method createHighlightGroup() will be called. Upon change the onHighlightGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Parameters:
    
    value - The HighlightGroup to set.
    
    See Also:
    
    getHighlightGroup()
  - setHitTestRadius
```
public final void setHitTestRadius(double value)
```
    Specifies the radius of the area around the mouse in view coordinates in which a IHitTestable may lie to be considered a valid hit.
    This value can be queried from within the IHitTestable implementation from the HitTestRadius property. The default value is 3.0d
    
    Parameters:
    
    value - The HitTestRadius to set.
    
    See Also:
    
    getHitTestRadius()
  - setHorizontalScrollBarPolicy
```
public void setHorizontalScrollBarPolicy(ScrollPane.ScrollBarPolicy value)
```
    Specifies the visibility policy for the vertical scrollbar.
    Scrollbars don't need to be displayed in order to move the viewport. This can be achieved programmatically or using special IInputMode instances. The default is ScrollPane.ScrollBarPolicy#AS_NEEDED.
    
    Parameters:
    
    value - The HorizontalScrollBarPolicy to set.
    
    See Also:
    
    MoveViewportInputMode, getVerticalScrollBarPolicy(), getHorizontalScrollBarPolicy()
  - setInputMode
```
public final void setInputMode(IInputMode value)
```
    Sets the single IInputMode instance that shall be installed for this canvas.
    
    Parameters:
    
    value - The InputMode to set.
    
    See Also:
    
    getInputMode()
  - setInputModeContext
```
public final void setInputModeContext(IInputModeContext value)
```
    Sets the InputModeContext property.
    This context object is passed to IInputMode instances during installation and removal.
    If the field has not yet been initialized upon first access, the factory method createInputModeContext() will be called. Upon change the onInputModeContextChanged(IInputModeContext, IInputModeContext) method will be called.
    
    Parameters:
    
    value - The InputModeContext to set.
    
    See Also:
    
    getInputModeContext()
  - setInputModeGroup
```
public final void setInputModeGroup(ICanvasObjectGroup value)
```
    Sets the InputModeGroup property.
    This is the canvas object group where the IInputModes should add their temporary content to. This group by default is in front of the ContentGroup.
    
    If the field has not yet been initialized upon first access, the factory method createInputModeGroup() will be called. Upon change the onInputModeGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Parameters:
    
    value - The InputModeGroup to set.
    
    See Also:
    
    getContentGroup(), getBackgroundGroup(), getInputModeGroup()
  - setLongPressDuration
```
public final void setLongPressDuration(Duration value)
```
    Sets the value of the long press time.
    This value indicates the amount of time that may pass before a touch down is considered a long press when the pointer stays within its DragSize area. The higher the value the later a touch pointer movement will be recognized as a long press. The default value is 1000 milliseconds.
    
    Parameters:
    
    value - The LongPressDuration to set.
    
    See Also:
    
    getDragSize(), onTouch2DDown(Touch2DEvent), onTouch2DMoved(Touch2DEvent), onTouch2DLongPress(Touch2DEvent), getLongPressDuration()
  - setMaximumZoom
```
public final void setMaximumZoom(double value)
```
    Sets the maximum zoom level that is valid for Zoom.
    Default value is 1000d
    
    Parameters:
    
    value - The MaximumZoom to set.
    
    See Also:
    
    getMaximumZoom()
  - setMinimumZoom
```
public final void setMinimumZoom(double value)
```
    Sets the minimum zoom factor for this CanvasControl.
    This property sets a lower bound for the allowed values of the Zoom property. If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates. The default is 0.01d but values as small as 0.0000001d are possible.
    
    Parameters:
    
    value - The MinimumZoom to set.
    
    See Also:
    
    getZoom(), getMaximumZoom(), getMinimumZoom()
  - setMouseEventConsumingDisabled
```
public void setMouseEventConsumingDisabled(boolean mouseEventConsumingDisabled)
```
    Sets the behavior of consuming mouse events during the bubbling phase.
    
    See Also:
    
    mouseEventConsumingDisabledProperty()
  - setMouseWheelBehavior
```
public final void setMouseWheelBehavior(MouseWheelBehaviors value)
```
    Determines the behavior of the mouse wheel. The behavior can be switched between MouseWheelBehaviors.ZOOM, MouseWheelBehaviors.SCROLL and MouseWheelBehaviors.NONE. Additionally, this property can be configured to perform the action only when the control is focused.
    
    Parameters:
    
    value - The MouseWheelBehavior to set.
    
    See Also:
    
    getMouseWheelBehavior()
  - setMouseWheelScrollFactor
```
public final void setMouseWheelScrollFactor(double value)
```
    Sets a factor that controls how fast the viewport scrolls when the mouse wheel is turned.
    Scrolling can work either a few lines at a time (per notch of the scroll wheel) or one page at a time. This is a system setting. This property controls how many pixels represent a line if scrolling is done by line. In case scrolling is done by page, this property has no effect.
    
    The default value of 5 pixels. To speed up scrolling, set a larger value, to slow down scrolling, set a smaller value.
    
    Parameters:
    
    value - The MouseWheelScrollFactor to set.
    
    See Also:
    
    getMouseWheelZoomFactor(), getMouseWheelBehavior(), Mouse2DEvent.getScrollAmount(), Mouse2DEvent.getScrollType(), getMouseWheelScrollFactor()
  - setMouseWheelZoomFactor
```
public final void setMouseWheelZoomFactor(double value)
```
    Sets the factor by which the zoom level changes when the mouse wheel is turned.
    The default value is 1.2.
    
    Parameters:
    
    value - The MouseWheelZoomFactor to set.
    
    See Also:
    
    getMouseWheelZoomFactor()
  - setNavigationCommandsEnabled
```
public final void setNavigationCommandsEnabled(boolean value)
```
    Sets a value indicating whether navigation related command bindings are enabled.
    By default this feature is enabled.
    
    This property enables/disables the following commands:
    Parameters:
    
    value - true if the commands are enabled; otherwise, false.
    
    See Also:
    
    isNavigationCommandsEnabled()
  - setOnCompoundKeyPressed
```
public final void setOnCompoundKeyPressed(EventHandler<? super CompoundKeyEvent> value)
```
    Sets the value of the property onCompoundKeyPressed.
  - setOnCompoundKeyReleased
```
public final void setOnCompoundKeyReleased(EventHandler<? super CompoundKeyEvent> value)
```
    Sets the value of the property onCompoundKeyReleased.
  - setOnCompoundKeyTyped
```
public final void setOnCompoundKeyTyped(EventHandler<? super CompoundKeyEvent> value)
```
    Sets the value of the property onCompoundKeyTyped.
  - setOnMouse2DClicked
```
public final void setOnMouse2DClicked(EventHandler<? super Mouse2DEvent> value)
```
    Sets the value of the property onMouse2DClicked.
  - setOnMouse2DDragged
```
public final void setOnMouse2DDragged(EventHandler<? super Mouse2DEvent> value)
```
    Sets the value of the property onMouse2DDragged.
  - setOnMouse2DEntered
```
public final void setOnMouse2DEntered(EventHandler<? super Mouse2DEvent> value)
```
    Sets the value of the property onMouse2DEntered.
  - setOnMouse2DExited
```
public final void setOnMouse2DExited(EventHandler<? super Mouse2DEvent> value)
```
    Sets the value of the property onMouse2DExited.
  - setOnMouse2DMoved
```
public final void setOnMouse2DMoved(EventHandler<? super Mouse2DEvent> value)
```
    Sets the value of the property onMouse2DMoved.
  - setOnMouse2DPressed
```
public final void setOnMouse2DPressed(EventHandler<? super Mouse2DEvent> value)
```
    Sets the value of the property onMouse2DPressed.
  - setOnMouse2DReleased
```
public final void setOnMouse2DReleased(EventHandler<? super Mouse2DEvent> value)
```
    Sets the value of the property onMouse2DReleased.
  - setOnMouse2DWheelTurned
```
public final void setOnMouse2DWheelTurned(EventHandler<? super Mouse2DEvent> value)
```
    Sets the value of the property onMouse2DWheelTurned.
  - setScrollCommandAnimationEnabled
```
public final void setScrollCommandAnimationEnabled(boolean value)
```
    Sets a value indicating whether ICommands for scrolling like for example ICommand.SCROLL_PAGE_DOWN, the scrolling should be performed in animated fashion.
    
    Parameters:
    
    value - true if scrolling should be animated; false otherwise. The default is true.
    
    See Also:
    
    isScrollCommandAnimationEnabled()
  - setSelectionGroup
```
public final void setSelectionGroup(ICanvasObjectGroup value)
```
    Sets the SelectionGroup property.
    The selection group is the ICanvasObjectGroup that should be used by the application code to put the selection paintables in.
    
    If the field has not yet been initialized upon first access, the factory method createSelectionGroup() will be called. Upon change the onSelectionGroupChanged(ICanvasObjectGroup, ICanvasObjectGroup) method will be called.
    
    Parameters:
    
    value - The SelectionGroup to set.
    
    See Also:
    
    getSelectionGroup()
  - setTemplateLocation
```
public static final void setTemplateLocation(Node visual,
                                             PointD viewCoordinates)
```
    Moves a node to the given coordinates.
    
    Parameters:
    
    visual - the node to be moved.
    
    viewCoordinates - the new coordinates.
  - setVerticalScrollBarPolicy
```
public void setVerticalScrollBarPolicy(ScrollPane.ScrollBarPolicy value)
```
    Specifies the visibility policy for the vertical scrollbar.
    Scrollbars don't need to be displayed in order to move the viewport. This can be achieved programmatically or using special IInputMode instances. The default is ScrollPane.ScrollBarPolicy#AS_NEEDED.
    
    Parameters:
    
    value - The VerticalScrollBarPolicy to set.
    
    See Also:
    
    MoveViewportInputMode, getHorizontalScrollBarPolicy(), getVerticalScrollBarPolicy()
  - setViewPoint
```
public final void setViewPoint(PointD value)
```
    Sets the current view point.
    The view point is the point in world coordinates that is mapped to the top left corner point in the current viewport. Setting this point to another value will redispatch the last mouse event as the mouse will appear to have been moved or dragged in the world coordinate system.
    
    Parameters:
    
    value - The ViewPoint to set.
    
    See Also:
    
    getViewPoint()
  - setViewportLimiter
```
public final void setViewportLimiter(ViewportLimiter value)
```
    Sets the ViewportLimiter instance that can be used to limit the explorable region.
    By default there are no limits set on the explorable region.
    
    Parameters:
    
    value - The ViewportLimiter to set.
    
    See Also:
    
    getViewportLimiter()
  - setVisualCaching
```
public final void setVisualCaching(VisualCachingPolicy value)
```
    Sets the policy for caching Nodes which are temporarily removed from the visual tree.
    Visuals are temporarily removed when they are moved outside the visual part of the canvas (the Viewport) and re-added when they enter the Viewport again. Caching prevents the need to re-build the visuals from scratch.
    
    Visuals are only cached if this property is set to another value than VisualCachingPolicy.NEVER and if a IDisposeVisualCallback is registered during creation.
    
    Parameters:
    
    value - The VisualCaching to set.
    
    See Also:
    
    getVisualCaching()
  - setZoom
```
public final void setZoom(double value)
```
    Sets the zoom factor for this CanvasControl.
    A zoom level of 1.0f will make each unit in world-coordinate space appear exactly one unit in screen coordinates wide. The default is 1.0f. If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates.
    
    The valid range is bounded by MinimumZoom and MaximumZoom
    
    Parameters:
    
    value - The Zoom to set.
    
    See Also:
    
    getMinimumZoom(), getMaximumZoom(), getZoom()
  - setZoomAnimationDuration
```
public final void setZoomAnimationDuration(Duration duration)
```
    Sets the duration of the zooming animation. If isZoomAnimationEnabled() is set to true, this property specifies how long this animation takes.
    
    Parameters:
    
    duration - The duration of the zooming animation. The default is 0.15 seconds.
    
    See Also:
    
    isZoomAnimationEnabled(), getZoomAnimationDuration()
  - setZoomAnimationEnabled
```
public final void setZoomAnimationEnabled(boolean value)
```
    Sets a value indicating whether zooming operations (e.g. turning the mouse wheel, executing ICommand.ZOOM etc.) should be performed in animated fashion.
    
    Parameters:
    
    value - true if zooming should be animated; otherwise, false. The default is false.
    
    See Also:
    
    isZoomAnimationEnabled()
  - smallHorizontalChangeProperty
```
public final ReadOnlyDoubleProperty smallHorizontalChangeProperty()
```
    Returns a DoubleProperty that holds the step size by which the horizontal scroll bar is changed when calling ScrollBar.increment() or ScrollBar.decrement().
    
    Returns:
    
    the step size by which the horizontal scroll bar is changed.
  - smallVerticalChangeProperty
```
public final ReadOnlyDoubleProperty smallVerticalChangeProperty()
```
    Returns a DoubleProperty that holds the step size by which the vertical scroll bar is changed when calling ScrollBar.increment() or ScrollBar.decrement().
    
    Returns:
    
    the step size by which the vertical scroll bar is changed.
  - toViewCoordinates
```
public final PointD toViewCoordinates(PointD worldPoint)
```
    Converts world coordinates to view coordinates expressed in the control's coordinate system.
    
    Parameters:
    
    worldPoint - the coordinates in the world coordinate system
    
    Returns:
    
    returns the coordinates in pixels relative to the controls upper left corner
  - toWorldCoordinates
```
public final PointD toWorldCoordinates(PointD viewPoint)
```
    Converts view coordinates (expressed in the control's coordinate system) to world coordinates.
    
    Parameters:
    
    viewPoint - the coordinates in pixels relative to the controls upper left corner
    
    Returns:
    
    returns the coordinates in the world coordinate system
  - updateContentRect
```
public final void updateContentRect()
```
    Updates the ContentRect to encompass the bounds by all elements in the current scene graph plus the given margins.
    This method will traverse all visible elements in the scene graph and query their bounds The resulting bounds will be set to the content rectangle plus the provided margins.
    
    See Also:
    
    IBoundsProvider, getContentRect()
  - updateContentRect
```
public final void updateContentRect(InsetsD margins)
```
    Updates the ContentRect to encompass the bounds by all elements in the current scene graph plus the given margins.
    This method will traverse all visible elements in the scene graph and query their bounds The resulting bounds will be set to the content rectangle plus the provided margins.
    
    See Also:
    
    IBoundsProvider, getContentRect()
  - updateContentRect
```
public void updateContentRect(InsetsD margins,
                              ICanvasObjectGroup group)
```
    Updates the ContentRect to encompass the bounds by all elements in the current scene graph plus the given margins.
    This method will traverse all visible elements in the scene graph and query their bounds The resulting bounds will be set to the content rectangle plus the provided margins.
    
    See Also:
    
    IBoundsProvider, getContentRect()
  - updateImmediately
```
public void updateImmediately()
```
    Updates the visual tree that displays the contents of this control.
    This method will determine the Dirty canvas objects using the ICanvasObjectDescriptor.isDirty(ICanvasContext, ICanvasObject) method and will create or update the visuals that make up the visual tree. Calling invalidate() will ultimately trigger this method, however update calls will be coalesced and the actual execution of this method will be delayed.
  - verticalOffsetProperty
```
public final DoubleProperty verticalOffsetProperty()
```
    Returns a DoubleProperty that holds the current value of the vertical scroll bar.
    
    Returns:
    
    the vertical scroll bar's value property.
  - verticalScrollBarPolicyProperty
```
public final ObjectProperty<ScrollPane.ScrollBarPolicy> verticalScrollBarPolicyProperty()
```
    Returns an ObjectProperty that holds the visibility policy for the vertical scroll bar. Scroll bars don't need to be displayed in order to move the viewport. This can be achieved programmatically or using special IInputMode instances. The default is ScrollPane.ScrollBarPolicy#AS_NEEDED.
    
    Returns:
    
    the vertical scroll bar visibility property.
    
    See Also:
    
    MoveViewportInputMode, getHorizontalScrollBarPolicy(), ScrollPane.ScrollBarPolicy#ALWAYS, ScrollPane.ScrollBarPolicy#AS_NEEDED, ScrollPane.ScrollBarPolicy#NEVER
  - viewPointProperty
```
public final ObjectProperty<PointD> viewPointProperty()
```
    Returns an ObjectProperty that holds current view point. The view point is the point in world coordinates that is mapped to the top left corner point in the current viewport.
    
    Returns:
    
    the view point property.
  - viewportHeightProperty
```
public final ReadOnlyDoubleProperty viewportHeightProperty()
```
    Returns a DoubleProperty that holds the height of the current viewport.
  - viewportProperty
```
public final ReadOnlyObjectPropertyBase<RectD> viewportProperty()
```
    The property for the view port.
    The view port is the visible portion of the world rectangle in the world coordinate system.
    
    See Also:
    
    getViewport()
  - viewportWidthProperty
```
public final ReadOnlyDoubleProperty viewportWidthProperty()
```
    Returns a DoubleProperty that holds the width of the current viewport.
  - zoomProperty
```
public final DoubleProperty zoomProperty()
```
    Gets a DoubleProperty that holds the current zoom factor for this canvas control.
    A zoom level of 1.0f will make each unit in world-coordinate space appear exactly one unit in screen coordinates wide. The default is 1.0f. If this property is written, the canvas will zoom to the new value while keeping the center of view at the same world coordinates.
    
    The valid range is bounded by getMinimumZoom() and getMaximumZoom()
    
    Returns:
    
    The Zoom.@see com.yworks.yfiles.canvas.CanvasControl#onZoomChanged(com.yworks.util.EventArgs)
    
    See Also:
    
    getMinimumZoom(), getMaximumZoom()
  - zoomTo
```
public void zoomTo(PointD center,
                   double zoom)
```
    Sets the zoom level and view port center to the given values.
    
    Parameters:
    
    center - the new center of the view port in world coordinates
    
    zoom - the new zoom level
  - zoomTo
```
public void zoomTo(RectD bounds)
```
    Sets the zoom level and view port center so that the given rectangle in world coordinates fits the viewport.
    
    Parameters:
    
    bounds - The coordinates of the rectangle to zoom to.

Class CanvasControl

Property Summary

Properties inherited from class javafx.scene.control.Control

Properties inherited from class javafx.scene.layout.Region

Properties inherited from class javafx.scene.Parent

Properties inherited from class javafx.scene.Node

Field Summary

Fields inherited from class javafx.scene.layout.Region

Fields inherited from class javafx.scene.Node

Fields inherited from interface com.yworks.yfiles.graph.ILookup

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.control.Control

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class javafx.scene.Parent

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Methods inherited from interface com.yworks.yfiles.graph.ILookup

Property Detail

autoDragEnabled

autoDragInsets

centerZoomEventRecognizer

computedHorizontalScrollBarState

computedVerticalScrollBarState

contentRect

doubleClickSize

doubleClickTime

doubleTapDuration

doubleTapSize

dragSize

dragTime

editable

fitContentViewMargins

hitTestRadius

horizontalOffset

horizontalScrollBarPolicy

inputMode

largeHorizontalChange

largeVerticalChange

longPressDuration

maximumHorizontalOffset

maximumVerticalOffset

maximumZoom

minimumHorizontalOffset

minimumVerticalOffset

minimumZoom

mouseEventConsumingDisabled

mouseWheelBehavior

mouseWheelScrollFactor

mouseWheelZoomFactor

navigationCommandsEnabled

onCompoundKeyPressed

onCompoundKeyReleased

onCompoundKeyTyped

onMouse2DClicked

onMouse2DDragged

onMouse2DEntered

onMouse2DExited

onMouse2DMoved

onMouse2DPressed

onMouse2DReleased

onMouse2DWheelTurned

scrollCommandAnimationEnabled

smallHorizontalChange

smallVerticalChange

verticalOffset

verticalScrollBarPolicy

viewPoint

viewportHeight

viewport

viewportWidth

zoom

Field Detail

SCROLL_BAR_ENABLED

SCROLL_BAR_VISIBLE

Constructor Detail

CanvasControl

Method Detail

addBackgroundGroupChangedListener

addContentGroupChangedListener