C# Class Smrf.NodeXL.Layouts.SortableLayoutBase

Base class for layouts that support vertex sorting and selective layout.
This is the base class for several layouts that support vertex sorting and the layout of a subset of the graph's vertices. The derived class must implement the LayOutGraphCoreSorted abstract method.

If you want the vertices to be placed in a certain order, set the property to an object that will sort them.

If the graph has a metadata key of , only the vertices specified in the value's IVertex collection are laid out and all other vertices are completely ignored.

Inheritance: LayoutBase
Show file Open project: 2014-sed-team3/term-project

Protected Properties

Property Type Description
m_oVertexSorter IVertexSorter

Public Methods

Method Description
AssertValid ( ) : void
SortableLayoutBase ( ) : System

Initializes a new instance of the SortableLayoutBase class.
UseMetadataVertexSorter ( IGraph graph ) : void

Protected Methods

Method Description
LayOutGraphCore ( IGraph graph, ICollection verticesToLayOut, LayoutContext layoutContext, BackgroundWorker backgroundWorker ) : System.Boolean
LayOutGraphCoreSorted ( IGraph graph, ICollection verticesToLayOut, LayoutContext layoutContext, BackgroundWorker backgroundWorker ) : System.Boolean

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

LayOutGraphCore() protected method

protected LayOutGraphCore ( IGraph graph, ICollection verticesToLayOut, LayoutContext layoutContext, BackgroundWorker backgroundWorker ) : System.Boolean
graph IGraph
verticesToLayOut ICollection
layoutContext LayoutContext
backgroundWorker System.ComponentModel.BackgroundWorker
return System.Boolean

LayOutGraphCoreSorted() protected abstract method

protected abstract LayOutGraphCoreSorted ( IGraph graph, ICollection verticesToLayOut, LayoutContext layoutContext, BackgroundWorker backgroundWorker ) : System.Boolean
graph IGraph
verticesToLayOut ICollection
layoutContext LayoutContext
backgroundWorker System.ComponentModel.BackgroundWorker
return System.Boolean

SortableLayoutBase() public method

Initializes a new instance of the SortableLayoutBase class.
public SortableLayoutBase ( ) : System
return System

UseMetadataVertexSorter() public method

public UseMetadataVertexSorter ( IGraph graph ) : void
graph IGraph
return void

Property Details

m_oVertexSorter protected property

protected IVertexSorter m_oVertexSorter
return IVertexSorter