com.yworks.ui.GraphOverviewComponent

Package	com.yworks.ui
Class	public class GraphOverviewComponent
Inheritance	GraphOverviewComponent CanvasComponent mx.core.UIComponent

Convenience component implementation that shows an overview of an IGraph contained in another GraphCanvasComponent

This control displays the graph in a preview mode and uses an OverviewInputMode to allow for easily navigating in the GraphCanvasComponent.

There are two different display modes available:

the high-performance mode (default) uses an OverviewGraphPaintable to preview the graph using paint callbacks for nodes, group nodes and edges.
the flexible mode uses an OverviewGraphDisplayObjectCreator to preview the graph using separate IDisplayObjectCreators to render the model items. It can be activated by setting the highPerformanceModeEnabled property to false.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		autoDrag : Boolean 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.	CanvasComponent
		autoDragInsets : ImmutableRectangle Gets or sets the auto drag insets.	CanvasComponent
		autoMouseWheelZoom : Boolean Determines whether the mouse wheel should be used for zooming.	CanvasComponent
		backgroundAlpha : Number [write-only] Sets the alpha value of the canvas background color.	CanvasComponent
		backgroundColor : uint [write-only] Sets the background color of the canvas.	CanvasComponent
		bridgeManager : BridgeManager	CanvasComponent
		center : Point The world coordinate at the center of the canvas component.	CanvasComponent
		contentRect : Rectangle Gets and sets the Rectangle in world coordinates that holds the contents.	CanvasComponent
		context : ICanvasContext [read-only] Returns an implementation of ICanvasContext that describes the state of this canvas control.	CanvasComponent
		cursor : Cursor Get or set the cursor instance that will be displayed for this canvas.	CanvasComponent
		doubleClickSize : ISize The size of the area within which the user must click twice for the two clicks to be considered a double-click.	CanvasComponent
		doubleClickTime : int The time that may elapse between two consecutive mouse clicks so the last click is still considered a double click.	CanvasComponent
		dragSize : ISize The area in view coordinates the mouse may stay in before a movement is considered a drag.	CanvasComponent
		dragTime : int The value of the drag time.	CanvasComponent
		editable : Boolean Property that sets the editable state of this canvas.	CanvasComponent
		enableMouseChildren : int Determines whether to propagate mouse events to the children in the display list.	CanvasComponent
		graph : IGraph [write-only] The graph that is rendered in the overview.	GraphOverviewComponent
		graphCanvas : GraphCanvasComponent The client control that will be used to retrieve the graph from and that will be used for navigating.	GraphOverviewComponent
		graphPaintable : IDisplayObjectCreator [read-only] The IDisplayObjectCreator that is used to render the overview graph.	GraphOverviewComponent
		hasHorizontalScrollBar : Boolean [read-only]	CanvasComponent
		hasVerticalScrollBar : Boolean [read-only]	CanvasComponent
		highPerformanceModeEnabled : Boolean Whether a high-performing OverviewGraphPaintable is used to preview the graph instead of the more flexible OverviewGraphDisplayObjectCreator.	GraphOverviewComponent
		hitTestRadius : Number Specifies the radius of the area around the mouse in view coordinates in which an IHitTestable may lie to be considered a valid hit.	CanvasComponent
		horizontalLineScrollSize : Number The amount to scroll when an arrow button of the horizontal scrollbar is pressed, in pixels.	CanvasComponent
		horizontalPageScrollSize : Number Specifies the amount to scroll when the horizontal scroll bar track is pressed, in pixels.	CanvasComponent
		horizontalScrollPolicy : String Specifies the visibility policy for the horizontal scrollbar.	CanvasComponent
		horizontalScrollPosition : Number The current position of the horizontal scroll bar.	CanvasComponent
		inputMode : IInputMode Specifies the single IInputMode instance that shall be installed for this canvas.	CanvasComponent
		inputModeContext : IInputModeContext The InputModeContext property.	CanvasComponent
		inputModeContextLookupChain : LookupChain [read-only] Retrieves the LookupChain that can be used to decorate the lookup call in the inputModeContext.	CanvasComponent
		inputModes : List [read-only] Returns the internal list of currently installed IInputModes.	CanvasComponent
		lastCanvasMouseEvent : CanvasMouseEvent [read-only] Gets the last CanvasMouseEvent that was dispatched by this instance.	CanvasComponent
		limitedMinZoom : Number [read-only] Returns the minimum zoom value for the current canvas size and viewport limits	CanvasComponent
		maxHorizontalScrollPosition : Number [read-only] If the canvas component currently has a horizontal scroll bar, returns the maxScrollPosition of the horizontal scroll bar.	CanvasComponent
		maxVerticalScrollPosition : Number [read-only] If the canvas component currently has a vertical scroll bar, returns the maxScrollPosition of the vertical scroll bar.	CanvasComponent
		maxZoom : Number The maxZoom property.	CanvasComponent
		minHorizontalScrollPosition : Number [read-only] If the canvas component currently has a horizontal scroll bar, returns the minScrollPosition of the horizontal scroll bar.	CanvasComponent
		minVerticalScrollPosition : Number [read-only] If the canvas component currently has a vertical scroll bar, returns the minScrollPosition of the vertical scroll bar.	CanvasComponent
		minZoom : Number The minZoom property.	CanvasComponent
		mouseInterval : Number Time interval in milliseconds after which a mouse move (MouseEvent.MOUSE_MOVE) is processed.	CanvasComponent
		mouseWheelZoomCenteredRecognizer : Function 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.	CanvasComponent
		mouseWheelZoomFactor : Number The factor by which the zoom level changes when the mouse wheel is turned.	CanvasComponent
		mouseWheelZoomMouseLocationRecognizer : Function 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.	CanvasComponent
		overviewInputMode : OverviewInputMode The OverviewInputMode that is used to navigate the client control.	GraphOverviewComponent
		treeDirty : Boolean Property that determines whether the whole canvasObjectTree is redrawn upon the next invocation of updateDisplayList().	CanvasComponent
		treePartiallyDirty : Boolean Property that determines whether the canvasObjectTree is redrawn partially upon the next invocation of updateDisplayList().	CanvasComponent
		verticalLineScrollSize : Number The amount to scroll when an arrow button of the vertical scrollbar is pressed, in pixels.	CanvasComponent
		verticalPageScrollSize : Number Specifies the amount to scroll when the vertical scroll bar track is pressed, in pixels.	CanvasComponent
		verticalScrollPolicy : String Specifies the visibility policy for the vertical scrollbar.	CanvasComponent
		verticalScrollPosition : Number The current position of the vertical scroll bar.	CanvasComponent
		viewPoint : Point The current view point.	CanvasComponent
		viewPort : IRectangle [read-only] Returns the currently visible viewing region in world coordinates.	CanvasComponent
		viewportLimiter : ViewportLimiter Gets or sets the viewport limiter instance that can be used to limit the explorable region.	CanvasComponent
		zoom : Number The zoom factor for this canvas control.	CanvasComponent
		zoomIfCanvasHit : Boolean 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).	CanvasComponent

	Property	Defined By
		_viewPoint : Point	CanvasComponent

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		GraphOverviewComponent(canvas:GraphCanvasComponent = null) Creates a new instance that is initially bound to the given control.	GraphOverviewComponent
		addCanvasObject(userObject:Object, descriptor:ICanvasObjectDescriptor = null, group:ICanvasObjectGroup = null):ICanvasObject Adds an element to the internal canvas object tree to the specified group.	CanvasComponent
		addDisplayObjectCreator(creator:IDisplayObjectCreator, group:ICanvasObjectGroup = null):ICanvasObject Adds an IDisplayObjectCreator instance to the scene graph using CanvasObjectDescriptor.Instance as the ICanvasObjectDescriptor.	CanvasComponent
		addGroup():ICanvasObjectGroup Adds a new ICanvasObjectGroup to the root of the canvas object tree.	CanvasComponent
		addGroupToGroup(toGroup:ICanvasObjectGroup):ICanvasObjectGroup Adds a new ICanvasObjectGroup to the specified group in the current canvas object tree.	CanvasComponent
		addPaintable(paintable:IPaintable, group:ICanvasObjectGroup = null):ICanvasObject Deprecated Since 1.7: Please Use addDisplayObjectCreator Adds an IPaintable instance to the scene graph using CanvasObjectDescriptor.Instance as the ICanvasObjectDescriptor.	CanvasComponent
		collectCanvasObjects(x:Number, y:Number, elementFoundCallback:Function):void Collects all canvas object instances that are hit at the given coordinate set.	CanvasComponent
		createSprite():PrintSprite Creates a sprite containing a complete copy of the current canvas object tree.	CanvasComponent
		decreaseZoom(factor:Number = 1.2):void Descrease the current zoom level using the provided factor.	CanvasComponent
		fitContent():void Adjusts the view port to fully encompass the current content rectangle.	CanvasComponent
		fitGraphBounds(margins:IRectangle = null):void Updates the content rectangle and adjusts the viewport to encompass the contents.	CanvasComponent
		forceRepaint():void Invalidates this canvas component and causes a repaint of all display objects that are visible in this canvas component.	CanvasComponent
		getCanvasObject(worldX:Number, worldY:Number):ICanvasObject Returns the top most canvas object instance that is hit at the given coordinate set.	CanvasComponent
		getCanvasObjects(worldX:Number, worldY:Number):Iterable Returns a list of all canvas objects in hit order at the given world coordinate location.	CanvasComponent
		getCanvasRect():Rectangle Returns a rectangle defined by the available space for displaying the CanvasObjectTree within this Component, in stage coordinates.	CanvasComponent
		getHits(stageX:Number, stageY:Number, useShape:Boolean = true):Array Returns an array of ICanvasObjects that are hit by the given coords.	CanvasComponent
		increaseZoom(factor:Number = 1.2):void Increase the current zoom level using the provided factor.	CanvasComponent
		invalidateAllObjects():void Forces a repaint of all canvas objects.	CanvasComponent
		invalidateDirtyObjects():void Forces a repaint of the dirty canvas objects.	CanvasComponent
		invalidateDisplayList():void [override] Marks a component so that its updateDisplayList() method gets called during a later screen update.	CanvasComponent
		isCanvasHit(target:DisplayObject, stageX:Number, stageY:Number):Boolean Checks whether the point at stageX,stageY is within the canvas bounds and target is a child of the canvas.	CanvasComponent
		iterateHits(x:Number, y:Number, root:ICanvasObjectGroup = null, filter:Function = null):Iterator Iterates all hit elements in the canvas below the given group that are accepted by a given filter.	CanvasComponent
		lookup(type:Class):Object	CanvasComponent
		print(bitmap:Boolean = true, borderSize:uint = 5, backgroundFill:* = 0xFFFFFF, printRect:Rectangle = null, canvasSprite:Sprite = null):void Prints the current canvas object tree or a pre-calculated copy of it.	CanvasComponent
		setLimitedCenter(center:Point):void Sets the provided center unless this would cause the viewport to exceed the limits of the viewportLimiter.	CanvasComponent
		setLimitedViewpoint(vp:Point):void Sets the provided viewpoint unless this would cause the viewport to exceed the limits of the viewportLimiter.	CanvasComponent
		setLimitedViewport(target:IRectangle):void Sets the provided viewport unless this would cause the viewport to exceed the limits of the viewportLimiter.	CanvasComponent
		setLimitedZoom(newZoom:Number):void Sets the provided zoom value unless this would cause the viewport to exceed the limits of the viewportLimiter.	CanvasComponent
		toViewCoordinates(p:IMutablePoint):void Converts a point in world coordinates to view coordinates.	CanvasComponent
		toWorldCoordinates(p:IMutablePoint):void Converts a point in view coordinates to world coordinates.	CanvasComponent
		updateContentRect(margins:IRectangle = null):void Updates the contentRect to encompass the bounds by all elements in the current scene graph upon the next invocation of updateDisplayList.	CanvasComponent
		zoomTo(px:Number, py:Number, theZoom:Number):void Sets the zoom level and view port center to the given values.	CanvasComponent
		zoomToRect(rect:Rectangle, maxZoom:Number):void Adjusts the view port to fit in the given rectangle.	CanvasComponent

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		adjustCursor(evt:CanvasMouseEvent):void Adjusts the mouse cursor based on the given mouse event and the cursor property.	CanvasComponent
		createChildren():void [override]	CanvasComponent
		createGraphDisplayObjectCreator(graph:IGraph):IDisplayObjectCreator Factory method that creates the display object creator that renders the preview of the graph if highPerformanceModeEnabled is false.	GraphOverviewComponent
		createGraphPaintable(graph:IGraph):OverviewGraphPaintable Factory method that creates the paintable that renders the preview of the graph if highPerformanceModeEnabled is true.	GraphOverviewComponent
		createInputModeContext():IInputModeContext Factory method for the InputModeContext property.	CanvasComponent
		disposeListeners(eventDispatcher:IEventDispatcher):void Unregister all event listeners that were registered with the stage.	CanvasComponent
		doEvent(e:Event = null):void Delayed processing of a MouseEvent.MOUSE_MOVE.	CanvasComponent
		fitContentCore():void When fitContent() is called, this method is invoked in the next updateDisplayList() execution to actually fit the content rectangle into the viewport.	CanvasComponent
		initListeners(eventDispatcher:IEventDispatcher):void Initialize all event listeners that should be registered with the stage.	CanvasComponent
		inputModeContextLookup(type:Class):Object Callback that is used by the default implementation of inputModeContext to resolve lookup calls.	CanvasComponent
		measure():void [override] Calculates the default size and the default minimum size of the component.	CanvasComponent
		mouseWheelZoom(evt:CanvasMouseEvent):void If the autoMouseWheelZoom property is set to true, this method will adjust the current zoom level.	CanvasComponent
		onAdd(event:FlexEvent):void Called when the component is added to the display list.	CanvasComponent
		onAutoDragChanged(oldValue:Boolean, newValue:Boolean):void Called when the autoDrag property changes.	CanvasComponent
		onAutoDragInsetsChanged(oldValue:ImmutableRectangle, newValue:ImmutableRectangle):void Called when the autoDragInsets property changes.	CanvasComponent
		onCanvasMouseClicked(evt:CanvasMouseEvent):void Callback method that is called when the mouse has been clicked.	CanvasComponent
		onCanvasMouseDown(evt:CanvasMouseEvent):void Callback method that is called when a mouse button has been pressed.	CanvasComponent
		onCanvasMouseDragged(evt:CanvasMouseEvent):void Callback method that is called when the mouse gets dragged.	CanvasComponent
		onCanvasMouseMoved(evt:CanvasMouseEvent):void Callback method that is called when the mouse has been moved and the mouse button has not been pressed.	CanvasComponent
		onCanvasMouseUp(evt:CanvasMouseEvent):void Callback method that is called when a mouse button has been released.	CanvasComponent
		onCanvasMouseWheel(evt:CanvasMouseEvent):void Callback method that is called when the mouse wheel has been turned.	CanvasComponent
		onContentRectChanged():void Callback that is invoked when the ContentRect property changes.	CanvasComponent
		onEditableChanged():void Callback that is called when the editable property changes.	CanvasComponent
		onHitTestRadiusChanged(oldValue:Number, newValue:Number):void Callback that is invoked when the hitTestRadius property changed.	CanvasComponent
		onInputModeChanged(oldValue:IInputMode, newValue:IInputMode):void Callback that is invoked when the inputMode property changes.	CanvasComponent
		onInputModeContextChanged(oldInputModeContext:IInputModeContext, newInputModeContext:IInputModeContext):void Called when the inputModeContext property value changes and after initialization of the field.	CanvasComponent
		onMouseDown(evt:MouseEvent):void Tries to gain the focus, if the canvas area was hit.	CanvasComponent
		onMouseEvent(evt:MouseEvent):void Deprecated: Use the various onCanvasMouseXXX hooks or event listeners for CanvasMouseEvents instead. Called when this component receives a MouseEvent.	CanvasComponent
		onMouseMove(evt:MouseEvent):void Calls onCanvasMouseDragged or onCanvasMouseMoved with the corresponding CanvasMouseEvent.	CanvasComponent
		onMouseUp(evt:MouseEvent):void Calls onCanvasMouseUp and possibly onCanvasMouseClicked with the corresponding CanvasMouseEvent.	CanvasComponent
		onMouseWheel(evt:MouseEvent):void Calls onCanvasMouseWheel with the corresponding CanvasMouseEvent.	CanvasComponent
		onRemove(event:FlexEvent):void Called when the component is removed from the display list.	CanvasComponent
		onViewPortChanged():void Callback that is invoked when the view port property changes.	CanvasComponent
		processEvent(event:Event):void Processes a mouse event.	CanvasComponent
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]	CanvasComponent
		updateTree(partially:Boolean = false):void Repaints the display list	CanvasComponent
		updateViewport():void update the viewport bounds upon the next invocation of updateDisplayList.	CanvasComponent

Summary	Defined By
autoDragChanged	Dispatched when the autoDrag property changes.	CanvasComponent
autoDragInsetsChanged	Dispatched when the autoDragInsets property changes.	CanvasComponent
canvasMouseClick	Dispatched when the mouse is clicked.	CanvasComponent
canvasMouseDoubleClick	Dispatched when the mouse is double clicked.	CanvasComponent
canvasMouseDown	Dispatched when the mouse is pressed.	CanvasComponent
canvasMouseDrag	Dispatched when the mouse is dragged.	CanvasComponent
canvasMouseMove	Dispatched when the mouse is moved.	CanvasComponent
canvasMouseUp	Dispatched when the mouse is released.	CanvasComponent
canvasMouseWheel	Dispatched when the mousewheel moves.	CanvasComponent
contentRectChanged	Dispatched when the contentRect property changes.	CanvasComponent
editableChanged	Dispatched when the editable property changes.	CanvasComponent
inputModeChanged	Dispatched when the inputMode property changes.	CanvasComponent
inputModeContextChanged	Dispatched when the inputModeContext property changes.	CanvasComponent
invalidated	Dispatched when the canvas has been invalidated.	CanvasComponent
scroll	Dispatched when one of the scrollbars changes its scroll position.	CanvasComponent
updateTree	Dispatched when the canvas object tree is repainted.	CanvasComponent
viewPointChanged	Dispatched when the viewPoint property changes.	CanvasComponent
viewPortChanged	Dispatched when the viewPort property changes.	CanvasComponent
zoomChanged	Dispatched when the zoom property changes.	CanvasComponent

	Constant	Defined By
		AUTO_DRAG_CHANGED : String = autoDragChanged [static] Dispatched when the autoDrag property changes.	CanvasComponent
		AUTO_DRAG_INSETS_CHANGED : String = autoDragInsetsChanged [static] Dispatched when the autoDragInsets property changes.	CanvasComponent
		CONTENT_RECT_CHANGED : String = contentRectChanged [static] Dispatched when the contentRect property changes.	CanvasComponent
		EDITABLE_CHANGED : String = editableChanged [static] Dispatched when the editable property changes.	CanvasComponent
		INPUT_MODE_CHANGED : String = inputModeChanged [static] Dispatched when the inputMode property changes.	CanvasComponent
		INPUT_MODE_CONTEXT_CHANGED : String = inputModeContextChanged [static] Dispatched when the inputModeContext property changes.	CanvasComponent
		INVALIDATED : String = invalidated [static] Dispatched when the canvas has been invalidated.	CanvasComponent
		MOUSE_CHILDREN_ALWAYS : int = 1 [static] Mouse events will always be propagated to child DisplayObjects.	CanvasComponent
		MOUSE_CHILDREN_AUTO : int = -1 [static] Mouse events will only be propagated to child DisplayObjects if they may need interactivity.	CanvasComponent
		MOUSE_CHILDREN_NEVER : int = 0 [static] Mouse events will never be propagated to child DisplayObjects.	CanvasComponent
		VIEWPORT_CHANGED : String = viewPortChanged [static] Kept for backward compatibility.	CanvasComponent

Property Detail

graph

property

graph:IGraph [write-only]

The graph that is rendered in the overview.

Implementation
public function set graph(value:IGraph):void

graphCanvas

property

graphCanvas:GraphCanvasComponent

The client control that will be used to retrieve the graph from and that will be used for navigating.

Implementation
public function get graphCanvas():GraphCanvasComponent
public function set graphCanvas(value:GraphCanvasComponent):void

graphPaintable

property

graphPaintable:IDisplayObjectCreator [read-only]

The IDisplayObjectCreator that is used to render the overview graph.

Implementation
public function get graphPaintable():IDisplayObjectCreator

highPerformanceModeEnabled

property

highPerformanceModeEnabled:Boolean

Whether a high-performing OverviewGraphPaintable is used to preview the graph instead of the more flexible OverviewGraphDisplayObjectCreator.

The default value is true.

Implementation
public function get highPerformanceModeEnabled():Boolean
public function set highPerformanceModeEnabled(value:Boolean):void

yFiles FLEX 1.9 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
GraphOverviewComponent	Properties \| Methods \| Events \| Constants