@hpcc-js/wasm-graphviz 1.17.0 → 1.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -1
- package/dist/index.js +12 -2
- package/dist/index.js.map +4 -4
- package/package.json +5 -4
- package/src/graphviz.ts +25 -19
- package/types/graphviz.d.ts +3 -2
package/README.md
CHANGED
|
@@ -1,13 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Graphviz
|
|
3
|
+
description: WebAssembly wrapper for the Graphviz graph visualization library
|
|
4
|
+
outline: deep
|
|
5
|
+
---
|
|
6
|
+
|
|
1
7
|
# @hpcc-js/wasm-graphviz
|
|
2
8
|
|
|
3
9
|
This package provides a WebAssembly wrapper around the [Graphviz](https://www.graphviz.org/) library. This allows for the rendering of DOT language graphs directly within a browser or NodeJS type environment.
|
|
4
10
|
|
|
5
11
|
## Installation
|
|
6
12
|
|
|
7
|
-
|
|
13
|
+
::: code-group
|
|
14
|
+
```sh [npm]
|
|
8
15
|
npm install @hpcc-js/wasm-graphviz
|
|
9
16
|
```
|
|
10
17
|
|
|
18
|
+
```sh [yarn]
|
|
19
|
+
yarn add @hpcc-js/wasm-graphviz
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
```sh [pnpm]
|
|
23
|
+
pnpm add @hpcc-js/wasm-graphviz
|
|
24
|
+
```
|
|
25
|
+
:::
|
|
26
|
+
|
|
11
27
|
## Quick Start
|
|
12
28
|
|
|
13
29
|
```typescript
|
|
@@ -18,6 +34,8 @@ const svg = graphviz.dot(`digraph { a -> b; }`);
|
|
|
18
34
|
document.body.innerHTML = svg;
|
|
19
35
|
```
|
|
20
36
|
|
|
37
|
+
<!--@include: ../../docs/graphviz/src/graphviz/README.md-->
|
|
38
|
+
|
|
21
39
|
## Reference
|
|
22
40
|
|
|
23
41
|
* [API Documentation](https://hpcc-systems.github.io/hpcc-js-wasm/graphviz/src/graphviz/classes/Graphviz.html)
|