sp-svg-diagram 0.1.5 → 0.1.6

package/README.md

@@ -0,0 +1,23 @@
+SVG Diagram
+===========
+
+## Overview
+
+A library for rendering diagrams to SVG. This library does not provide any automatic layout for nodes and edges.
+
+## Documentation
+
+* [Documentation](https://cyberzhg.github.io/SVGDiagram/)
+    * [Installation](https://cyberzhg.github.io/SVGDiagram/install.html)
+    * [Basic Concepts](https://cyberzhg.github.io/SVGDiagram/concept.html)
+    * [Diagram Attributes](https://cyberzhg.github.io/SVGDiagram/diagram_attr.html)
+    * [Node Attributes](https://cyberzhg.github.io/SVGDiagram/node_attr.html)
+    * [Edge Attributes](https://cyberzhg.github.io/SVGDiagram/edge_attr.html)
+    * [Subgraph Attributes](https://cyberzhg.github.io/SVGDiagram/subgraph_attr.html)
+
+## Example
+
+![](https://raw.githubusercontent.com/CyberZHG/SVGDiagram/main/docs/images/example_pentagon.svg)
+![](https://raw.githubusercontent.com/CyberZHG/SVGDiagram/main/docs/images/example_pentagram.svg)
+![](https://raw.githubusercontent.com/CyberZHG/SVGDiagram/main/docs/images/example_sequential.svg)
+![](https://raw.githubusercontent.com/CyberZHG/SVGDiagram/main/docs/images/example_subgraph.svg)

package/index.js

@@ -3,7 +3,39 @@ import SVGDiagramWASMModule from './wasm/SVGDiagramWASM.js';
 import { writeFile } from 'fs/promises';
 
 const SVGDiagramWASM = await SVGDiagramWASMModule();
+
+/**
+ * This function is only for testing.
+ *
+ * @param {string} expected
+ * @param {string} actual
+ * @return {boolean} Whether the two SVG strings are equivalent.
+ */
 const _compareSVG = SVGDiagramWASM._compareSVG;
+/**
+ * Create an SVGNode.
+ *
+ * @param {string} nodeID - An unique node ID.
+ *
+ * @returns {SVGNode} An SVGNode instance.
+ */
+const createSVGNode = SVGDiagramWASM.createSVGNode;
+/**
+ * Create an SVGEdge.
+ *
+ * @param {string} edgeID - An unique edge ID.
+ *
+ * @returns {SVGEdge} An SVGEdge instance.
+ */
+const createSVGEdge = SVGDiagramWASM.createSVGEdge;
+/**
+ * Create an SVGGraph.
+ *
+ * @param {string} graphID - An unique graph ID.
+ *
+ * @returns {SVGGraph} An SVGGraph instance.
+ */
+const createSVGGraph = SVGDiagramWASM.createSVGGraph;
 const SVGDiagram = SVGDiagramWASM.SVGDiagram;
 const SVGNode = SVGDiagramWASM.SVGNode;
 const SVGEdge = SVGDiagramWASM.SVGEdge;
@@ -22,8 +54,38 @@ SVGEdge.ARROW_NONE = SVGDiagramWASM.ARROW_SHAPE_NONE;
 SVGEdge.ARROW_NORMAL = SVGDiagramWASM.ARROW_SHAPE_NORMAL;
 SVGEdge.ARROW_EMPTY = SVGDiagramWASM.ARROW_SHAPE_EMPTY;
 
+/**
+ * Set the arrow shape at the end point.
+ *
+ * @param {string} arrowShape - Arrow shape from SVGEdge.ARROW_*
+ */
+SVGEdge.prototype.setArrowHead = function (arrowShape = SVGEdge.ARROW_NORMAL) {
+    this._setArrowHead(arrowShape);
+};
+/**
+ * Set the arrow shape at the start point.
+ *
+ * @param {string} arrowShape - Arrow shape from SVGEdge.ARROW_*
+ */
+SVGEdge.prototype.setArrowTail = function (arrowShape = SVGEdge.ARROW_NORMAL) {
+    this._setArrowTail(arrowShape);
+};
+/**
+ * Generate SVG and save to a local file.
+ *
+ * @param {string} file_path - Output file path.
+ */
 SVGDiagram.prototype.toSVG = async function(file_path) {
     await writeFile(file_path, this.render());
 };
 
-export { _compareSVG, SVGDiagram, SVGNode, SVGEdge, SVGGraph };
+export {
+    _compareSVG,
+    createSVGNode,
+    createSVGEdge,
+    createSVGGraph,
+    SVGDiagram,
+    SVGNode,
+    SVGEdge,
+    SVGGraph,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sp-svg-diagram",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "type": "module",
   "main": "index.js",
   "files": [