Package | com.yworks.yfiles.layout |
Class | public class LayoutGraph |
Inheritance | LayoutGraph Graph YObject Object |
Implements | GraphLayout |
Subclasses | CopiedLayoutGraph, DefaultLayoutGraph |
Property | Defined By | ||
---|---|---|---|
dataProviderKeys : Vector.<Object> [read-only]
Returns an array of all data provider look-up keys that are registered with this graph. | Graph | ||
edgeList : EdgeList [read-only]
Returns a list, which contains the edges of the graph. | LayoutGraph | ||
empty : Boolean [read-only]
Returns true if this graph contains no nodes. | Graph | ||
graphCopyFactory : GraphCopier_CopyFactory
Specifies the copy factory that is associated with this instance. | Graph | ||
graphListeners : Iterator [read-only]
Returns an iterator that grants access to all registered graph listeners. | Graph | ||
registeredEdgeMaps : Vector.<Object> [read-only]
Returns all edge maps that have been created by this graph but have not yet been disposed. | Graph | ||
registeredNodeMaps : Vector.<Object> [read-only]
Returns all node maps that have been created by this graph but have not yet been disposed. | Graph |
Method | Defined By | ||
---|---|---|---|
LayoutGraph(init:Boolean = true)
Creates a new Layout Graph
| LayoutGraph | ||
addDataProvider(providerKey:Object, data:DataProvider):void
Registers the given data provider using the given look-up key. | Graph | ||
addGraphListener(listener:GraphListener):void
Registers the given graph listener with this graph. | Graph | ||
Redefines an edge's end points and fires corresponding notification events to inform registered listeners. | Graph | ||
clear():void
Removes all nodes and edges from this graph and fires corresponding notification events to inform registered listeners. | Graph | ||
containsEdge(e:Edge):Boolean
Whether or not this graph contains the given edge. | Graph | ||
Returns whether or not this graph contains an edge that connects the given nodes. | Graph | ||
containsNode(v:Node):Boolean
Whether or not this graph contains the given node. | Graph | ||
Creates a copy of this graph. | Graph | ||
Creates a new edge in this graph and fires a corresponding notification event to inform registered listeners. | Graph | ||
Creates a new edge in this graph to be ordered before or after a given edge and fires a corresponding notification event to inform registered listeners. | Graph | ||
Returns a newly created edge map that is valid for the edges in this graph. | Graph | ||
Creates an empty base object of the same type as this graph. | Graph | ||
Creates a new node in this graph and fires a corresponding notification event to inform registered listeners. | Graph | ||
Returns a newly created node map that is valid for the nodes in this graph. | Graph | ||
disposeEdgeMap(map:EdgeMap):void
Informs the graph that the given edge map is no longer needed. | Graph | ||
disposeNodeMap(map:NodeMap):void
Informs the graph that the given node map is no longer needed. | Graph | ||
E():int
Returns the number of edges in this graph. | Graph | ||
edgeCount():int
Returns the number of edges in this graph. | Graph | ||
Returns an iterator that provides access to all edges residing in this graph. | Graph | ||
Provides access to the edges of the graph. | Graph | ||
equals(o:Object):Boolean | YObject | ||
firePostEvent():void
Propagates a so-called POST event to all registered graph listeners. | Graph | ||
firePostEventWithId(id:Object):void
Like firePostEvent(). | Graph | ||
firePreEvent():void
Propagates a so-called PRE event to all registered graph listeners. | Graph | ||
firePreEventWithId(id:Object):void
Like firePreEvent(). | Graph | ||
Returns the first edge in this graph. | Graph | ||
Returns the first node in this graph. | Graph | ||
Returns the bounding box of the diagram. | LayoutGraph | ||
Returns the position of a node in a drawing. | LayoutGraph | ||
getCenterX(v:Node):Number
Returns the center x-coordinate of the given node. | LayoutGraph | ||
getCenterY(v:Node):Number
Returns the center y-coordinate of the given node. | LayoutGraph | ||
getClass():Class [override] | LayoutGraph | ||
getDataProvider(providerKey:Object):DataProvider
Returns the data provider that is registered with the graph using the given look-up key. | Graph | ||
getEdgeArray():Vector.<Object>
Returns an array containing all edges of this graph. | Graph | ||
Returns the edge which is described by a given label layout. | LayoutGraph | ||
getEdgeLabelLayout(edge:Object):Vector.<Object>
Returns EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge. | LayoutGraph | ||
getEdgeLabelLayoutForEdge(edge:Edge):Vector.<Object>
Returns EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge. | LayoutGraph | ||
getEdgeLayout(edge:Object):EdgeLayout
Returns the layout information for an edge in the drawing. | LayoutGraph | ||
Returns the layout information for an edge in the drawing. | LayoutGraph | ||
Returns the height of the given node
| LayoutGraph | ||
Returns the position of the node in a drawing. | LayoutGraph | ||
getNodeArray():Vector.<Object>
Returns an array containing all nodes of this graph. | Graph | ||
Returns the node which is described by a given label layout. | LayoutGraph | ||
getNodeLabelLayout(node:Object):Vector.<Object>
Returns NodeLabelLayout objects which describe the layouts of the labels that belong to the given node. | LayoutGraph | ||
getNodeLabelLayoutForNode(node:Node):Vector.<Object>
Returns NodeLabelLayout objects which describe the layouts of the labels that belong to the given node. | LayoutGraph | ||
getNodeLayout(node:Object):NodeLayout
Returns the layout information for a node in the drawing. | LayoutGraph | ||
Returns the layout information for a node in the drawing. | LayoutGraph | ||
Returns the path of an edge. | LayoutGraph | ||
Returns the path of an edge. | LayoutGraph | ||
Returns the control points of an edge. | LayoutGraph | ||
Returns the control points of an edge. | LayoutGraph | ||
Returns the bounding box of a node. | LayoutGraph | ||
Returns the size of the node in a drawing. | LayoutGraph | ||
getSource(edge:Object):Object
Returns the source node associated with the given edge. | Graph | ||
Returns the coordinates of the source end point of an edge in absolute coordinates. | LayoutGraph | ||
Returns the coordinates of the source end point of an edge in relative coordinates to the center of the source node. | LayoutGraph | ||
getTarget(edge:Object):Object
Returns the target node associated with the given edge. | Graph | ||
Returns the coordinates of the target end point of an edge in absolute coordinates. | LayoutGraph | ||
Returns the coordinates of the target end point of an edge in relative coordinates to the center of the target node. | LayoutGraph | ||
Returns the width of the given node. | LayoutGraph | ||
Returns the upper left x-coordinate of the given node. | LayoutGraph | ||
Returns the upper left y-coordinate of the given node. | LayoutGraph | ||
hashCode():int | YObject | ||
Hides the given edge from this graph. | Graph | ||
Hides the given node from this graph. | Graph | ||
Returns the last edge in this graph. | Graph | ||
Returns the last node in this graph. | Graph | ||
Moves the location of a node by a given vector
| LayoutGraph | ||
Redefines an edge's end points and fires corresponding notification events to inform registered listeners. | Graph | ||
moveEdgeTo(e:Edge, newSource:Node, sourceReference:Edge, sourceD:int, newTarget:Node, targetReference:Edge, targetD:int):void
Redefines an edge's end points and fires corresponding notification events to inform registered listeners. | Graph | ||
moveEdgeToFirst(e:Edge):void
Moves the given edge to the first position within the sequence of edges in this graph. | Graph | ||
moveEdgeToLast(e:Edge):void
Moves the given edge to the last position within the sequence of edges in this graph. | Graph | ||
moveNodeToFirst(v:Node):void
Moves the given node to the first position within the sequence of nodes in this graph. | Graph | ||
moveNodeToLast(v:Node):void
Moves the given node to the last position within the sequence of nodes in this graph. | Graph | ||
Moves an induced subgraph to another graph. | Graph | ||
N():int
Returns the number of nodes in this graph. | Graph | ||
[static]
Instantiates an empty Graph object. | Graph | ||
[static]
Instantiates a new Graph object as a copy of the given graph. | Graph | ||
[static]
Instantiates a new Graph object as a partial copy of the given graph. | Graph | ||
nodeCount():int
Returns the number of nodes in this graph. | Graph | ||
Returns an iterator that provides access to all nodes residing in this graph. | Graph | ||
Provides access to the nodes of the graph. | Graph | ||
printNodeSlotSize():void
For internal debugging purposes only. | Graph | ||
reInsertEdge(e:Edge):void
Reinserts a formerly removed edge into this graph and fires a corresponding notification event to inform registered listeners. | Graph | ||
reInsertNode(v:Node):void
Reinserts a formerly removed node into this graph and fires a corresponding notification event to inform registered listeners. | Graph | ||
removeDataProvider(providerKey:Object):void
Removes the data provider that is registered using the given look-up key. | Graph | ||
removeEdge(e:Edge):void
Removes the given edge from this graph and fires a corresponding notification event to inform registered listeners. | Graph | ||
removeGraphListener(listener:GraphListener):void
Removes the given graph listener from this graph. | Graph | ||
removeNode(v:Node):void
Removes the given node from this graph. | Graph | ||
reverseEdge(e:Edge):void
Reverses the given edge and fires corresponding notification events to inform registered listeners. | Graph | ||
Sets the center coordinates of the given node. | LayoutGraph | ||
Sets the position of a node in a drawing. | LayoutGraph | ||
Set the two end points of an edge in absolute coordinates. | LayoutGraph | ||
setLocation(v:Node, x:Number, y:Number):void
Sets the upper left coordinates of the given node. | LayoutGraph | ||
Set the position of the node in a drawing. | LayoutGraph | ||
Sets the path of an edge. | LayoutGraph | ||
Sets the path of an edge. | LayoutGraph | ||
Sets the control points of an edge. | LayoutGraph | ||
Sets the control points of an edge. | LayoutGraph | ||
Sets the size of the given node. | LayoutGraph | ||
Set the size of the node in a drawing. | LayoutGraph | ||
Sets the coordinates of the source end point of an edge in absolute coordinates. | LayoutGraph | ||
Sets the coordinates of the source end point of an edge in relative coordinates to the center of the source node. | LayoutGraph | ||
Sets the coordinates of the target end point of an edge in absolute coordinates. | LayoutGraph | ||
Sets the coordinates of the target end point of an edge in relative coordinates to the center of the target node. | LayoutGraph | ||
Sorts incoming and outgoing edges at each node of the graph. | Graph | ||
sortEdges2(comp:Comparator):void
Sorts the internally held list of edges. | Graph | ||
sortNodes(comp:Comparator):void
Sorts the internally held list of nodes. | Graph | ||
toString():String
Returns a String representation of this graph. | Graph | ||
unhideEdge(e:Edge):void
Unhides the given edge in this graph. | Graph | ||
unhideNode(v:Node):void
Unhides the given node in this graph. | Graph |
Method | Defined By | ||
---|---|---|---|
[override] | LayoutGraph | ||
Creates a new com.yworks.yfiles.layout.LabelLayoutFactory. | LayoutGraph | ||
fireGraphEvent(e:GraphEvent):void
Propagates the given graph event to all registered graph listeners. | Graph | ||
[static]
Low-level iteration support for adjacent edges. | Graph | ||
hasListeners():Boolean
Determines whether there are listeners registered with this instance. | Graph | ||
initGraph1():void
Initializes this object. | Graph | ||
initGraph2(argGraph:Graph):void
Initializes this object. | Graph | ||
Initializes this object. | Graph | ||
initLayoutGraph1():void | LayoutGraph | ||
initLayoutGraph2(argGraph:LayoutGraph):void | LayoutGraph | ||
LayoutGraph |
edgeList | property |
edgeList:EdgeList
[read-only] Returns a list, which contains the edges of the graph.
public function get edgeList():EdgeList
LayoutGraph | () | Constructor |
public function LayoutGraph(init:Boolean = true)
Creates a new Layout Graph
Parametersinit:Boolean (default = true ) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods.
This parameter can safely be ignored/omitted when calling the constructor.
|
createGraphCopyFactory | () | method |
override protected function createGraphCopyFactory():GraphCopier_CopyFactory
ReturnsGraphCopier_CopyFactory |
createLabelFactory | () | method |
protected function createLabelFactory():LabelLayoutFactory
Creates a new com.yworks.yfiles.layout.LabelLayoutFactory.
ReturnsLabelLayoutFactory |
See also
getBoundingBox | () | method |
public function getBoundingBox():Rectangle
Returns the bounding box of the diagram. This is the smallest rectangle containing the entire diagram. If the graph does not contain any nodes (and therefore no edges either), the bounding box will have negative width and/or height.
ReturnsRectangle |
getCenter | () | method |
public function getCenter(node:Node):YPoint
Returns the position of a node in a drawing. The position is defined by the center of the node.
Parameters
node:Node — a node in the graph
|
YPoint — the center of the node in the drawing of the node
|
getCenterX | () | method |
public function getCenterX(v:Node):Number
Returns the center x-coordinate of the given node.
Parameters
v:Node |
Number |
getCenterY | () | method |
public function getCenterY(v:Node):Number
Returns the center y-coordinate of the given node.
Parameters
v:Node |
Number |
getClass | () | method |
override public function getClass():Class
ReturnsClass |
getEdgeFeature | () | method |
public function getEdgeFeature(labelLayout:EdgeLabelLayout):Edge
Returns the edge which is described by a given label layout.
Parameters
labelLayout:EdgeLabelLayout |
Edge |
getEdgeLabelLayout | () | method |
public function getEdgeLabelLayout(edge:Object):Vector.<Object>
Returns EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge.
Parameters
edge:Object — an edge in the drawing.
|
Vector.<Object> — the edge label layout information for edge .
|
getEdgeLabelLayoutForEdge | () | method |
public function getEdgeLabelLayoutForEdge(edge:Edge):Vector.<Object>
Returns EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge.
Parameters
edge:Edge — an edge in the drawing.
|
Vector.<Object> — the edge label layout information for edge .
|
getEdgeLayout | () | method |
public function getEdgeLayout(edge:Object):EdgeLayout
Returns the layout information for an edge in the drawing.
Parameters
edge:Object — a edge in the drawing.
|
EdgeLayout — the layout information for edge .
|
getEdgeLayoutForEdge | () | method |
public function getEdgeLayoutForEdge(edge:Edge):EdgeLayout
Returns the layout information for an edge in the drawing.
Parameters
edge:Edge — a edge in the drawing.
|
EdgeLayout — the layout information for edge .
|
getHeight | () | method |
public function getHeight(v:Node):Number
Returns the height of the given node
Parameters
v:Node |
Number |
getLocation | () | method |
public function getLocation(node:Node):YPoint
Returns the position of the node in a drawing. The position is defined by the upper left corner of the node.
Parameters
node:Node — a node in the graph
|
YPoint — the upper left corner of the drawing of the node
|
getNodeFeature | () | method |
public function getNodeFeature(labelLayout:NodeLabelLayout):Node
Returns the node which is described by a given label layout.
Parameters
labelLayout:NodeLabelLayout |
Node |
getNodeLabelLayout | () | method |
public function getNodeLabelLayout(node:Object):Vector.<Object>
Returns NodeLabelLayout objects which describe the layouts of the labels that belong to the given node.
Parameters
node:Object — a node in the drawing.
|
Vector.<Object> — the node label layout information for node .
|
getNodeLabelLayoutForNode | () | method |
public function getNodeLabelLayoutForNode(node:Node):Vector.<Object>
Returns NodeLabelLayout objects which describe the layouts of the labels that belong to the given node.
Parameters
node:Node — a node in the drawing.
|
Vector.<Object> — the node label layout information for node .
|
getNodeLayout | () | method |
public function getNodeLayout(node:Object):NodeLayout
Returns the layout information for a node in the drawing.
Parameters
node:Object — a node in the drawing.
|
NodeLayout — the layout information for node .
|
getNodeLayoutForNode | () | method |
public function getNodeLayoutForNode(node:Node):NodeLayout
Returns the layout information for a node in the drawing.
Parameters
node:Node — a node in the drawing.
|
NodeLayout — the layout information for node .
|
getPath | () | method |
public function getPath(edge:Edge):YPointPath
Returns the path of an edge. The path of an edge is the position of the source port, followed by the positions of the bends, followed by the position of the target port.
Parameters
edge:Edge — an edge in the graph
|
YPointPath — the path
|
getPathList | () | method |
public function getPathList(edge:Edge):YList
Returns the path of an edge. The path of an edge is the position of the source port, followed by the positions of the bends, followed by the position of the target port.
Parameters
edge:Edge — an edge in the graph
|
YList — the path as a YList
|
getPointList | () | method |
public function getPointList(edge:Edge):YList
Returns the control points of an edge.
Parameters
edge:Edge — an edge in the graph
|
YList — the sequence of control points as a YList
|
getPoints | () | method |
public function getPoints(edge:Edge):YPointPath
Returns the control points of an edge.
Parameters
edge:Edge — an edge in the graph
|
YPointPath — the sequence of control points.
|
getRectangle | () | method |
public function getRectangle(node:Node):YRectangle
Returns the bounding box of a node.
Parameters
node:Node — a node in the graph.
|
YRectangle — a box.
|
getSize | () | method |
public function getSize(node:Node):YDimension
Returns the size of the node in a drawing.
Parameters
node:Node — a node in the graph.
|
YDimension — the size of the node.
|
getSourcePointAbs | () | method |
public function getSourcePointAbs(edge:Edge):YPoint
Returns the coordinates of the source end point of an edge in absolute coordinates.
Parameters
edge:Edge — an edge in the graph
|
YPoint |
getSourcePointRel | () | method |
public function getSourcePointRel(edge:Edge):YPoint
Returns the coordinates of the source end point of an edge in relative coordinates to the center of the source node.
Parameters
edge:Edge — an edge in the graph
|
YPoint |
getTargetPointAbs | () | method |
public function getTargetPointAbs(edge:Edge):YPoint
Returns the coordinates of the target end point of an edge in absolute coordinates.
Parameters
edge:Edge — an edge in the graph
|
YPoint |
getTargetPointRel | () | method |
public function getTargetPointRel(edge:Edge):YPoint
Returns the coordinates of the target end point of an edge in relative coordinates to the center of the target node.
Parameters
edge:Edge — an edge in the graph
|
YPoint |
getWidth | () | method |
public function getWidth(v:Node):Number
Returns the width of the given node.
Parameters
v:Node |
Number |
getX | () | method |
public function getX(v:Node):Number
Returns the upper left x-coordinate of the given node.
Parameters
v:Node |
Number |
getY | () | method |
public function getY(v:Node):Number
Returns the upper left y-coordinate of the given node.
Parameters
v:Node |
Number |
initLayoutGraph1 | () | method |
protected final function initLayoutGraph1():void
initLayoutGraph2 | () | method |
protected final function initLayoutGraph2(argGraph:LayoutGraph):void
Parameters
argGraph:LayoutGraph |
initLayoutGraph3 | () | method |
protected final function initLayoutGraph3(graph:LayoutGraph, nodeSubset:YCursor):void
Parameters
graph:LayoutGraph | |
nodeSubset:YCursor |
moveBy | () | method |
public function moveBy(node:Node, dx:Number, dy:Number):void
Moves the location of a node by a given vector
Parameters
node:Node — a node in the graph
| |
dx:Number — the x-component of the vector
| |
dy:Number — the y-component of the vector
|
setCenter | () | method |
public function setCenter(v:Node, x:Number, y:Number):void
Sets the center coordinates of the given node.
Parameters
v:Node | |
x:Number | |
y:Number |
setCenter2 | () | method |
public function setCenter2(node:Node, position:YPoint):void
Sets the position of a node in a drawing. The position is defined by the center of the node.
Parameters
node:Node — a node in the graph
| |
position:YPoint — the center of the node in the drawing of the node
|
setEndPointsAbs | () | method |
public function setEndPointsAbs(edge:Edge, source:YPoint, target:YPoint):void
Set the two end points of an edge in absolute coordinates.
Parameters
edge:Edge — an edge in the graph.
| |
source:YPoint — the port on the source side of the edge.
| |
target:YPoint — the port on the target side of the edge.
|
setLocation | () | method |
public function setLocation(v:Node, x:Number, y:Number):void
Sets the upper left coordinates of the given node.
Parameters
v:Node | |
x:Number | |
y:Number |
setLocationToPoint | () | method |
public function setLocationToPoint(node:Node, position:YPoint):void
Set the position of the node in a drawing. The position is defined by the upper left corner of the node.
Parameters
node:Node — a node in the graph
| |
position:YPoint — the upper left corner of the drawing of the node
|
setPath | () | method |
public function setPath(edge:Edge, path:YList):void
Sets the path of an edge. The path of an edge is the position of the source port, followed by the positions of the bends, followed by the position of the target port. Both source and target port are expected to be given in absolute coordinates.
Precondition The length of the path must be 2 at least.
Parameters
edge:Edge — an edge in the graph
| |
path:YList — the path sequence given as a YList
|
setPath2 | () | method |
public function setPath2(edge:Edge, path:YPointPath):void
Sets the path of an edge. The path of an edge is the position of the source port, followed by the positions of the bends, followed by the position of the target port. Both source and target port are expected to be given in absolute coordinates.
Precondition The length of the path must be 2 at least.
Parameters
edge:Edge — an edge in the graph
| |
path:YPointPath — the path sequence.
|
setPoints | () | method |
public function setPoints(edge:Edge, points:YPointPath):void
Sets the control points of an edge.
Parameters
edge:Edge — an edge in the graph
| |
points:YPointPath — the sequence of control points.
|
setPointsFromList | () | method |
public function setPointsFromList(edge:Edge, points:YList):void
Sets the control points of an edge.
Parameters
edge:Edge — an edge in the graph
| |
points:YList — the sequence of control points as a YList
|
setSize | () | method |
public function setSize(v:Node, w:Number, h:Number):void
Sets the size of the given node.
Parameters
v:Node | |
w:Number | |
h:Number |
setSize2 | () | method |
public function setSize2(node:Node, size:YDimension):void
Set the size of the node in a drawing.
Parameters
node:Node — a node in the graph
| |
size:YDimension — the size of the node.
|
setSourcePointAbs | () | method |
public function setSourcePointAbs(edge:Edge, point:YPoint):void
Sets the coordinates of the source end point of an edge in absolute coordinates.
Parameters
edge:Edge — an edge in the graph
| |
point:YPoint |
setSourcePointRel | () | method |
public function setSourcePointRel(edge:Edge, point:YPoint):void
Sets the coordinates of the source end point of an edge in relative coordinates to the center of the source node.
Parameters
edge:Edge — an edge in the graph
| |
point:YPoint |
setTargetPointAbs | () | method |
public function setTargetPointAbs(edge:Edge, point:YPoint):void
Sets the coordinates of the target end point of an edge in absolute coordinates.
Parameters
edge:Edge — an edge in the graph
| |
point:YPoint |
setTargetPointRel | () | method |
public function setTargetPointRel(edge:Edge, point:YPoint):void
Sets the coordinates of the target end point of an edge in relative coordinates to the center of the target node.
Parameters
edge:Edge — an edge in the graph
| |
point:YPoint |