Merge pull request #49 from GordonSmith/SFDP

feat(sfdp):  Add SFDP support

Author: GordonSmith

README.md

@@ -140,6 +140,7 @@ _layoutEngine_ supports the following options:
 * circo
 * dot (default)
 * fdp
+* sfdp
 * neato
 * osage
 * patchwork
@@ -191,7 +192,11 @@ Convenience function that performs **dot** layout, is equivalent to `layout(dotS
 
 <a name="fdp" href="#fdp">#</a> **fdp**(_dotSource_[, _outputFormat_][, _ext_]) · [<>](https://github.com/hpcc-systems/hpcc-js-wasm/blob/trunk/src/graphviz.ts "Source")
 
-Convenience function that performs **circo** layout, is equivalent to `layout(dotSource, outputFormat, "fdp");`.
+Convenience function that performs **fdp** layout, is equivalent to `layout(dotSource, outputFormat, "fdp");`.
+
+<a name="sfdp" href="#sfdp">#</a> **sfdp**(_dotSource_[, _outputFormat_][, _ext_]) · [<>](https://github.com/hpcc-systems/hpcc-js-wasm/blob/trunk/src/graphviz.ts "Source")
+
+Convenience function that performs **sfdp** layout, is equivalent to `layout(dotSource, outputFormat, "sfdp");`.
 
 <a name="neato" href="#neato">#</a> **neato**(_dotSource_[, _outputFormat_][, _ext_]) · [<>](https://github.com/hpcc-systems/hpcc-js-wasm/blob/trunk/src/graphviz.ts "Source")
 

src/__tests__/graphviz.ts

@@ -98,6 +98,14 @@ describe("graphviz", function () {
             expect(true).to.be.false;
         });
     });
+    it("sfdp", function () {
+        return graphviz.sfdp(dot, "svg").then(svg => {
+            expect(svg).to.be.a("string");
+            expect(svg).to.not.be.empty;
+        }).catch(e => {
+            expect(true).to.be.false;
+        });
+    });
     it("neato", function () {
         return graphviz.neato(dot, "svg").then(svg => {
             expect(svg).to.be.a("string");
@@ -160,6 +168,13 @@ describe("graphvizSync", function () {
         expect(svg).to.be.a("string");
         expect(svg).to.not.be.empty;
     });
+    it("sfdp", function () {
+        const svg = gvSync.sfdp(dot, "svg");
+        expect(svg).to.be.a("string");
+        expect(svg).to.not.be.empty;
+        const svg2 = gvSync.fdp(dot, "svg");
+        expect(svg).to.not.equal(svg2);
+    });
     it("neato", function () {
         const svg = gvSync.neato(dot, "svg");
         expect(svg).to.be.a("string");

src/graphviz.ts

@@ -3,7 +3,7 @@ import * as graphvizlib from "../build/graphviz/graphvizlib/graphvizlib";
 import { loadWasm } from "./util";
 
 type Format = "svg" | "dot" | "json" | "dot_json" | "xdot_json" | "plain" | "plain-ext";
-type Engine = "circo" | "dot" | "fdp" | "neato" | "osage" | "patchwork" | "twopi";
+type Engine = "circo" | "dot" | "fdp" | "sfdp" | "neato" | "osage" | "patchwork" | "twopi";
 
 interface Image {
     path: string;
@@ -69,6 +69,9 @@ export const graphviz = {
     fdp(dotSource: string, outputFormat: Format = "svg", ext?: Ext): Promise<string> {
         return this.layout(dotSource, outputFormat, "fdp", ext);
     },
+    sfdp(dotSource: string, outputFormat: Format = "svg", ext?: Ext): Promise<string> {
+        return this.layout(dotSource, outputFormat, "sfdp", ext);
+    },
     neato(dotSource: string, outputFormat: Format = "svg", ext?: Ext): Promise<string> {
         return this.layout(dotSource, outputFormat, "neato", ext);
     },
@@ -112,6 +115,10 @@ export class GraphvizSync {
         return this.layout(dotSource, outputFormat, "fdp", ext);
     }
 
+    sfdp(dotSource: string, outputFormat: Format = "svg", ext?: Ext): string {
+        return this.layout(dotSource, outputFormat, "sfdp", ext);
+    }
+
     neato(dotSource: string, outputFormat: Format = "svg", ext?: Ext): string {
         return this.layout(dotSource, outputFormat, "neato", ext);
     }