Class CompoundLayoutIterationEventArgs<TVertex, TEdge>

Information on a compound layout algorithm iteration.

Inheritance
System.Object
System.EventArgs
LayoutIterationEventArgs<TVertex, TEdge>
CompoundLayoutIterationEventArgs<TVertex, TEdge>
TestingCompoundLayoutIterationEventArgs<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 CompoundLayoutIterationEventArgs<TVertex, TEdge> : LayoutIterationEventArgs<TVertex, TEdge>, ILayoutInfoIterationEventArgs<TVertex, TEdge>, ICompoundLayoutIterationEventArgs<TVertex>, ILayoutIterationEventArgs<TVertex> where TEdge : IEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.

Constructors

| Improve this Doc View Source

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

Initializes a new instance of the CompoundLayoutIterationEventArgs<TVertex, TEdge> class.

Declaration
public CompoundLayoutIterationEventArgs(int iteration, double statusInPercent, string message, IDictionary<TVertex, Point> verticesPositions, IDictionary<TVertex, Size> innerCanvasSizes)
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.
Exceptions
Type Condition
System.ArgumentNullException

message is null.
System.ArgumentNullException

innerCanvasSizes is null.
System.ArgumentOutOfRangeException

iteration is negative.
System.ArgumentOutOfRangeException

statusInPercent is negative.

Properties

| Improve this Doc View Source

InnerCanvasSizes

Inner canvas vertices sizes.

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

Implements

Extension Methods