DemaConsulting.Rendering.Abstractions 0.1.0-beta.4

Rendering

General-purpose diagram layout and rendering for .NET. Describe a diagram as a graph, lay it out with a pluggable algorithm, and render it to SVG, PNG, JPEG, or WEBP. The design is inspired by the Eclipse Layout Kernel (ELK): layout and rendering are configured through an open, extensible property system, and new algorithms, renderers, and options are added additively.

Packages

The library is split into focused packages so consumers take only what they need:

Package dependencies form an acyclic graph: Abstractions and Layout depend on the model; Svg and Skia depend on the model and Abstractions; the model depends on nothing.

Installation

dotnet add package DemaConsulting.Rendering.Layout
dotnet add package DemaConsulting.Rendering.Svg

Usage

using System.IO;
using DemaConsulting.Rendering;
using DemaConsulting.Rendering.Abstractions;
using DemaConsulting.Rendering.Layout;
using DemaConsulting.Rendering.Svg;

// Describe the diagram as a graph of sized boxes and directed edges.
var graph = new LayoutGraph();
var a = graph.AddNode("a", width: 80, height: 40);
var b = graph.AddNode("b", width: 80, height: 40);
graph.AddEdge("a-b", a, b);

// Lay it out, then render the placed tree to SVG.
var tree = new LayeredLayoutAlgorithm().Apply(graph, new LayoutOptions());
using var output = File.Create("diagram.svg");
new SvgRenderer().Render(tree, new RenderOptions(Themes.Light), output);

See the user guide for configuration options and extension points.

API Reference

Every package ships its full API reference as compact, AI-friendly Markdown in an api/ folder inside the NuGet package, generated from the XML documentation comments by ApiMark. Start at api/api.md (the index) and drill into the per-namespace and per-type pages for signatures, remarks, and usage examples.

Gallery

A rendering gallery showcases what the library can produce — every bundled layout algorithm, orthogonal edge routing, all three themes, and both the SVG and PNG output paths. Each image is generated by the gallery test project directly from the public API, so the gallery doubles as an end-to-end rendering smoke test. Regenerate it with ./gallery.ps1.

Extensibility

• New layout algorithms implement ILayoutAlgorithm and register under a new id.
• New output formats implement IRenderer with a distinct media type.
• New configuration options are declared as typed LayoutProperty<T> keys carried in an open property bag, so adding an option never changes an existing method signature.

Documentation

Generated documentation includes build notes, a user guide, a code quality report, requirements, requirement justifications, and a requirements-to-test trace matrix.

Contributing

Contributions are welcome. See CONTRIBUTING.md for development setup, coding standards, and the pull request process.

License

Copyright (c) DEMA Consulting. Licensed under the MIT License. See LICENSE for details.

By contributing to this project, you agree that your contributions will be licensed under the MIT License.