| Package | com.yworks.ui |
| Class | public class GraphOverviewComponent |
| Inheritance | GraphOverviewComponent  CanvasComponent mx.core.UIComponent |
IGraph contained in another
GraphCanvasComponent
This control uses a OverviewGraphPaintable to display the graph in a preview mode
and an OverviewInputMode to allow for easily navigating in the GraphCanvasComponent.
See also
| 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
Sets the alpha value of the canvas background color.
| CanvasComponent | |
| backgroundColor : uint
Sets the background color of the canvas.
| 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
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 | |
| 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 : OverviewGraphPaintable
The
OverviewGraphPaintable that is used to render the
overview graph. | 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
Retrieves the
LookupChain that can be used
to decorate the lookup call in the inputModeContext. | CanvasComponent | |
| inputModes : List
Returns the internal list of currently installed
IInputModes. | CanvasComponent | |
| lastCanvasMouseEvent : CanvasMouseEvent
Gets the last
CanvasMouseEvent
that was dispatched by this instance. | CanvasComponent | |
| maxZoom : Number
The
maxZoom property. | CanvasComponent | |
| minZoom : Number
The
minZoom property. | CanvasComponent | |
| mouseWheelZoomFactor : Number
The factor by which the zoom level changes when the mouse wheel is turned.
| 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
Returns the currently visible viewing region in world coordinates.
| 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 | |
| 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 | |
|
Adds a new
ICanvasObjectGroup to the root of the canvas object tree. | CanvasComponent | |
|
Adds a new
ICanvasObjectGroup to the specified group in the current canvas object tree. | CanvasComponent | |
|
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():Sprite
Creates a sprite containing a complete copy of the current canvas object tree.
| CanvasComponent | |
|
fitContent():void
Adjusts the view port to fully encompass the current content rectangle.
| CanvasComponent | |
|
fitGraphBounds():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 | |
|
invalidateDisplayList():void
Marks a component so that its updateDisplayList() method gets called during a later screen update.
| GraphOverviewComponent | ||
|
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 | |
|
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):void
Prints the current canvas object tree.
| 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 | |
| Method | Defined by | ||
|---|---|---|---|
|
adjustCursor(evt:CanvasMouseEvent):void
Adjusts the mouse cursor based on the given mouse event and
the
cursor property. | CanvasComponent | |
|
createChildren():void
| CanvasComponent | |
|
Factory method that creates the paintable that renders the preview of the graph.
| GraphOverviewComponent | ||
|
Factory method for the InputModeContext property.
| CanvasComponent | |
|
disposeListeners(eventDispatcher:IEventDispatcher):void
Unregister all event listeners that were registered with the stage.
| 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 | |
|
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 | |
|
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 | |
|
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 | |
|
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 | |
|
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
| CanvasComponent | |
|
updateTree(partially:Boolean = false):void
Repaints the display list
| CanvasComponent | |
|
updateViewport():void
update the viewport bounds upon the next invocation of
updateDisplayList. | CanvasComponent | |
| graph | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesgraph:IGraph [write-only]The graph that is rendered in the overview.
Implementation public function set graph(value:IGraph):void
| graphCanvas | property |
graphCanvas:GraphCanvasComponent [read-write]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:OverviewGraphPaintable [read-write]
The OverviewGraphPaintable that is used to render the
overview graph.
public function get graphPaintable():OverviewGraphPaintable
public function set graphPaintable(value:OverviewGraphPaintable):void
| overviewInputMode | property |
overviewInputMode:OverviewInputMode [read-write]
The OverviewInputMode that is used to navigate the client control.
public function get overviewInputMode():OverviewInputMode
public function set overviewInputMode(value:OverviewInputMode):void
| GraphOverviewComponent | () | constructor |
public function GraphOverviewComponent(canvas:GraphCanvasComponent = null)Creates a new instance that is initially bound to the given control.
If the canvas parameter is null, either the
graphCanvas or graph property has to be set to
be useful.
canvas:GraphCanvasComponent (default = null)GraphCanvasComponent to create an overview for.
|
| createGraphPaintable | () | method |
protected function createGraphPaintable(graph:IGraph):OverviewGraphPaintableFactory method that creates the paintable that renders the preview of the graph.
Parametersgraph:IGraph — The graph to draw.
|
OverviewGraphPaintable —
A overview paintable.
|
| invalidateDisplayList | () | method |
public override function invalidateDisplayList():voidMarks a component so that its updateDisplayList() method gets called during a later screen update.