Class LayoutIterationEventArgs<TVertex, TEdge>

Information on a layout algorithm iteration.

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

Vertex type.
TEdge

Edge type.

Constructors

| Improve this Doc View Source

LayoutIterationEventArgs()

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

Declaration
public LayoutIterationEventArgs()
| Improve this Doc View Source

LayoutIterationEventArgs(Int32, Double)

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

Declaration
public LayoutIterationEventArgs(int iteration, double statusInPercent)
Parameters
Type Name Description
System.Int32 iteration

Number of the current iteration.
System.Double statusInPercent

Status of the layout algorithm in percent.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

iteration is negative.
System.ArgumentOutOfRangeException

statusInPercent is negative.
| Improve this Doc View Source

LayoutIterationEventArgs(Int32, Double, IDictionary<TVertex, Point>)

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

Declaration
public LayoutIterationEventArgs(int iteration, double statusInPercent, IDictionary<TVertex, Point> verticesPositions)
Parameters
Type Name Description
System.Int32 iteration

Number of the current iteration.
System.Double statusInPercent

Status of the layout algorithm in percent.
System.Collections.Generic.IDictionary<TVertex, Point> verticesPositions

Vertices positions associations.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

iteration is negative.
System.ArgumentOutOfRangeException

statusInPercent is negative.
| Improve this Doc View Source

LayoutIterationEventArgs(Int32, Double, String)

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

Declaration
public LayoutIterationEventArgs(int iteration, double statusInPercent, string message)
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.
Exceptions
Type Condition
System.ArgumentNullException

message is null.
System.ArgumentOutOfRangeException

iteration is negative.
System.ArgumentOutOfRangeException

statusInPercent is negative.
| Improve this Doc View Source

LayoutIterationEventArgs(Int32, Double, String, IDictionary<TVertex, Point>)

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

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

message is null.
System.ArgumentOutOfRangeException

iteration is negative.
System.ArgumentOutOfRangeException

statusInPercent is negative.

Properties

| Improve this Doc View Source

Abort

If the user sets this value to true, the algorithm aborts as soon as possible.

Declaration
public bool Abort { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Iteration

Number of the current iteration.

Declaration
public int Iteration { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Message

Message representing the status of the algorithm.

Declaration
public string Message { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

StatusInPercent

Represents the status of the layout algorithm in percent.

Declaration
public double StatusInPercent { get; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

VerticesPositions

Vertices positions associations.

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

Methods

| Improve this Doc View Source

GetEdgeInfo(TEdge)

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

Declaration
public virtual object GetEdgeInfo(TEdge edge)
Parameters
Type Name Description
TEdge edge
Returns
Type Description
System.Object
Exceptions
Type Condition
System.ArgumentNullException

edge is null.
| Improve this Doc View Source

GetVertexInfo(TVertex)

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

Declaration
public virtual object GetVertexInfo(TVertex vertex)
Parameters
Type Name Description
TVertex vertex
Returns
Type Description
System.Object
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.

Implements

Extension Methods