Gets or sets a property that causes the canvas to automatically pan the view when the mouse gets dragged within the autoDragInsets of the canvas.

See also

Gets or sets the auto drag insets.

If the mouse is being dragged within the insets of the canvas specified using this field, the control will automatically scroll.

This property can be used as the source for data binding.

See also

Determines whether the mouse wheel should be used for zooming. If set to false this task can be performed by custom IInputMode implementations using the CanvasMouseEvent of type CanvasMouseEvent.CANVAS_MOUSE_WHEEL.

The default value is true.

This property can be used as the source for data binding.

Sets the alpha value of the canvas background color.

The default value is 1.0.

Sets the background color of the canvas.

The world coordinate at the center of the canvas component.

Can be used to move the view port.

This property can be used as the source for data binding.

Gets and 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.

This property can be used as the source for data binding.

Returns an implementation of ICanvasContext that describes the state of this canvas control.

Get or set the cursor instance that will be displayed for this canvas.

The cursor is shown if the mouse pointer is currently located in the canvas area or if the user started a dragging gesture over the canvas.

If an input mode is active it will set this property to the input mode's preferred cursor, overwriting any previous settings. In that case, the canvas's cursor has to be set via the defaultCursor property of the input mode.

Note that when this property is set, cursorManager.removeAllCursors() will be called to ensure that the new cursor is actually displayed.

This property can be used as the source for data binding.

See also

The size of the area within which the user must click twice for the two clicks to be considered a double-click. This property also determines whether a "small drag" is considered a click.

The default value is (10,10).

This property can be used as the source for data binding.

See also

The time that may elapse between two consecutive mouse clicks so the last click is still considered a double click.

This property can be used as the source for data binding.

See also

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).

This property can be used as the source for data binding.

See also

The value of the drag time. This value indicates the amount of time in milliseconds 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.

This property can be used as the source for data binding.

See also

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.

This property can be used as the source for data binding.

Determines whether to propagate mouse events to the children in the display list.

Propagating the mouse events to the children may increase the CPU usage of a complex display list dramatically.

The input modes are not affected by this setting.

Use one of the MOUSE_CHILDREN constants to determine the policy:

• MOUSE_CHILDREN_AUTO: Only propagate events to the child objects if there are objects which may require interactivity.
• MOUSE_CHILDREN_NEVER: never propagate events to the child objects.
• MOUSE_CHILDREN_ALWAYS: always propagate events to the child objects.

The default value is MOUSE_CHILDREN_AUTO.

This property can be used as the source for data binding.

See also

Specifies the radius of the area around the mouse in view coordinates in which an IHitTestable may lie to be considered a valid hit.

This value can be queried from within the IHitTestable implementation from the ICanvasContext.hitTestRadius

The default value is 4.0.

The amount to scroll when an arrow button of the horizontal scrollbar is pressed, in pixels.

This property can be used as the source for data binding.

Specifies the amount to scroll when the horizontal scroll bar track is pressed, in pixels.

This property can be used as the source for data binding.

Specifies the visibility policy for the horizontal scrollbar.

This property can be used as the source for data binding.

See also

The current position of the horizontal scroll bar. This is equal to the distance in pixels between the left edge of the scrollable surface and the leftmost piece of the surface that is currently visible.

The default value is 0.

This property can be used as the source for data binding.

Specifies the single IInputMode instance that shall be installed for this canvas.

This property can be used as the source for data binding.

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 method will be called.

See also

Retrieves the LookupChain that can be used to decorate the lookup call in the inputModeContext.

Returns the internal list of currently installed IInputModes.

This is a mutable list. To install new instances simply add them to the list and remove them to uninstall them.

See also

Gets the last CanvasMouseEvent that was dispatched by this instance.

Returns the minimum zoom value for the current canvas size and viewport limits

This property can be used as the source for data binding.

See also

If the canvas component currently has a horizontal scroll bar, returns the maxScrollPosition of the horizontal scroll bar. Else, returns 0.

See also

If the canvas component currently has a vertical scroll bar, returns the maxScrollPosition of the vertical scroll bar. Else, returns 0.

See also

The maxZoom property.

The zoom property cannot be set to a value greater than maxZoom.

The default value is 200.

This property can be used as the source for data binding.

If the canvas component currently has a horizontal scroll bar, returns the minScrollPosition of the horizontal scroll bar. Else, returns 0.

See also

If the canvas component currently has a vertical scroll bar, returns the minScrollPosition of the vertical scroll bar. Else, returns 0.

See also

The minZoom property.

The zoom property cannot be set to a value less than minZoom.

The default value is 0.01.

This property can be used as the source for data binding.

Time interval in milliseconds after which a mouse move (MouseEvent.MOUSE_MOVE) is processed.

The CanvasComponent translates MouseEvent.MOUSE_MOVE into CanvasMouseEvents. This does not happen immediately but after a time interval which is determined by this property. After the time interval only the last event will be processed and re-dispatched. This improves performance by omitting all mouse events which will not have any visible effect anyway.

Setting this property to 0 will cause all mouse events to be processed immediately.

Setting this property to larger intervals than 100 ms will result in a visible lag and thus is not recommended.

Automated GUI testing may require to set this property to 0.

The default value is 0.

See also

The recognizer used to determine if the mouse event passed to the mouseWheelZoom method should trigger a zoom action that uses the center of the view port as fixed coordinate during zooming.

The default value is EventRecognizers.NO_MODIFIER_PRESSED.

This property can be used as the source for data binding.

See also

The factor by which the zoom level changes when the mouse wheel is turned.

The default value is 1.02.

This property can be used as the source for data binding.

The recognizer used to determine if the mouse event passed to the mouseWheelZoom method should trigger a zoom action that uses the current mouse location as fixed coordinate during zooming.

The default value is EventRecognizers.MODIFIER_CTRL.

This property can be used as the source for data binding.

See also

Property that determines whether the whole canvasObjectTree is redrawn upon the next invocation of updateDisplayList().

Property that determines whether the canvasObjectTree is redrawn partially upon the next invocation of updateDisplayList().

The amount to scroll when an arrow button of the vertical scrollbar is pressed, in pixels.

This property can be used as the source for data binding.

Specifies the amount to scroll when the vertical scroll bar track is pressed, in pixels.

This property can be used as the source for data binding.

Specifies the visibility policy for the vertical scrollbar.

This property can be used as the source for data binding.

See also

The current position of the vertical scroll bar. This is equal to the distance in pixels between the top edge of the scrollable surface and the topmost piece of the surface that is currently visible.

The default value is 0.

This property can be used as the source for data binding.

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.

This property can be used as the source for data binding.

Returns the currently visible viewing region in world coordinates.

Gets or sets the viewport limiter instance that can be used to limit the explorable region.

By default there are no limits set on the explorable region.

This property can be used as the source for data binding.

The zoom factor for this canvas control.

A zoom level of 1.0 will make each unit in world-coordinate space appear exactly one unit in screen coordinates wide.

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 value is 1.0.

This property can be used as the source for data binding.

Whether the mouse wheel triggers zooming whenever the mouse is over the canvas area (true) or whether the canvas needs focus to trigger zooming (false).

When the canvas component has focus, the mouse wheel will always trigger zooming.

The default value is true.

Constructor.

Adds an element to the internal canvas object tree to the specified group.

The descriptor will be queried for the various implementations for the given userObject at rendering time.

Parameters

Adds an IDisplayObjectCreator instance to the scene graph using CanvasObjectDescriptor.Instance as the ICanvasObjectDescriptor. This method is equivalent to calling addCanvasObject(object,ICanvasObjectDescriptor) with CanvasObjectDescriptor.instance as the second argument and a non-null first argument.

Parameters

Adds a new ICanvasObjectGroup to the root of the canvas object tree.

Adds a new ICanvasObjectGroup to the specified group in the current canvas object tree. Can be used to build groups of ICanvasObject's that can be moved within the canvas object tree.

Parameters

Parameters

Adds an IPaintable instance to the scene graph using CanvasObjectDescriptor.Instance as the ICanvasObjectDescriptor. This method is equivalent to calling addCanvasObject(object,ICanvasObjectDescriptor) with CanvasObjectDescriptor.instance as the second argument and a non-null first argument.

Kept for compatibility. This implementation wraps the paintable into a PaintableDisplayObjectCreator.

It is recommended to (re-)implement the IPaintable as IDisplayObjectCreator and add it using addDisplayObjectCreator.

Parameters

See also

Adjusts the mouse cursor based on the given mouse event and the cursor property.

Parameters

Collects all canvas object instances that are hit at the given coordinate set.

Parameters

Factory method for the InputModeContext property. This method will be called upon first access to the inputModeContext property.

Creates a sprite containing a complete copy of the current canvas object tree.

This method is useful for custom printing. The created sprite can be transformed and added to a flash.printing.PrintJob.

See also

     var printSprite:PrintSprite = canvasComponent.createSprite();
     if(!printSprite.paintComplete) {
       var onPaintComplete:Function = function(evt:Event):void {
         printSprite.removeEventListener(Event.COMPLETE,onPaintComplete);
         myPrint(printSprite);
       };
       printSprite.addEventListener(Event.COMPLETE,onPaintComplete);
     } else {
       myPrint(printSprite);
     }
     

Descrease the current zoom level using the provided factor.

This implementation uses the viewportLimiter to limit the viewport.

Parameters

See also

Unregister all event listeners that were registered with the stage. This method is called whenever this canvas component is removed from the display list.

Parameters

Delayed processing of a MouseEvent.MOUSE_MOVE.

Parameters

Adjusts the view port to fully encompass the current content rectangle.

The implementation uses the viewportLimiter to limit the resulting viewport.

The resulting zoom level will not be greater than 1.0, unless the viewportLimiter demands a greater zoom value.

The actual fitting is executed asynchronously when the component gets validated. Thus, when this method returns, the viewport is not fit yet. Code which relies on an updated view port has to be executed in a callLater() call.

See also

When fitContent() is called, this method is invoked in the next updateDisplayList() execution to actually fit the content rectangle into the viewport.

See also

Updates the content rectangle and adjusts the viewport to encompass the contents.

This method combines the calls to updateContentRect() and fitContent().

The actual fitting is executed asynchronously when the component gets validated. Thus, when this method returns, the viewport is not fit yet. Code which relies on an updated view port has to be executed in a callLater() call.

Parameters

See also

Invalidates this canvas component and causes a repaint of all display objects that are visible in this canvas component.

Returns the top most canvas object instance that is hit at the given coordinate set.

Parameters

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

Returns a rectangle defined by the available space for displaying the CanvasObjectTree within this Component, in stage coordinates.

Returns an array of ICanvasObjects that are hit by the given coords.

Note that this method uses the flash internal hit test which may be faster than using getCanvasObject/getCanvasObjects

Parameters

Increase the current zoom level using the provided factor.

This implementation uses the viewportLimiter to limit the viewport.

Parameters

See also

Initialize all event listeners that should be registered with the stage. This method is called whenever this canvas component is added to the display list.

Parameters

Callback that is used by the default implementation of inputModeContext to resolve lookup calls.

Parameters

See also

Forces a repaint of all canvas objects.

The repaint will be done during the next screen update.

See also

Forces a repaint of the dirty canvas objects.

The repaint will be done during the next screen update.

See also

Marks a component so that its updateDisplayList() method gets called during a later screen update.

Checks whether the point at stageX,stageY is within the canvas bounds and target is a child of the canvas.

Parameters

Iterates all hit elements in the canvas below the given group that are accepted by a given filter. Hit testing is performed using the IHitTestable instance returned for each visible ICanvasObject in the current scene graph.

Parameters

See also

Parameters

Calculates the default size and the default minimum size of the component.

If the autoMouseWheelZoom property is set to true, this method will adjust the current zoom level. If the mouseWheelZoomMouseLocationRecognizer returns true for the passed event this method will keep the world coordinates at the current mouse position. Otherwise if the mouseWheelZoomCenteredRecognizer returns true it will keep the world coordinates at the center of the canvas. If both recognizers return false no zoom action takes place.

Parameters

See also

Called when the component is added to the display list.

Calls initListeners, passing the stage as the eventDispatcher.

Parameters

Called when the autoDrag property changes.

Dispatches the CanvasComponent.AUTO_DRAG_CHANGED event.

Parameters

See also

Called when the autoDragInsets property changes.

Dispatches the CanvasComponent.AUTO_DRAG_INSETS_CHANGED event.

Parameters

See also

Callback method that is called when the mouse has been clicked. The clickCount property of the event can be queried to determine whether a double click has occurred.

This callback will be called after the onMouseUp() method has been invoked and only if the mouse has not been moved by a great amount since the last onMouseDown event.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_CLICK event. Subclasses overriding this method should make sure to invoke the super class implementation.

Parameters

See also

Callback method that is called when a mouse button has been pressed.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_DOWN event. Subclasses overriding this method should make sure to invoke the super class implementation.

Parameters

See also

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 dispatch the CanvasMouseEvent.CANVAS_MOUSE_DRAG event. Subclasses overriding this method should make sure to invoke the super class implementation.

Parameters

See also

Callback method that is called when the mouse has been moved and the mouse button has not been pressed. If the mouse button has been pressed, onCanvasMouseDragged method would have been called instead.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_MOVE event. Subclasses overriding this method should make sure to invoke the super class implementation.

Parameters

See also

Callback method that is called when a mouse button has been released.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_UP event. Subclasses overriding this method should make sure to invoke the super class implementation.

Parameters

See also

Callback method that is called when the mouse wheel has been turned.

This method will dispatch the CanvasMouseEvent.CANVAS_MOUSE_WHEEL event. Subclasses overriding this method should make sure to invoke the super class implementation.

Parameters

See also

Callback that is invoked when the ContentRect property changes.

See also

Callback that is called when the editable property changes.

Callback that is invoked when the hitTestRadius property changed.

Parameters

Callback that is invoked when the inputMode property changes.

This will raise the inputModeChanged" event.

Parameters

See also

Called when the inputModeContext property value changes and after initialization of the field.

Triggers the inputModeContextChanged" event.

Parameters

Tries to gain the focus, if the canvas area was hit.

Calls onCanvasMouseDown with the corresponding CanvasMouseEvent.

Parameters

See also

Called when this component receives a MouseEvent.

This method is deprecated. Please use the various onCanvasMouseXXX hooks or event listeners for CanvasMouseEvents instead.

Parameters

See also

Calls onCanvasMouseDragged or onCanvasMouseMoved with the corresponding CanvasMouseEvent.

This method will not necessarily trigger drag events immediately. This depends on the values of dragTime and dragSize.

Parameters

See also

Calls onCanvasMouseUp and possibly onCanvasMouseClicked with the corresponding CanvasMouseEvent.

This method will not necessarily trigger the click event. This depends on the values doubleClickSize and doubleClickTime as well as if there has been a drag event delivered since the last mouse press.

Parameters

See also

Calls onCanvasMouseWheel with the corresponding CanvasMouseEvent.

Parameters

See also

Called when the component is removed from the display list.

Calls disposeListeners, passing the stage as the eventDispatcher.

Parameters

Callback that is invoked when the view port property changes.

The view port is the visible portion of the world rectangle in the world coordinate system. This method fires the viewPortChanged event.

See also

Prints the current canvas object tree or a pre-calculated copy of it.

The content is scaled down to fit on the page.

For more printing options, use class com.yworks.canvas.CanvasPrinter For completely customized printing, use createSprite() along with a Flex PrintJob.

Parameters

See also

Processes a mouse event.

A MouseEvent.MOUSE_MOVE will start a timer with the duration mouseInterval ms. After this interval only the last mouse move event will be forwarded to onMouseMove.

All other events will immediately be forwarded to onMouseUp, onMouseDown, or onMouseWheel. Also, a pending mouse move event will be forwarded before the new event.

Parameters

Parameters

Sets the provided center unless this would cause the viewport to exceed the limits of the viewportLimiter.

Parameters

See also

Sets the provided viewpoint unless this would cause the viewport to exceed the limits of the viewportLimiter.

Parameters

See also

Sets the provided viewport unless this would cause the viewport to exceed the limits of the viewportLimiter.

Parameters

See also

Sets the provided zoom value unless this would cause the viewport to exceed the limits of the viewportLimiter.

Parameters

See also

Converts a point in world coordinates to view coordinates.

Parameters

Converts a point in view coordinates to world coordinates.

Parameters

Updates the contentRect to encompass the bounds by all elements in the current scene graph upon the next invocation of updateDisplayList.

This method will traverse all visible elements in the canvas object tree and query their bounds. The resulting bounds will be set to the content rectangle plus the provided margins.

The actual updating is executed asynchronously when the component gets validated. Thus, when this method returns, the content rectangle is not updated yet. Code which relies on an updated content rectangle has to be executed in a callLater() call.

Parameters

See also

Parameters

Repaints the display list

Parameters

update the viewport bounds upon the next invocation of updateDisplayList.

Sets the zoom level and view port center to the given values.

Parameters

Adjusts the view port to fit in the given rectangle.

The new zoom level is calculated so that the given rectangle is included in the view port and maxZoom isn't exceeded.

Parameters

Dispatched when the autoDrag property changes.

Dispatched when the autoDragInsets property changes.

Dispatched when the mouse is clicked.

Dispatched when the mouse is double clicked.

This event is deprecated. Please use CANVAS_MOUSE_CLICK and the event's clickCount property instead.

Dispatched when the mouse is pressed.

Dispatched when the mouse is dragged.

Dispatched when the mouse is moved.

Dispatched when the mouse is released.

Dispatched when the mousewheel moves.

Dispatched when the contentRect property changes.

Dispatched when the editable property changes.

Dispatched when the inputMode property changes.

Dispatched when the inputModeContext property changes.

Dispatched when the canvas has been invalidated.

Dispatched when one of the scrollbars changes its scroll position.

Dispatched when the canvas object tree is repainted.

Dispatched when the viewPoint property changes.

Dispatched when the viewPort property changes.

Dispatched when the zoom property changes.

Dispatched when the autoDrag property changes. The event type is mx.events.PropertyChangeEvent.

Dispatched when the autoDragInsets property changes. The event type is flash.events.PropertyChangeEvent.

Dispatched when the contentRect property changes. The event type is flash.events.Event.

Dispatched when the editable property changes. The event type is flash.events.PropertyChangeEvent.

Dispatched when the inputMode property changes. The event type is flash.events.PropertyChangeEvent.

Dispatched when the inputModeContext property changes. The event type is flash.events.PropertyChangeEvent.

Dispatched when the canvas has been invalidated. The event type is flash.events.Event.

Mouse events will always be propagated to child DisplayObjects.

Constant for determining the enableMouseChildren policy.

This setting increases the CPU usage when the mouse hovers over the canvas. Interactive objects will react to the mouse.

Note that the input modes won't be affected and will work as expected.

MOUSE_CHILDREN_AUTO should automatically detect whether objects on the canvas will require mouse events. This setting should only be used if the auto detection fails.

Mouse events will only be propagated to child DisplayObjects if they may need interactivity.

Constant for determining the enableMouseChildren policy.

This setting lets the canvas automatically detect whether objects on the canvas will require mouse events. Mainly, when elements are styled using TemplateNodeStyle or TemplateLabelStyle.If the template components don't need to interact with the user, they can be hidden from auto detection by setting mouseEnabled and mouseChildren on that component to false.

Mouse events will never be propagated to child DisplayObjects.

Constant for determining the enableMouseChildren policy.

This setting reduces the CPU usage when the mouse hovers over the canvas. Interactive objects like nodes using the TemplateNodeStyle won't react to the mouse.

Note that the input modes won't be affected and will work as expected.

Use this setting if you use objects styled with TemplateStyle but don't need them to react to the mouse. This setting is recommended for, e.g., a print preview.

Kept for backward compatibility. Use com.yworks.canvas.CanvasEvent.VIEW_PORT_CHANGED instead.