ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

# Graphvizer

ST3

Preview Graphviz in real time with Sublime Text 3

## Installs

• Total 714
• Win 320
• OS X 254
• Linux 140
Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 1 1 0 1 1 1 5 1 3 2 1 3 2 4 0 1 0 0 3 1 2 1 2 0 0 5 1 1 2 0 0 2 0 2 2 4 3 2 0 2 3 1 1 0 0 2 0 0 1 0 0 3 3 2 1 1 1 1 1 3 1 5 1 0 0 0 3 1 2 1 1 0 2 0 1 2 1 0 1 0 1 2 3 0 0 3 2 0 3 0 0 1 0 3 1 0 0 2 0 2 0 0 0 0 1 0 1 1 0 1 2 2 0 0 1 0 0 1 1 1 0 2 0 2 1 1 1 2 1 0 0 2 0 0 1 1 0 0

Source
raw.​githubusercontent.​com

# Graphvizer

Graphvizer is a Graphviz plugin for Sublime Text 3. It can make your experience more pleasant when editing a dot language file. You just need to edit your file at the speed of thought and this plugin will render the image and refresh it in real time. If the syntax is invalid, the plugin will show you some error messages.

# Features

• Real-time rendering
• Real-time syntax checking
• Error message prompting

# Usage

Note: Please ensure the file syntax is set to Graphviz (DOT). You can do this by View -> Syntax menu or clicking the bottom right corner of Sublime Text window.

### Open image window

ctrl+shift+g or Tools -> Graphvizer -> Open Rendered Image

### Open Graphvizer panel

ctrl+shift+x or Tools -> Graphvizer -> Show Graphvizer Panel

# Why do I create this plugin?

Graphviz is an awesome visualization tool, but it's very inconvenient to write a dot file by hand. I have to use dot file.dot -Tpng -o file.png to render image manually again and again and I don't know whether the syntax is correct or not instantly. Atom editor has an excellent plugin called GraphViz preview+, but I can't find any plugins like this on packagecontrol.io. Finally, I create Graphvizer.

# Installation

## 1. Prerequisites

I can't implement the Graphviz visualization algorithm from scratch, so this plugin needs dot command to render the image. In other words, you need to install the official Graphviz on your system.

### For Linux/Mac

Use your operating system package manager (e.g. dnf or apt-get) to install Graphviz.

On my Fedora 27 X86_64, the command is:

sudo dnf install graphviz


Use dot -V to make sure you have configured all things correctly and you should see the version info of Graphviz.

### For Windows

Download from here: https://graphviz.gitlab.io/download/. The installation is very simple but you need additional configuration to tell the plugin where to find the dot command.

Method 1: Add the path of dot.exe (e.g. D:\Graphviz\bin) to the PATH environment variable of your system. Then the dot command can be accessed from the command prompt(a.k.a. cmd) and this plugin can also invoke it. If you don't know how to do this, this article may help you.

Type dot -V in Windows cmd window and hit enter. If everything is OK, you will see the version info of Graphviz.

Method 2: Specify the path of dot explicitly with plugin settings file. See the full details in Configuration part.

## 2. Installing Graphvizer

### Using Package Control (Recommended)

The easiest way to install Graphvizer is through Package Control.

Bring up the Command Palette (Control+Shift+P on Linux/Windows, Command+Shift+P on Mac). Select Package Control: Install Package and then search Graphvizer to install it.

### Manually

git clone this project to your system or just download the zip file from GitHub and decompress it. Now you have got the Graphvizer directory.

Using the Sublime Text 3 menu Preferences -> Browse Packages... to find out your package directory path. On my Windows 7, the path is D:\Sublime Text 3\Data\Packages. Move the entire Graphvizer directory into the package directory. Press Ctrl+Shift+P in Sublime and run Satisfy Dependencies. Restart Sublime. Done!

# Configurations

The default configurations are as follows. If you want to change some configurations, open Preference -> Package Settings -> Graphvizer -> Settings - User and copy the following content to the opened file. Save it after modifying it according to your needs. The meaning of each configuration is explained subsequently.

{
// "dot_cmd_path" is the path of dot command. Here are some examples.
// For Windows: "D:\\Graphviz\\bin\\dot.exe"
// For Linux: "/usr/bin/dot"
// For OSX: "/usr/bin/dot"
// If you have added this path to the PATH environment variable, you can
// use "dot" instead of the full absolute path.
"dot_cmd_path": "dot",
// If the dot command takes more than dot_timeout seconds, it will be
// terminated. The default value is 6 seconds.
"dot_timeout": 6,
// "show_image_with" controls how to show the image.
// The default value is "window", so the image will be shown in a new
// window by default. If you want to show it in a new layout instead,
// change the following value to "layout".
"show_image_with": "window"
}


### Set dot path

If you want to specify the path of you dot command, please set dot_cmd_path according to your system. This configuration is useful on Windows.

### Set timeout for dot command

If you are editing a very large graph, the dot command may need a long time to complete and your CPU may be exhausted. For this reason, I set a timeout for dot command and it will be terminated if it takes too long to complete. You can change the timeout by setting dot_timeout as needed. Generally, you don't need to change this configuration.

### Show the image in a separated layout

By default, the plugin will show the image in a new window. This is flexible in most cases, especially when you have two monitors. If you do like use a separated layout to show the image, change the value of show_image_with from window to layout and save it. (You may need to restart Sublime Text 3 to take effects.)

# Key Bindings

The default key bindings are as follows. If you want to change the default key bindings. Open Preference -> Package Settings -> Graphvizer -> Key Bindings - User and copy the following content to the opened file. Save it after changing ctrl+shift+g or ctrl+shift+x to other shortcuts according to your needs.

[
{
"keys": ["ctrl+shift+g"],
"command": "graphvizer_open_image",
"context":
[
{"key": "selector", "operator": "equal", "operand": "source.dot"}
]
},
{
"keys": ["ctrl+shift+x"],
"command": "show_panel",
"args": {"panel": "output.graphvizer_panel"},
"context":
[
{"key": "selector", "operator": "equal", "operand": "source.dot"}
]
}
]


# To-Do List

• [x] Configure the dot command path in Settings.
• [x] Key Bindings for Window/Linux/OSX separately.
• [x] Add Preference -> Package Settings menu items to custom user settings.
• [x] Being able to show the image in a separated layout.
• [x] Set timeout for dot command.
• For other features, please open an issue.