Adapter class CopiedLayoutIGraph bridges the gap between the IGraph-based yFiles for Silverlight Viewer graph model and the graph model that is used with the yFiles Basic and yFiles Layout library components. It implements interfaces IGraphInterface and IGraphLayout 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 void ApplyLayout(IGraph graph, ILayouter layouter)

These methods in other classes basically delegate to the aforementioned in CopiedLayoutIGraph:

void ApplyLayout(ILayouter layouter)

void DoLayout(IGraph graph)

Invoking a layout algorithm can be as simple as this one-liner that implicitly uses the services of class CopiedLayoutIGraph:

// 'graph' is of type yWorks.yFiles.UI.Model.IGraph.

graph.ApplyLayout(new IncrementalHierarchicLayouter());

Using the services of class CopiedLayoutIGraph enables proper invocation of any implementations of interface ILayouter 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 either of the aforementioned convenience methods to invoke a layout algorithm:

void InvokeLayouter(ILayouter layouter, IGraph graph) {
  CopiedLayoutIGraph copy = new CopiedLayoutIGraph(graph);
  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 yWorks.yFiles.Algorithms namespace. It is accessible via the YGraph property of the adapter class.

// 'graph' is of type yWorks.yFiles.UI.Model.IGraph.

YGraphAdapter graphAdapter = new YGraphAdapter(graph);
// Class GraphChecker is from the yWorks.yFiles.Algorithms namespace.
bool isConnected = 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<K, V> or IEnumerable<T> 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<K, V> instances is done by wrapping them.

DataProvider CreateDataProvider<K, V>(IMapper<K, V> mapper) where K : class

DataMap CreateDataMap<K, V>(IMapper<K, V> mapper) where K : class
NodeMap CreateNodeMap<V>(IMapper<INode, V> mapper)
EdgeMap CreateEdgeMap<V>(IMapper<IEdge, V> mapper)

NodeList CreateNodeList(IEnumerable<INode> nl)
EdgeList CreateEdgeList(IEnumerable<IEdge> el)

IEnumerable<INode> CreateNodeEnumerable(NodeList nl)
IEnumerable<IEdge> CreateEdgeEnumerable(EdgeList el)

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 yWorks.yFiles.UI.Model.IGraph.
// 'someNodes' is of type System.Collections.Generic.IEnumerable<INode>.

YGraphAdapter graphAdapter = new YGraphAdapter(graph);

// Class GraphConnectivity is from the yWorks.yFiles.Algorithms namespace.
NodeList inputNL = graphAdapter.CreateNodeList(someNodes);
NodeList outputNL = 
  GraphConnectivity.GetSuccessors(graphAdapter.YGraph, inputNL, 2);
IEnumerable<INode> successors = graphAdapter.CreateNodeEnumerable(outputNL);