Note
This is one of 199 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.
🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️
Graphviz DOT conversion of @thi.ng/rstream dataflow graph topologies.
STABLE - used in production
Search or submit any issues for this package
- @thi.ng/dgraph-dot - Customizable Graphviz DOT serialization for @thi.ng/dgraph
- @thi.ng/dot - Graphviz document abstraction & serialization to DOT format
yarn add @thi.ng/rstream-dotESM import:
import * as rsdot from "@thi.ng/rstream-dot";Browser ESM import:
<script type="module" src="https://esm.run/@thi.ng/rstream-dot"></script>For Node.js REPL:
const rsdot = await import("@thi.ng/rstream-dot");Package sizes (brotli'd, pre-treeshake): ESM: 803 bytes
Two projects in this repo's /examples directory are using this package:
| Screenshot | Description | Live demo | Source |
|---|---|---|---|
| Minimal rstream dataflow graph | Demo | Source | |
 |
Multi-layer vectorization & dithering of bitmap images | Demo | Source |
import { fromIterable, merge, trace } from "@thi.ng/rstream";
import { serialize } from "@thi.ng/rstream-dot";
// create dummy dataflow
const a = fromIterable([1, 2, 3]);
const b = fromIterable([10, 20, 30]);
a.map((x) => x * 10, { id: "x10" });
merge({ src: [a, b] }).subscribe(trace());
// now capture the topology by walking the graph from its root(s)
// and convert the result to GraphViz DOT format
console.log(serialize([a, b]));Resulting output:
digraph g {
rankdir=LR;
node[fontname="sans-serif",fontsize=10,style=filled,fontcolor=white];
edge[fontname="sans-serif",fontsize=10];
s0[label="iterable-0\n(Stream)", color="blue"];
s1[label="x10", color="black"];
s2[label="in-iterable-0", color="black"];
s3[label="streammerge-2\n(StreamMerge)", color="red"];
s4[label="sub-3", color="black"];
s5[label="iterable-1\n(Stream)", color="blue"];
s6[label="in-iterable-1", color="black"];
s3 -> s4;
s2 -> s3;
s0 -> s1[label="xform"];
s0 -> s2;
s6 -> s3;
s5 -> s6;
}Copy output to file graph.dot and then run:
dot -Tsvg -o graph.svg graph.dotThis will generate this diagram:
If this project contributes to an academic publication, please cite it as:
@misc{thing-rstream-dot,
title = "@thi.ng/rstream-dot",
author = "Karsten Schmidt",
note = "https://thi.ng/rstream-dot",
year = 2018
}© 2018 - 2024 Karsten Schmidt // Apache License 2.0