EclipseGraphviz makes it easier to integrate Graphviz into Eclipse applications.
Java
Switch branches/tags

README.md

EclipseGraphviz

This is the home for the EclipseGraphviz project, originally on SourceForge.

Build Status

EclipseGraphviz is an Eclipse plug-in that provides a Java API for Graphviz and an Image Viewer view that allows easily visualizing the graphical output of your .dot files as you save changes to them.

Installing EclipseGraphviz

Requirements

  • Java 8
  • Eclipse Luna or later
  • Graphviz

Install Eclipse

Method 1: Installation via Eclipse Marketplace (preferred)

If you have the Eclipse Marketplace client installed, that is the easiest way to install EclipseGraphviz. Just search for the "TextUML Toolkit" (EclipseGraphviz ships as part of it), and install it directly. You can install EclipseGraphviz and skip installing the TextUML Toolkit if you prefer (what is the TextUML Toolkit?).

Method 2: Installation via Update Manager

  • Open the Software Updates dialog (Help > Install New Software...), and enter the following JAR URL in the "Work with:" field (include jar: to the !/ at the end):
jar:http://repository-textuml.forge.cloudbees.com/snapshot/com/abstratt/eclipsegraphviz/com.abstratt.eclipsegraphviz.repository/2.2.201606/com.abstratt.eclipsegraphviz.repository-2.2.201606.zip!/
  • Select the EclipseGraphviz feature from the Modeling category.

  • Accept to restart Eclipse to make the changes effective.

Method 3: Installation from local archived repository

Some strict proxies may prevent applications (such as Eclipse) from downloading .zip files (such as the EclipseGraphviz repository). For example, if you consistently see the Eclipse Marketplace client (method 1) or Update Manager (method 2) failing with errors like these:

Communication with repository at jar:http://repository-textuml.forge.cloudbees.com/snapshot/com/abstratt/eclipsegraphviz/com.abstratt.eclipsegraphviz.repository/2.2.201606/com.abstratt.eclipsegraphviz.repository-2.2.201606.zip!/content.xml.xz failed.
root cause
Caused by: java.net.SocketTimeoutException: Read timed out

you can use this workaround:

  • Download the EclipseGraphviz repository archive from here
  • Open the Software Updates    dialog (Help > Install New Software...), hit the Add... button, then use the "Archive..." button to find the zip file you just downloaded
  • Select the EclipseGraphviz feature from the Modeling category.
  • Accept to restart Eclipse to make the changes effective.

   

Download and install Graphviz

If you don't have it yet, download and install Graphviz for your platform.

Note to Windows users: you might need to download and install the "Microsoft Visual C++ 2005 Redistributable Package (x86)" as mentioned in the Graphviz for Windows download page. From user reports, it seems XP usually requires that package to be installed, while Vista does not.

Configure EclipseGraphviz

Once Graphviz is installed, you may need to tell EclipseGraphviz where to find it. Open the Graphviz preference page in Eclipse and enter the location for the dot executable.

Using EclipseGraphviz

How are diagrams rendered?

EclipseGraphviz provides an "Image Viewer" view that will show a rendered diagram whenever a .dot file is selected or an editor loaded with a .dot file is currently selected (saving triggers updates). To open the Image Viewer, go Window > Show view > Other... > EclipseGraphviz > Image viewer.

Screenshots

Preferences page

Preferences Page

Allows configuring how to find Graphviz and global options for the dot tool.

Browsing files

Browsing dot files

The Image Viewer view automatically renders diagrams as you select .dot files in Eclipse.

Editing files

Editing dot files

The Image Viewer view automatically renders diagrams as you edit .dot files in an Eclipse editor (updating as you save your changes).