C# Class Smrf.NodeXL.Layouts.GridLayout

Lays out a graph by placing the vertices on a grid.
This layout places a graph's vertices on a simple grid.

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.

If a vertex has a metadata key of with a value of true, it is included in layout calculations but its own location is left unmodified.

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

Inheritance: SortableLayoutBase
Datei anzeigen Open project: 2014-sed-team3/term-project Class Usage Examples

Public Methods

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

Initializes a new instance of the GridLayout class.

Protected Methods

Method Description
GetRowsAndColumns ( ICollection oVerticesToLayOut, LayoutContext oLayoutContext, Int32 &iRows, Int32 &iColumns ) : void
LayOutGraphCoreSorted ( IGraph graph, ICollection verticesToLayOut, LayoutContext layoutContext, BackgroundWorker backgroundWorker ) : System.Boolean
RowsAndColumnsAreSufficient ( Int32 iRows, Int32 iColumns, Int32 iVertices ) : System.Boolean

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

GetRowsAndColumns() protected method

protected GetRowsAndColumns ( ICollection oVerticesToLayOut, LayoutContext oLayoutContext, Int32 &iRows, Int32 &iColumns ) : void
oVerticesToLayOut ICollection
oLayoutContext LayoutContext
iRows System.Int32
iColumns System.Int32
return void

GridLayout() public method

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

LayOutGraphCoreSorted() protected method

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

RowsAndColumnsAreSufficient() protected method

protected RowsAndColumnsAreSufficient ( Int32 iRows, Int32 iColumns, Int32 iVertices ) : System.Boolean
iRows System.Int32
iColumns System.Int32
iVertices System.Int32
return System.Boolean