Adapter class CopiedLayoutIGraph bridges the gap between the IGraph-based yFiles FLEX graph model and the graph model that is used with the yFiles Basic and yFiles Layout library components. It implements interfaces GraphInterface and GraphLayout which together provide the functionality that is needed for the yFiles automatic layout and network analysis algorithms.

CopiedLayoutIGraph is also responsible for providing access to any additional information associated with an IGraph and its elements in a way that is standard with the graph model that the yFiles algorithms use. Specifically, this means that any IMapper instances which are registered with the IGraph's mapper registry are appropriately wrapped using data providers. Among other things, this also covers any grouping-related data that is present with grouped graphs.

The following convenience method in CopiedLayoutIGraph can be used to invoke a layout algorithm:

static function applyLayout(graph:IGraph, layouter:Layouter):void

In fact, invoking a layout algorithm can be as simple as this one-liner:

// 'graph' is of type com.yworks.graph.model.IGraph.

CopiedLayoutIGraph.applyLayout(graph, new IncrementalHierarchicLayouter());

Using the services of class CopiedLayoutIGraph enables proper invocation of any implementations of interface Layouter via the doLayout() method. This also includes all yFiles major layout algorithms, which are descendants of abstract class CanonicMultiStageLayouter.

Basically, the following code gets executed when using the aforementioned convenience method to invoke a layout algorithm:

function invokeLayouter(layouter:Layouter, graph:IGraph):void {
  var adapter:LayoutGraphAdapter = new LayoutGraphAdapter(graph);
  var copy:CopiedLayoutIGraph = new CopiedLayoutIGraph(adapter);
  layouter.doLayout(copy);
  copy.commitLayoutToOriginalGraph();
}

Connecting graph models especially in the context of calling analysis algorithms from the yFiles Basic library component is conveniently supported by adapter class YGraphAdapter. Similar to class CopiedLayoutIGraph it creates a copy of the IGraph given at creation time. The copy is of type Graph and can be readily used in conjunction with any algorithms from the com.yworks.yfiles.base package. It is accessible via the yGraph property of the adapter class.

// 'graph' is of type com.yworks.graph.model.IGraph.

var graphAdapter:YGraphAdapter = new YGraphAdapter(graph);
// Class GraphChecker is from the com.yworks.yfiles.base namespace.
var isConnected:Boolean = GraphChecker.isConnected(graphAdapter.yGraph);

Mappings between the graph elements from the IGraph and the copied graph elements in the Graph are available via convenience methods.

YGraphAdapter provides a number of methods that facilitate converting IMapper or Iterator instances both to and from appropriate data type instances which are typically used as parameter types with graph analysis algorithms. Note that conversion of IMapper instances is done by wrapping them.

createDataProvider(mapper:IMapper):DataProvider

createDataMap(mapper:IMapper):DataMap
createNodeMap(mapper:IMapper):NodeMap
createEdgeMap(mapper:IMapper):EdgeMap

createNodeList(nodeIt:Iterator):NodeList
createEdgeList(edgeIt:Iterator):EdgeList

createNodeIterator(nl:NodeList):Iterator
createEdgeIterator(el:EdgeList):Iterator

Example 3.4, “Converting data type instances when invoking a graph analysis algorithm” presents an invocation of an analysis algorithm where data type instances are converted to provide the appropriate input type and to get the algorithm's results from the output type.

// 'graph' is of type com.yworks.graph.model.IGraph.
// 'someNodes' is of type com.yworks.support.Iterator.

var graphAdapter:YGraphAdapter = new YGraphAdapter(graph);

// Class GraphConnectivity is from the com.yworks.yfiles.algo package.
var inputNL:NodeList = graphAdapter.createNodeList(someNodes);
var outputNL:NodeList =
  GraphConnectivity.getSuccessors(graphAdapter.yGraph, inputNL, 2);
var successors:Iterator = graphAdapter.createNodeIterator(outputNL);