com.yworks.yfiles.layout.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
		edgeLabelFeatureMap : Map Map used to associate the owner of an edge label with the edge label itself.	DefaultLayoutGraph
		edgeLabelMap : EdgeMap EdgeMap used to associate edge label layouts with the edges of this graph.	DefaultLayoutGraph
		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
		nodeLabelFeatureMap : Map Map used to associate the owner of a node label with the node label itself.	DefaultLayoutGraph
		nodeLabelMap : NodeMap NodeMap used to associate node label layouts with the nodes of this graph.	DefaultLayoutGraph
		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

Public Methods

	Method		Defined By
		DefaultLayoutGraph(init:Boolean = true) Creates a new Layout Graph	DefaultLayoutGraph
		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
		changeEdgeTo(e:Edge, e1:Edge, e2:Edge, d1:int, d2:int):void 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
		containsEdgeBetweenNodes(source:Node, target:Node):Boolean 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
		createCopy():Graph Creates a copy of this graph.	Graph
		createEdge(v:Node, w:Node):Edge Creates a new edge in this graph and fires a corresponding notification event to inform registered listeners.	Graph
		createEdgeAt(v:Node, e1:Edge, w:Node, e2:Edge, d1:int, d2:int):Edge 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
		createEdgeMap():EdgeMap Returns a newly created edge map that is valid for the edges in this graph.	Graph
		createGraph():Graph Creates an empty base object of the same type as this graph.	Graph
		createNode():Node Creates a new node in this graph and fires a corresponding notification event to inform registered listeners.	Graph
		createNodeMap():NodeMap 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
		edgeObjects():Iterator Returns an iterator that provides access to all edges residing in this graph.	Graph
		edges():EdgeCursor 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
		firstEdge():Edge Returns the first edge in this graph.	Graph
		firstNode():Node Returns the first node in this graph.	Graph
		getBoundingBox():Rectangle Returns the bounding box of the diagram.	LayoutGraph
		getCenter(node:Node):YPoint 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]	DefaultLayoutGraph
		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
		getEdgeFeature(labelLayout:EdgeLabelLayout):Edge [override] Returns the edge which is described by a given label layout.	DefaultLayoutGraph
		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> [override] Returns EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge.	DefaultLayoutGraph
		getEdgeLayout(edge:Object):EdgeLayout Returns the layout information for an edge in the drawing.	LayoutGraph
		getEdgeLayoutForEdge(e:Edge):EdgeLayout [override] Returns the layout information for an edge in the drawing.	DefaultLayoutGraph
		getHeight(v:Node):Number Returns the height of the given node	LayoutGraph
		getLocation(node:Node):YPoint Returns the position of the node in a drawing.	LayoutGraph
		getNodeArray():Vector.<Object> Returns an array containing all nodes of this graph.	Graph
		getNodeFeature(labelLayout:NodeLabelLayout):Node [override] Returns the node which is described by a given label layout.	DefaultLayoutGraph
		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> [override] Returns NodeLabelLayout objects that describe the layouts of the labels belonging to the given node.	DefaultLayoutGraph
		getNodeLayout(node:Object):NodeLayout Returns the layout information for a node in the drawing.	LayoutGraph
		getNodeLayoutForNode(v:Node):NodeLayout [override] Returns the layout information for a node in the drawing.	DefaultLayoutGraph
		getPath(edge:Edge):YPointPath Returns the path of an edge.	LayoutGraph
		getPathList(edge:Edge):YList Returns the path of an edge.	LayoutGraph
		getPointList(edge:Edge):YList Returns the control points of an edge.	LayoutGraph
		getPoints(edge:Edge):YPointPath Returns the control points of an edge.	LayoutGraph
		getRectangle(node:Node):YRectangle Returns the bounding box of a node.	LayoutGraph
		getSize(node:Node):YDimension Returns the size of the node in a drawing.	LayoutGraph
		getSource(edge:Object):Object Returns the source node associated with the given edge.	Graph
		getSourcePointAbs(edge:Edge):YPoint Returns the coordinates of the source end point of an edge in absolute coordinates.	LayoutGraph
		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.	LayoutGraph
		getTarget(edge:Object):Object Returns the target node associated with the given edge.	Graph
		getTargetPointAbs(edge:Edge):YPoint Returns the coordinates of the target end point of an edge in absolute coordinates.	LayoutGraph
		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.	LayoutGraph
		getWidth(v:Node):Number Returns the width of the given node.	LayoutGraph
		getX(v:Node):Number Returns the upper left x-coordinate of the given node.	LayoutGraph
		getY(v:Node):Number Returns the upper left y-coordinate of the given node.	LayoutGraph
		hashCode():int	YObject
		hideEdge(e:Edge):void Hides the given edge from this graph.	Graph
		hideNode(v:Node):void Hides the given node from this graph.	Graph
		lastEdge():Edge Returns the last edge in this graph.	Graph
		lastNode():Node Returns the last node in this graph.	Graph
		moveBy(node:Node, dx:Number, dy:Number):void Moves the location of a node by a given vector	LayoutGraph
		moveEdge(e:Edge, newSource:Node, newTarget:Node):void 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
		moveSubGraph(subNodes:NodeList, targetGraph:Graph):EdgeList Moves an induced subgraph to another graph.	Graph
		N():int Returns the number of nodes in this graph.	Graph
		newDefaultLayoutGraph1():DefaultLayoutGraph [static] Creates a new Layout Graph	DefaultLayoutGraph
		newDefaultLayoutGraph2(argGraph:LayoutGraph):DefaultLayoutGraph [static] Creates a copy of the given subgraph.	DefaultLayoutGraph
		newDefaultLayoutGraph3(graph:DefaultLayoutGraph, nodeSubset:YCursor):DefaultLayoutGraph [static] Creates a copy of the given subgraph.	DefaultLayoutGraph
		newDefaultLayoutGraph4(graph:LayoutGraph, nodeSubset:YCursor):DefaultLayoutGraph [static] Creates a copy of the given subgraph.	DefaultLayoutGraph
		newGraph1():Graph [static] Instantiates an empty Graph object.	Graph
		newGraph2(argGraph:Graph):Graph [static] Instantiates a new Graph object as a copy of the given graph.	Graph
		newGraph3(graph:Graph, subNodes:YCursor):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
		nodeObjects():Iterator Returns an iterator that provides access to all nodes residing in this graph.	Graph
		nodes():NodeCursor 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
		setCenter(v:Node, x:Number, y:Number):void Sets the center coordinates of the given node.	LayoutGraph
		setCenter2(node:Node, position:YPoint):void Sets the position of a node in a drawing.	LayoutGraph
		setEdgeLabelLayouts(edge:Edge, layout:Vector.<Object>):void Sets the EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge.	DefaultLayoutGraph
		setEdgeLayout(e:Edge, layout:EdgeLayout):void Sets the layout information for an edge in the drawing.	DefaultLayoutGraph
		setEndPointsAbs(edge:Edge, source:YPoint, target:YPoint):void Set the two end points of an edge in absolute coordinates.	LayoutGraph
		setLayout(v:Node, layout:NodeLayout):void Sets the layout information for a node in the drawing.	DefaultLayoutGraph
		setLocation(v:Node, x:Number, y:Number):void Sets the upper left coordinates of the given node.	LayoutGraph
		setLocationToPoint(node:Node, position:YPoint):void Set the position of the node in a drawing.	LayoutGraph
		setNodeLabelLayout(node:Node, layout:NodeLabelLayout):void Sets the NodeLabelLayout object which describes the layout of the label that belongs to the given node.	DefaultLayoutGraph
		setNodeLabelLayouts(node:Node, llayout:Vector.<Object>):void Sets the NodeLabelLayout objects which describe the layouts of the labels that belong to the given node.	DefaultLayoutGraph
		setPath(edge:Edge, path:YList):void Sets the path of an edge.	LayoutGraph
		setPath2(edge:Edge, path:YPointPath):void Sets the path of an edge.	LayoutGraph
		setPoints(edge:Edge, points:YPointPath):void Sets the control points of an edge.	LayoutGraph
		setPointsFromList(edge:Edge, points:YList):void Sets the control points of an edge.	LayoutGraph
		setSize(v:Node, w:Number, h:Number):void Sets the size of the given node.	LayoutGraph
		setSize2(node:Node, size:YDimension):void Set the size of the node in a drawing.	LayoutGraph
		setSourcePointAbs(edge:Edge, point:YPoint):void Sets the coordinates of the source end point of an edge in absolute coordinates.	LayoutGraph
		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.	LayoutGraph
		setTargetPointAbs(edge:Edge, point:YPoint):void Sets the coordinates of the target end point of an edge in absolute coordinates.	LayoutGraph
		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.	LayoutGraph
		sortEdges(inComp:Comparator, outComp:Comparator):void 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
		createEdgeLayout():EdgeLayout Override this to create your own EdgeLayouts.	DefaultLayoutGraph
		createGraphCopyFactory():GraphCopier_CopyFactory [override] Creates a new com.yworks.yfiles.layout.LayoutGraphCopyFactory_HierarchicGraphCopyFactory.	DefaultLayoutGraph
		createLabelFactory():LabelLayoutFactory [override] Creates a new label layout factory for this graph.	DefaultLayoutGraph
		createNodeLayout():NodeLayout Override this to create your own NodeLayouts.	DefaultLayoutGraph
		fireGraphEvent(e:GraphEvent):void Propagates the given graph event to all registered graph listeners.	Graph
		firstOutEdge(v:Node):Edge [static] Low-level iteration support for adjacent edges.	Graph
		hasListeners():Boolean Determines whether there are listeners registered with this instance.	Graph
		initDefaultLayoutGraph1():void Initializes this object.	DefaultLayoutGraph
		initDefaultLayoutGraph2(argGraph:LayoutGraph):void Initializes this object.	DefaultLayoutGraph
		initDefaultLayoutGraph3(graph:DefaultLayoutGraph, nodeSubset:YCursor):void Initializes this object.	DefaultLayoutGraph
		initDefaultLayoutGraph4(graph:LayoutGraph, nodeSubset:YCursor):void Initializes this object.	DefaultLayoutGraph
		initGraph1():void Initializes this object.	Graph
		initGraph2(argGraph:Graph):void Initializes this object.	Graph
		initGraph3(graph:Graph, subNodes:YCursor):void Initializes this object.	Graph
		initLayoutGraph1():void	LayoutGraph
		initLayoutGraph2(argGraph:LayoutGraph):void	LayoutGraph
		initLayoutGraph3(graph:LayoutGraph, nodeSubset:YCursor):void	LayoutGraph

	Constant	Defined By
		AFTER : int = 0 [static] Object insertion specifier.	Graph
		BEFORE : int = 1 [static] Object insertion specifier.	Graph

Property Detail

edgeLabelFeatureMap

property

public var edgeLabelFeatureMap:Map

Map used to associate the owner of an edge label with the edge label itself.

edgeLabelMap

property

public var edgeLabelMap:EdgeMap

EdgeMap used to associate edge label layouts with the edges of this graph.

See also

setEdgeLabelLayouts()

nodeLabelFeatureMap

property

public var nodeLabelFeatureMap:Map

Map used to associate the owner of a node label with the node label itself.

nodeLabelMap

property

public var nodeLabelMap:NodeMap

NodeMap used to associate node label layouts with the nodes of this graph.

See also

setNodeLabelLayouts()

Constructor Detail

DefaultLayoutGraph

()

Constructor

public function DefaultLayoutGraph(init:Boolean = true)

Creates a new Layout Graph

Parameters

init: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.

Method Detail

createEdgeLayout

()

method

protected function createEdgeLayout():EdgeLayout

Override this to create your own EdgeLayouts.

Returns

EdgeLayout

createGraphCopyFactory

()

method

override protected function createGraphCopyFactory():GraphCopier_CopyFactory

Creates a new com.yworks.yfiles.layout.LayoutGraphCopyFactory_HierarchicGraphCopyFactory.

Returns

GraphCopier_CopyFactory

createLabelFactory

()

method

override protected function createLabelFactory():LabelLayoutFactory

Creates a new label layout factory for this graph.

Returns

LabelLayoutFactory — the new label layout factory.

createNodeLayout

()

method

protected function createNodeLayout():NodeLayout

Override this to create your own NodeLayouts.

Returns

NodeLayout

getClass

()

method

override public function getClass():Class

Returns

Class

getEdgeFeature

()

method

override public function getEdgeFeature(labelLayout:EdgeLabelLayout):Edge

Returns the edge which is described by a given label layout.

Parameters

labelLayout:EdgeLabelLayout

Returns

Edge

getEdgeLabelLayoutForEdge

()

method

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

Returns

Vector.<Object> — the edge label layout information for the given edge.

getEdgeLayoutForEdge

()

method

override public function getEdgeLayoutForEdge(e:Edge):EdgeLayout

Returns the layout information for an edge in the drawing.

Parameters

e:Edge — a edge in the drawing.

Returns

EdgeLayout — the layout information for the given edge.

getNodeFeature

()

method

override public function getNodeFeature(labelLayout:NodeLabelLayout):Node

Returns the node which is described by a given label layout.

Parameters

labelLayout:NodeLabelLayout

Returns

Node

getNodeLabelLayoutForNode

()

method

override public function getNodeLabelLayoutForNode(node:Node):Vector.<Object>

Returns NodeLabelLayout objects that describe the layouts of the labels belonging to the given node.

Parameters

node:Node — a node in the drawing.

Returns

Vector.<Object> — the node label layout information for the given node.

getNodeLayoutForNode

()

method

override public function getNodeLayoutForNode(v:Node):NodeLayout

Returns the layout information for a node in the drawing.

Parameters

v:Node — a node in the drawing.

Returns

NodeLayout — the layout information for node.

initDefaultLayoutGraph1

()

method

protected final function initDefaultLayoutGraph1():void

Initializes this object. See the documentation of the corresponding factory method newDefaultLayoutGraph1() for details.

See also

newDefaultLayoutGraph1()

initDefaultLayoutGraph2

()

method

protected final function initDefaultLayoutGraph2(argGraph:LayoutGraph):void

Initializes this object. See the documentation of the corresponding factory method newDefaultLayoutGraph2() for details.

Parameters

argGraph:LayoutGraph

See also

newDefaultLayoutGraph2()

initDefaultLayoutGraph3

()

method

protected final function initDefaultLayoutGraph3(graph:DefaultLayoutGraph, nodeSubset:YCursor):void

Initializes this object. See the documentation of the corresponding factory method newDefaultLayoutGraph3() for details.

Parameters

	`graph:DefaultLayoutGraph`

	`nodeSubset:YCursor`

See also

newDefaultLayoutGraph3()

initDefaultLayoutGraph4

()

method

protected final function initDefaultLayoutGraph4(graph:LayoutGraph, nodeSubset:YCursor):void

Initializes this object. See the documentation of the corresponding factory method newDefaultLayoutGraph4() for details.

Parameters

	`graph:LayoutGraph`

	`nodeSubset:YCursor`

See also

newDefaultLayoutGraph4()

newDefaultLayoutGraph1

()

method

public static function newDefaultLayoutGraph1():DefaultLayoutGraph

Creates a new Layout Graph

Returns

DefaultLayoutGraph

newDefaultLayoutGraph2

()

method

public static function newDefaultLayoutGraph2(argGraph:LayoutGraph):DefaultLayoutGraph

Creates a copy of the given subgraph.

Parameters

argGraph:LayoutGraph

Returns

DefaultLayoutGraph

newDefaultLayoutGraph3

()

method

public static function newDefaultLayoutGraph3(graph:DefaultLayoutGraph, nodeSubset:YCursor):DefaultLayoutGraph

Creates a copy of the given subgraph.

Parameters

	`graph:DefaultLayoutGraph`

	`nodeSubset:YCursor`

Returns

DefaultLayoutGraph

newDefaultLayoutGraph4

()

method

public static function newDefaultLayoutGraph4(graph:LayoutGraph, nodeSubset:YCursor):DefaultLayoutGraph

Creates a copy of the given subgraph.

Parameters

	`graph:LayoutGraph`

	`nodeSubset:YCursor`

Returns

DefaultLayoutGraph

setEdgeLabelLayouts

()

method

public function setEdgeLabelLayouts(edge:Edge, layout:Vector.<Object>):void

Sets the EdgeLabelLayout objects which describe the layouts of the labels that belong to the given edge.

Parameters

	`edge:Edge` — an edge in the drawing.

	`layout:Vector.<Object>` — an array of edge label layout objects

setEdgeLayout

()

method

public function setEdgeLayout(e:Edge, layout:EdgeLayout):void

Sets the layout information for an edge in the drawing.

Parameters

	`e:Edge`

	`layout:EdgeLayout`

setLayout

()

method

public function setLayout(v:Node, layout:NodeLayout):void

Sets the layout information for a node in the drawing.

Parameters

	`v:Node`

	`layout:NodeLayout`

setNodeLabelLayout

()

method

public function setNodeLabelLayout(node:Node, layout:NodeLabelLayout):void

Sets the NodeLabelLayout object which describes the layout of the label that belongs to the given node.

Parameters

	`node:Node` — a node in the drawing.

	`layout:NodeLabelLayout` — a layout object for the node label

setNodeLabelLayouts

()

method

public function setNodeLabelLayouts(node:Node, llayout:Vector.<Object>):void

Sets the NodeLabelLayout objects which describe the layouts of the labels that belong to the given node.

Parameters

	`node:Node` — a node in the drawing.

	`llayout:Vector.<Object>` — an array of node label layout objects

Wed Oct 7 2015, 04:43 PM +02:00

yFiles FLEX Client Layout Extension 1.5 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
DefaultLayoutGraph	Properties \| Methods \| Constants

Package	com.yworks.yfiles.layout
Class	public class DefaultLayoutGraph
Inheritance	DefaultLayoutGraph LayoutGraph Graph YObject Object