DotNetGraph - GitLite

KO | EN

gitlite — search

#llm #android #rust #linux #docker #nodejs #cli #kubernetes #vue #security #pytorch #ios #openai #open-source

DotNetGraph

(★ 114)

Create GraphViz DOT graph with .NET / C#

File Explorer

Download Latest Version (.zip)

- - dotnet.yml
- icon_128.png
- icon_64.png
- - DotNetGraph.csproj
  - DotNetGraph.nuspec
  - pack.sh
- - DotNetGraph.Tests.csproj
- DotNetGraph.sln
.gitignore
LICENSE.txt
README.md

# Installation Guide

1. Get the code

git clone https://github.com/vfrz/DotNetGraph

Downloads the entire project code from GitHub to your computer.

cd DotNetGraph

Moves into the project folder you just downloaded.

2. .NET

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
.NET SDK The SDK required for the dotnet command.

cd Sources/DotNetGraph.Tests

This project's files live in a subfolder, so move into it first.

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

✅ After dotnet run, check the message or address shown in the terminal.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DotNetGraph

![Logo](https://raw.githubusercontent.com/vfrz/DotNetGraph/master/Resources/icon_64.png)

Create **GraphViz DOT graph** with **dotnet** (compatible with **.NET Standard 2.0** and higher).

Current stable version: [![#](https://img.shields.io/nuget/v/DotNetGraph.svg)](https://www.nuget.org/packages/DotNetGraph/)

Latest version: [![#](https://img.shields.io/nuget/vpre/DotNetGraph.svg)](https://www.nuget.org/packages/DotNetGraph/absoluteLatest)

# Usage

## Create a graph (*DotGraph*)

```csharp
var graph = new DotGraph().WithIdentifier("MyGraph");

var directedGraph = new DotGraph().WithIdentifier("MyDirectedGraph").Directed();
```

## Create and add a node (*DotNode*)

```csharp
var myNode = new DotNode()
    .WithIdentifier("MyNode")
    .WithShape(DotNodeShape.Ellipse)
    .WithLabel("My node!")
    .WithFillColor(DotColor.Coral)
    .WithFontColor(DotColor.Black)
    .WithStyle(DotNodeStyle.Dotted)
    .WithWidth(0.5)
    .WithHeight(0.5)
    .WithPenWidth(1.5);

// Add the node to the graph
graph.Add(myNode);
```

## Create and add an edge (*DotEdge*)

```csharp
// Create an edge with identifiers
var myEdge = new DotEdge().From("Node1").To("Node2");

// Or with nodes and attributes
var myEdge = new DotEdge()
    .From(node1)
    .To(node2)
    .WithArrowHead(DotEdgeArrowType.Box)
    .WithArrowTail(DotEdgeArrowType.Diamond)
    .WithColor(DotColor.Red)
    .WithFontColor(DotColor.Black)
    .WithLabel("My edge!")
    .WithStyle(DotEdgeStyle.Dashed)
    .WithPenWidth(1.5);

// Add the edge to the graph
graph.Add(myEdge);
```

## Create a subgraph / cluster

```csharp
// Subgraph identifier need to start with "cluster" to be identified as a cluster
var mySubgraph = new DotSubgraph().WithIdentifier("cluster_0");

// Create a subgraph with attributes (only used for cluster)
var mySubgraph2 = new DotSubgraph()
    .WithIdentifier("cluster_1")
    .WithColor(DotColor.Red)
    .WithStyle(DotSubGraphStyle.Dashed)
    .WithLabel("My subgraph!");

// Add node, edge, subgraph
subGraph.Add(myNode);
subGraph.Add(myEdge);
subGraph.Add(mySubgraph2);

// Add subgraph to main graph
graph.Add(mySubgraph);
```

## Compile to DOT format

```csharp
await using var writer = new StringWriter();
var context = new CompilationContext(writer, new CompilationOptions());
await graph.CompileAsync(context);

var result = writer.GetStringBuilder().ToString();

// Save it to a file
File.WriteAllText("graph.dot", result);
```
<hr>

### Credits

Logo: https://www.flaticon.com/free-icon/flow-chart_4411911