Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Node.js interface to the GraphViz graphing tool

tag: 0.0.3

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 tests
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Jakefile.js
Octocat-spinner-32 LICENCE.txt Initial commit September 03, 2010
Octocat-spinner-32 README.rdoc
Octocat-spinner-32 package.json
README.rdoc

Node.js GraphViz Module

Copyright (C) 2010 Gregoire Lejeune

DESCRIPTION

Interface to the GraphViz graphing tool

TODO

  • So many things!

CHANGELOG

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 sys = require('sys'),
  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 node-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 <gregoire.lejeune@free.fr>

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.

Something went wrong with that request. Please try again.