Skip to content

Latest commit

 

History

History
122 lines (82 loc) · 3.25 KB

README.rdoc

File metadata and controls

122 lines (82 loc) · 3.25 KB
Raw

Node.js GraphViz Module ↑

Copyright © 2010 Gregoire Lejeune

DESCRIPTION ↑

Interface to the GraphViz graphing tool

TODO ↑

  • So many things!

CHANGELOG ↑

0.0.8 : ↑

  • Issue #10 : Update graphviz attributs

0.0.7 : ↑

  • Issue #6 : fixed some calls to “sys”

  • Issue #7 : Fixed so it can be installed on v0.8 (by Patrik Henningsson <github.com/pahen>)

0.0.6 : ↑

  • Tiny corrections

0.0.5 : ↑

  • graphviz.js: Don’t require the ‘sys’ module.

0.0.4 : ↑

  • Major correction in render : error callback now take three arguments : code, stdout, stderr

  • Major correction in parse : error callback now take three arguments : code, stdout, stderr

  • Major bugs corrections

  • Update Attributs class

  • parse now accept a file or a script

  • Update render (see tests/hello.js)

  • Add graph.from and node.to (see tests/compound.js)

0.0.3 : ↑

  • Add attributs to addNode and addEdge

  • Add parser (see tests/parse.js)

0.0.2 : ↑

  • Added the ability to render in-memory (without writing to the filesystem) (By Mathieu Ravaux)

  • Rewrite output method

0.0.1 : ↑

  • Initial version

SYNOPSIS ↑

A basic example

var util = require('util'),
  graphviz = require('graphviz');

// Create digraph G
var g = graphviz.digraph("G");

// Add node (ID: Hello)
var n1 = g.addNode( "Hello", {"color" : "blue"} );
n1.set( "style", "filled" );

// Add node (ID: World)
g.addNode( "World" );

// Add edge between the two nodes
var e = g.addEdge( n1, "World" );
e.set( "color", "red" );

// Print the dot script
console.log( g.to_dot() ); 

// Set GraphViz path (if not in your path)
g.setGraphVizPath( "/usr/local/bin" );
// Generate a PNG output
g.output( "png", "test01.png" );

INSTALLATION ↑

$ cd ~/.node_libraries
$ git clone git://github.com/glejeune/node-graphviz.git

Or :

$ npm install graphviz

You also need to install GraphViz

DOCUMENTATION ↑

Install node-jake and dox then run

jake doc && open documentation.html

AUTHORS ↑

LICENCES ↑

Copyright © 2010 Gregoire Lejeune <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.