Class TestingCompoundLayoutIterationEventArgs<TVertex, TEdge, TVertexInfo, TEdgeInfo>

Information on a compound layout algorithm iteration.

Inheritance
System.Object
System.EventArgs
LayoutIterationEventArgs<TVertex, TEdge>
CompoundLayoutIterationEventArgs<TVertex, TEdge>
TestingCompoundLayoutIterationEventArgs<TVertex, TEdge, TVertexInfo, TEdgeInfo>
Implements
ILayoutInfoIterationEventArgs<TVertex, TEdge, TVertexInfo, TEdgeInfo>
Inherited Members
System.EventArgs.Empty
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: GraphShape.Algorithms.Layout
Assembly: GraphShape.dll
Syntax
public class TestingCompoundLayoutIterationEventArgs<TVertex, TEdge, TVertexInfo, TEdgeInfo> : CompoundLayoutIterationEventArgs<TVertex, TEdge>, ICompoundLayoutIterationEventArgs<TVertex>, ILayoutInfoIterationEventArgs<TVertex, TEdge, TVertexInfo, TEdgeInfo>, ILayoutInfoIterationEventArgs<TVertex, TEdge>, ILayoutIterationEventArgs<TVertex> where TEdge : IEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.
TVertexInfo

Vertex information type.
TEdgeInfo

Edge information type.

Constructors

| Improve this Doc View Source

TestingCompoundLayoutIterationEventArgs(Int32, Double, String, IDictionary<TVertex, Point>, IDictionary<TVertex, Size>, IDictionary<TVertex, TVertexInfo>, Point)

Initializes a new instance of the TestingCompoundLayoutIterationEventArgs<TVertex, TEdge, TVertexInfo, TEdgeInfo> class.

Declaration
public TestingCompoundLayoutIterationEventArgs(int iteration, double statusInPercent, string message, IDictionary<TVertex, Point> verticesPositions, IDictionary<TVertex, Size> innerCanvasSizes, IDictionary<TVertex, TVertexInfo> verticesInfos, Point gravitationCenter)
Parameters
Type Name Description
System.Int32 iteration

Number of the current iteration.
System.Double statusInPercent

Status of the layout algorithm in percent.
System.String message

Message representing the status of the algorithm.
System.Collections.Generic.IDictionary<TVertex, Point> verticesPositions

Vertices positions associations.
System.Collections.Generic.IDictionary<TVertex, Size> innerCanvasSizes

Inner canvas vertices sizes associations.
System.Collections.Generic.IDictionary<TVertex, TVertexInfo> verticesInfos

Extra vertices information.
Point gravitationCenter

Gravitation center.
Exceptions
Type Condition
System.ArgumentNullException

message is null.
System.ArgumentNullException

innerCanvasSizes is null.
System.ArgumentNullException

verticesInfos is null.
System.ArgumentOutOfRangeException

iteration is negative.
System.ArgumentOutOfRangeException

statusInPercent is negative.

Properties

| Improve this Doc View Source

EdgesInfos

Extra edges information.

Declaration
public IDictionary<TEdge, TEdgeInfo> EdgesInfos { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<TEdge, TEdgeInfo>
| Improve this Doc View Source

GravitationCenter

Gravitation center position.

Declaration
public Point GravitationCenter { get; }
Property Value
Type Description
Point
| Improve this Doc View Source

VerticesInfos

Extra vertices information.

Declaration
public IDictionary<TVertex, TVertexInfo> VerticesInfos { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<TVertex, TVertexInfo>

Methods

| Improve this Doc View Source

GetVertexInfo(TVertex)

Returns the extra layout information of the vertex (or null).

Declaration
public override object GetVertexInfo(TVertex vertex)
Parameters
Type Name Description
TVertex vertex
Returns
Type Description
System.Object
Overrides
GraphShape.Algorithms.Layout.LayoutIterationEventArgs<TVertex, TEdge>.GetVertexInfo(TVertex)
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.

Implements

Extension Methods