Class GraphvizExtensions

Helper extensions to render graphs to graphviz.

Inheritance

System.Object

GraphvizExtensions

Inherited Members

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: QuikGraph.Graphviz

Assembly: QuikGraph.Graphviz.dll

Syntax

public static class GraphvizExtensions

Fields

| Improve this Doc View Source

DotToSvgApiEndpoint

Dot to Svg REST API endpoint.

Declaration

public const string DotToSvgApiEndpoint = "https://rise4fun.com/rest/ask/Agl/"

Field Value

Type	Description
System.String

Methods

| Improve this Doc View Source

ToGraphviz<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

Renders a graph to the Graphviz DOT format.

Declaration

public static string ToGraphviz<TVertex, TEdge>(this IEdgeListGraph<TVertex, TEdge> graph)
    where TEdge : IEdge<TVertex>

Parameters

Type	Name	Description
IEdgeListGraph<TVertex, TEdge>	graph	Graph to convert.

Returns

Type	Description
System.String	Graph serialized in DOT format.

Type Parameters

Name	Description
TVertex	Vertex type.
TEdge	Edge type.

Exceptions

Type	Condition
System.ArgumentNullException	`graph` is null.

| Improve this Doc View Source

ToGraphviz<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, Action<GraphvizAlgorithm<TVertex, TEdge>>)

Renders a graph to the Graphviz DOT format.

Declaration

public static string ToGraphviz<TVertex, TEdge>(this IEdgeListGraph<TVertex, TEdge> graph, Action<GraphvizAlgorithm<TVertex, TEdge>> initAlgorithm)
    where TEdge : IEdge<TVertex>

Parameters

Type	Name	Description
IEdgeListGraph<TVertex, TEdge>	graph	Graph to convert.
System.Action<GraphvizAlgorithm<TVertex, TEdge>>	initAlgorithm	Delegate that initializes the DOT generation algorithm.

Returns

Type	Description
System.String	Graph serialized in DOT format.

Type Parameters

Name	Description
TVertex	Vertex type.
TEdge	Edge type.

Exceptions

Type	Condition
System.ArgumentNullException	`graph` is null.
System.ArgumentNullException	`initAlgorithm` is null.

| Improve this Doc View Source

ToSvg(String)

Performs a layout from DOT to a SVG (Scalable Vector Graphics) file by calling Agl through the https://rise4fun.com/ REST services.

Declaration

[Obsolete("Conversion is using an external web service that is no longer available.")]
public static string ToSvg(string dot)

Parameters

Type	Name	Description
System.String	dot	The dot graph

Returns

Type	Description
System.String	The svg graph.

Exceptions

Type	Condition
System.ArgumentNullException	`dot` is null.

| Improve this Doc View Source

ToSvg<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

Performs a layout of graph from DOT format to an SVG (Scalable Vector Graphics) file by calling Agl through the https://rise4fun.com/ REST services.

Declaration

[Obsolete("Conversion is using an external web service that is no longer available.")]
public static string ToSvg<TVertex, TEdge>(this IEdgeListGraph<TVertex, TEdge> graph)
    where TEdge : IEdge<TVertex>

Parameters

Type	Name	Description
IEdgeListGraph<TVertex, TEdge>	graph	Graph to convert.

Returns

Type	Description
System.String	The svg graph.

Type Parameters

Name	Description
TVertex	Vertex type.
TEdge	Edge type.

Exceptions

Type	Condition
System.ArgumentNullException	`graph` is null.

| Improve this Doc View Source

ToSvg<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, Action<GraphvizAlgorithm<TVertex, TEdge>>)

Performs a layout of graph from DOT format to an SVG (Scalable Vector Graphics) file by calling Agl through the https://rise4fun.com/ REST services.

Declaration

[Obsolete("Conversion is using an external web service that is no longer available.")]
public static string ToSvg<TVertex, TEdge>(this IEdgeListGraph<TVertex, TEdge> graph, Action<GraphvizAlgorithm<TVertex, TEdge>> initAlgorithm)
    where TEdge : IEdge<TVertex>

Parameters

Type	Name	Description
IEdgeListGraph<TVertex, TEdge>	graph	Graph to convert.
System.Action<GraphvizAlgorithm<TVertex, TEdge>>	initAlgorithm	Delegate that initializes the DOT generation algorithm.

Returns

Type	Description
System.String	The svg graph.

Type Parameters

Name	Description
TVertex	Vertex type.
TEdge	Edge type.

Exceptions

Type	Condition
System.ArgumentNullException	`graph` is null.
System.ArgumentNullException	`initAlgorithm` is null.