viz.js - npm Package Compare versions

Comparing version 1.8.0 to 1.8.1-pre.4

package.json

 {
   "name": "viz.js",
-  "version": "1.8.0",
+  "version": "1.8.1-pre.4",
   "description": "A hack to put Graphviz on the web.",
@@ -16,3 +16,4 @@ "main": "viz.js",
     "viz.js",
-    "viz-lite.js"
+    "viz-lite.js",
+    "index.d.ts"
   ],
@@ -29,3 +30,7 @@ "browser": {
   },
-  "homepage": "https://github.com/mdaines/viz.js"
+  "homepage": "https://github.com/mdaines/viz.js",
+  "devDependencies": {
+    "minimist": "^1.2.0",
+    "selenium-webdriver": "^2.45.1"
+  }
 }

README.md

 # Viz.js
 
-This project is a Makefile for building [Graphviz](http://www.graphviz.org) with [Emscripten](http://kripken.github.io/emscripten-site/) and a simple wrapper for using it in the browser.
+[![Build Status](https://travis-ci.org/mdaines/viz.js.svg?branch=master)](https://travis-ci.org/mdaines/viz.js)
 
+This project builds [Graphviz](http://www.graphviz.org) with [Emscripten](http://kripken.github.io/emscripten-site/) and provides a simple wrapper for using it in the browser.
+
 ## Become a Patron
 
-Help make Viz.js better by [supporting me on Patreon](https://patreon.com/mdaines). Thank you!
+[Support Viz.js development](https://patreon.com/mdaines) for as little as $1 a month. ❤️
 
@@ -19,82 +21,20 @@ ## Getting Viz.js
 
-Or download the `viz.js` "binary" from the [releases page](https://github.com/mdaines/viz.js/releases).
+Or get it from the [releases page](https://github.com/mdaines/viz.js/releases).
 
-## "Lite" Version
+### "Lite" Version
 
-A smaller version of Viz.js can be downloaded from the [releases page](https://github.com/mdaines/viz.js/releases) and is available in the Bower package. `viz-lite.js` omits Expat and the NEATO layout plugin.
+A smaller version of Viz.js is available on the [releases page](https://github.com/mdaines/viz.js/releases) and the Bower package. `viz-lite.js` omits Expat and the NEATO layout plugin.
 
-## API
+## Usage
 
-### Viz(src, options={ format="svg", engine="dot", scale, images=[{ path, width, height }], totalMemory=16777216 })
+Rendering a graph as SVG:
 
-- `src` is a string representing the graph to render in the [DOT language](http://www.graphviz.org/content/dot-language).
-- `options`
-  - `format` sets the output format, and may be one of `"svg"`, `"xdot"`, `"plain"`, `"ps"`, `"json"`, or `"png-image-element"`.
-  - `engine` sets the Graphviz engine to use, and may be one of `"circo"`, `"dot"`, `"neato"`, `"osage"`, or `"twopi"`.
-  - `scale` sets the scale factor for the `"png-image-element"` format. If this is not specified, `window.devicePixelRatio` will be used if available, and `1` if not.
-  - `images` specifies image dimensions to use when rendering nodes with `image` attributes. This is an array of objects, `{ href, width, height }`. `href` may be a filename (`"example.png"`), a relative or absolute path (`"/images/example.png"`), or a URL (`"http://example.com/image.png"`). Dimensions may be specified with units: in, px, pc, pt, cm, or mm. If no units are given or dimensions are given as numbers, points (pt) are used. Graphviz does not actually load image data when this option is used — images are referenced with the dimensions given, eg, in SVG by an `<image>` element with `width` and `height` attributes.
-  - `totalMemory` sets the total memory available for the Emscripten module instance. This should be a power of 2. The default of 16MB should be sufficient for most cases — only consider using a larger number if you run into the error "Cannot enlarge memory arrays".
+    var svg = Viz("digraph { a -> b; }");
 
-Parses `src` and renders a graph according to the `options` given. Output is a string, except when using the "png-image-element" format, when it is an instance of HTMLImageElement.
+The input to `Viz()` is a graph in the [DOT language](http://www.graphviz.org/content/dot-language). The output `svg` is an SVG XML string.
 
-For example:
+For more information, see the [API documentation](https://github.com/mdaines/viz.js/wiki/API).
 
-    result = Viz("digraph { a -> b; }");
-    result = Viz("digraph { a -> b; }", { format: "png-image-element", scale: 2 });
-    result = Viz("graph { n0 -- n1 -- n2 -- n3 -- n0; }", { engine: "neato" });
-    result = Viz("digraph { x -> y -> z; }", { format: "plain" });
-    result = Viz("digraph { a[image=\"test.png\"]; }", { images: [ { path: "test.png", width: "400px", height: "300px" } ] });
+## Building Viz.js
 
-If Graphviz encounters an error, Viz will throw an `Error` object with the error message.
-
-### Viz.svgXmlToPngImageElement(svgXml[, scale[, callback]])
-
-- `svgXml` is an SVG XML string, as may be obtained from the `Viz` function using the `"svg"` format option.
-- `scale` sets the scale factor for the output. If this is not specified, `window.devicePixelRatio` will be used if available, and `1` if not.
-- `callback` is an optional Node-style callback. If specified, it is given two arguments, `(err, image)`. If not specified, `Viz.svgXmlToPngImageElement` returns an instance of HTMLImageElement.
-
-Converts `svgXml` to a PNG HTMLImageElement. If `callback` is specfied, `image` is loaded by the time the callback is invoked.
-
-### Viz.svgXmlToPngBase64(svgXml, scale, callback)
-
-- `svgXml` is an SVG XML string, as may be obtained from the `Viz` function using the `"svg"` format option.
-- `scale` sets the scale factor for the output. If this is given as `undefined`, `window.devicePixelRatio` will be used if available, and `1` if not.
-- `callback` is a Node-style callback. It is given two arguments, `(err, data)`.
-
-Converts `svgXml` to a PNG represented as a Base64 string. This function requires a callback, unlike `svgXmlToPngImageElement`.
-
-## Supported Graphviz features
-
-These engines are supported:
-
-- circo
-- dot
-- fdp
-- neato
-- osage
-- twopi
-
-These formats are supported:
-
-- svg
-- xdot
-- plain
-- ps
-- json
-
-## PNG output
-
-Viz.js provides the `"png-image-element"` format in addition to the regular Graphviz formats. This returns an `HTMLImageElement` which can be inserted into the document.
-
-    image = Viz("digraph g { a -> b; }", { format: "png-image-element" });
-    document.body.appendChild(image);
-
-However, this won't work in a Web Worker context. In that case, ask for the `"svg"` format in the worker and convert using the accessory function `Viz.svgXmlToPngImageElement` in the window context. See tests/png.js for an example.
-
-### Internet Explorer support
-
-Internet Explorer 10 and 11 require [Fabric.js](http://fabricjs.com) as an optional dependency for PNG output. Viz.js will look for a `fabric` object as a member of the global object with a `loadSVGFromString()` function and use that if present.
-
-## Build
-
 To build from source, you will need to [install the Emscripten SDK](http://kripken.github.io/emscripten-site/docs/getting_started/index.html).
@@ -101,0 +41,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of package files

6

increased by20%

Worsened metrics

Total package byte prevSize

3566835

decreased by-12.95%

Dev dependency count

2

increased byInfinity%

Lines of code

14095

decreased by-12.56%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

44

decreased by-57.69%

No dependency changes