You are on page 1of 26

Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/toc.

html

Treemap 4.1 Online Documentation

Requirements
Treemap 4.1 requires Java 1.4

Treemap has been developed on PCs. We used either Windows 2000 or XP and do not have the resources to
make sure that Treemap works on every platform/version. We have heard that Treemap does run on some
versions of Linux, Unix and Windows ME. Remember that Treemap will not work in environments that do not
support Java 1.4

Known Problems
To Get Started
Real-time Video Streaming Downloadable Video
Treemap Video Tutorial with
Treemap Video Tutorial
file buffering
OVERVIEW (8min 53 seconds, 6.5 MB)
(8min 53 seconds, 6.5 MB)
DEMONSTRATION * See this if you are using a high
* See this if you are using a dialup
speed internet
modem
TABLE OF VIDEO DEMO Table of short task-oriented video demonstrations

User Manual
Text and Picture
Title Quick Demo Example Data
Documentation
How to interpret a
Basketball
Introduction Introduction Treemap statistics
(1 min, 800KB)
Create a Treemap with
flexible hierarchy Basketball
Create your own TM3 data file
(40 seconds, 580KB) statistics
Create your own XML data file Dealing with an imposed
Creating your 43 Causes of
own Treemap Flexible Hierarchy hierarchy death
(50 seconds, 740KB)
(i.e. creating a hierarchy based More examples of flexible Projects of a
on a series of attributes) hierarchy company
(1 min 15seconds, 760KB)
Save Settings and Create your Save settings Basketball
Saving Settings
own BATCH file (15 seconds, 140KB) statistics
Choose layout algorithm Basketball
Changing the Layout statistics
(17 seconds, 220KB)
Changing the Parameters
Layout (algorithm, size, color, labels, Color, size and label
attribute Basketball
Parameters borders), statistics
and Keyboard Shortcuts (24 seconds, 260KB)

1 of 2 6/3/2011 10:48 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/toc.html

Adjust borders and fonts Directory


(18 seconds, 200KB) hierarchy
Advanced Color Setting and Binning Color Binning Basketball
Color Setting for Numerical Attributes (1 min 3seconds, 820KB) statistics
Zooming in and out, showing
Directory
details of a node, showing the Zooming hierarchy
path (11 seconds, 180KB)
Focusing on Filtering Basketball
areas of Filter with Dynamic Query
(53 seconds, 630KB) statistics
interest Sliders
Aggregation
(28 seconds, 230KB) Basketball
Aggregate the Lower Levels of
statistics
the Tree
Using Treemap to monitor
Monitor
changing data (Automatic
changing data
Reload)
Network
Network Visualization
Visualization
Feature Set Feature Set
Other Features
Other
(Export, Print Treemap, and
Features
Print this Document)
Mapping a file Mapping a file directory Directory
Mapping a file directory
directory (43 seconds, 500KB) hierarchy
How large a
tree How large a tree could I display
could I display with Treemap?
with Treemap?
Command line
Command line arguments
arguments
Our plans for
Our plans for Treemap 4.2
Treemap 4.2

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

2 of 2 6/3/2011 10:48 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/1.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Introduction

Treemap is a space-filling visualization for hierarchical structures. It is particularly effective in revealing attributes of leaf
nodes using size and color coding. Treemaps enable users to compare sizes of nodes and of sub-trees, and can reveal
patterns and exceptions.

We HIGHLY recommend that you read the history of Treemaps page, maintained by Ben Shneiderman, to learn more about
the various layout algorithms and applications of treemap. Of course, we also recommend that you read the papers
mentionned in this history of treemap.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:48 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/layout.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Changing the Layout Parameters


.

Main Tab: to choose algorithm, font size, and borders


The Layout Algorithms

Treemap implements three Layout Algorithms:

Slice And Dice - Stable and ordered, but poor aspect ratio. It can generate long skinny rectangles,
but is very good to compare sets of items side by side. Note the "flip slice and dice option".
Squarified - Best aspect ratios, Unordered, medium stability. The nodes will move when the size
changes.
Strip - Ordered, pretty good aspect ratios with some exception, medium stability. The nodes move,
but not as often as in Squarified Algorithm.

You will find that the best choice of algorithm depends largely on your data and task, so try all three
versions using the menu in the "Main" tab.

Note that in all the cases, nodes that have a size of zero will not appear on the screen, and that subtrees
that have too many nodes to be drawn will appear black because the 1 pixel border drawn to separate
nodes are black.

Label font size: Making the size = 0, hides the labels but their values remain visible on the cursor activated popup
window.

Border padding: This padding helps see the grouping of nodes in subtrees, but pixels are "lost" with this padding. So
reducing the size of the padding may reveal more nodes. Reducing the font size also helps regain pixels.

Hide borders: will remove ALL borders and padding so that every pixel is dedicated to the painting of nodes. But
watch out that adjacent nodes of the same color will appear to be merged. Turning this control on and off several
times is helpful to gain an understanding of the structure of the treee and see details as well.

Restore default settings in Treemap: simply reloads the file you last opened

Legend Tab: To choose size, color, and label attributes


Label attribute: By selecting "None", all labels will be removed, but you might prefer to set the font size to zero so
that the pop-up still displays some information about the node.

Size attribute: Only numerical attributes will appear in this option box. If the attribute has negative values they will be
handled as zero, i.e. the node will not be visible (we plan to offer alternative options such as using the absolute value
in Treemap 4.1)

1 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/layout.html

Color attribute: If you choose a numerical attribute, a color legend and color binning panel will appear. For more
information, see Color Binning for Numerical Attributes.

Linear, Square Root, or Logarithmic options: those are helpful to gain a quick understanding of the data when the
distribution is very skewed.

Color aggregation functions: average, minimum, maximum, and weighted average. This specifies what aggregation
function should be used for the current color attribute when the lower levels of the tree are aggregated using the top
slider in the filter tab panel. For more information, see Aggregate the Lower Levels of the Tree in the filtering
documentation page.

Keyboard Shortcuts: To support keyboard navigation


The mnemonics for all the menu options are available and are underlined. For example, for file menu, alt+f will make
the file menu selected, then 'o' for file open, 'd' directory mapping etc.

The keyboard shortcuts are displayed on the menus.

Some of the shortcuts that are not displayed are:


"Enter" - zooming in the tree
"Esc" - Zooming out the tree for the selected node
"F1" - help, will give the quick reference for the treemap documentation.
"Up Arrow" - highlights the parent node for the selected node.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

2 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/binning_overview.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Color Setting and Binning for Numerical Attributes


.

Overview
The color setting widget serves as a color legend, a histogram showing the distribution of values, and a data entry
widget to set ranges (i.e. bins) of values and assign them different colors.

The minimum and maximum value on the axis is determined by the minimum and maximum value of the data visible
on the Treemap (i.e.if data has been filtered out, then the widget is "zoomed" on the current values.

"Lock the number of bins" is useful to avoid adding more bins by mistake while pointing at the color legend. It is
enabled only when the User Defined Bins option is selected.

Binning options

Equally Spaced Bins - Equally Dense Bins

The placement of the bin separators is calculated automatically, but you can set the number of bins.
Either use the up/down arrows or type the number yourself. The number of bins has to be between 1 and
20.

You can change the color of bins but not the min and max values.

User Defined Bins

LEFT-CLICK where you want a NEW bin separator to be added


RIGHT-CLICK on a separator blue arrow to DELETE a separator
CLICK and DRAG on the blue arrow to MOVE a bin separator (or you can edit min and max values by
clicking on their value box)

Once you lock the number of bins, you will not be able to add any bins (but it is possible to delete the
bins).

This is the default option when the data has both negative and positive values, and is set to have zero as
the two bin separation value

To select different colors


When you click on the "MIN" or "MAX" button, a color picker will appear for you to select colors. When bins are
small and hard to highlight with the cursor, you can cycle through the bins by clicking on the "Previous" and "Next"

1 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/binning_overview.html

buttons.

We tried to provide some useful DEFAULT colors but realized there were so many different special cases, so we
"gave up"... for now. So the default colors go from green to yellow to red and then just give "useful" defaults that you
have to set yourself.

To change the min and max values


Click on the buttons below the min and max buttons showing the VALUES themselves, or click on the values in the
legend/histogram.

TIPS for setting your colors


It is not always easy... we could have spend many more days creating the perfect color widget but we had to stop
somewhere. This widget will allow you to do pretty much anything you want with a bit of patience.

Don't forget to save the settings once in a while so that you can recover from mistakes.

To see the widget in more detail, you can make the treemap smaller and the control panel larger by dragging the
window separator to the left. This will give more width to the color widget, thus, making it more readable and
selectable.

When the bins you need are very close together (often the case for very skewed data):

First decide on the number of bins you will need.

Create Equally Spaced Bins.

Choose your colors by selecting colors for each bin range.

Switch to User Defined Bins.

Edit the numerical values of min and max (by clicking on the values below min and max or in the
legend/histogram itself).

In last resort, if you need to see the legend in more details, you can "zoom" on the legend by using the filters to filter
the data itself. Once you have clicked on "Hide Filtered", the legend will be zoomed to show only the remaining
useful range.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

2 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/zooming.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Zoom - Show Details - Show Path


To zoom in, double click on the desired node or subtree border (or hit "Enter").

To zoom out, single right click. If you have difficulty zooming in or out, it might be because your mouse is too
sensitive and moves while you click (or hit "Esc").

To show details with popup: As you move the mouse over the Treemap, a yellow line will indicate which node the
mouse is over. In addition, a pop-up box will appear indicating the node's name, the attribute values Treemap is
coloring and sizing by, and the depth of the node.

To show more details: click on the node and the list of all its attribute values will appear in the upper right window.
Remember to scroll if you do not see what you are looking for. You can also resize the window by dragging the
window separators.

To show the path:When you click on a node, all the parents of the node are highlighted with a gradient of fading
colors. The path of the node is also shown in the detail window at the bottom of the table (don't forget to scroll). It
will be split in several lines to avoid supor long labels that would make the whole table scrollable. If the highlighted of
the path on the treemap uses a color that conflict with your color scheme, you can change it by using the "Set Path
Highlighting Color" option of the "Option" menu of the menu bar.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/filter_overview.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Filter with Dynamic Query Sliders


.

Filter by Maximum Depth

See the section below on Aggregating the Lower Levels of the Tree

Filter by Attributes

Slide one or both sides of the double sided sliders to the values you need. You can use as many sliders as you want.

The nodes that do not fit the criteria you set with the sliders will appear grey on the treemap.

Hiding filtered nodes: this is particularly useful to reclaim the pixels of the filtered out nodes to show more details on
the remaining nodes. Note that the layout will most likely change drastically.

Nodes could be hidden as you drag the slider but this can sometimes be too slow so it is done only when the option is
set.

NOTE: the "hide filtered nodes" will not be remembered in the save settings. The settings of the filters will be saved,
but the filtered nodes will appear gray. If this is a problem, you can you the Export function of the file menu to create
a new data file.

Hide Individually Selected Nodes

To select nodes, click on the nodes or subtree border while holding the CTRL key down.

The nodes' border will become dark blue.

The nodes will be removed when you click on Hide Selected button.

Selecting a different filtering widget

Right click on the name of the attribute and an option box will appear to change the widget.

Nominal attributes will use by default:

1 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/filter_overview.html

Radio Buttons - if the number of attributes is between 0-2.

Check Box - if the number of attributes is between 2-4.

Item Slider - if the number of attributes is more than 4.

Aggregate the Lower Levels of the Tree

By filtering by depth (the top slider in the Filter tab), you can aggregate the lower levels of the tree.

The size is (by definition) aggregated using a "sum" function.

The color is aggregated using the aggregation function selected in the legend tab. The default is the "average"
function.

Weighted average uses the size sttribute to weigh the average calculation.

Click on an aggregated node and the aggregate numbers will be displayed in the detail table for the size and color
attributes.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

2 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/hierarchy_overview.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Flexible Hierarchy
.

Why flexible hierarchies?

Some data is best presented with a fixed hierarchy. For example, census data falls nicely in a hierarchy of country,
states, counties, and blocks which could not be rearranged. Some other data could be rearranged using various
hierarchies based on the attributes available. For example, if you have health data provided for the 2 sexes, 3 races
and 5 age groups, you could present the data in a variety of ways. One example would be by separating men and
women at the 1st level, then splitting by race at the second level and then by age. Another hierarchy could be to split
by age first, then sex, then race. Flexible hierarchies let you specify the order you want those attributes to be used
when creating the hierarchy.

Hierarchy tab: to create hierarchies

If the data file you are using has a default hierarchy (see creating your own data file), you can 1st remove the default
hierarchy. All nodes will appear together on the treemap without any hierarchy. Now you can create you own
hierarchy.

Choose from the list of available attributes (at the bottom), then click on the "Add" button and the attribute will be
added in the Hierarchy List.

Attributes that have only a few values (e.g. sex or race) make good hierarchy attributes. Other like "age" need to have
their values grouped in bins to split the tree nicely, e.g. you can split between young and old people by binning the age
attribute into 2 bins. TO BIN an ATTRIBUTE: click on the right most cell of the corresponding hierarchy attribute
table.

For details and tips on using the binning widget please refer to the section on User Defined Bins in Color Binning for
Numerical Attributes.

To remove an attribute, select the attribute and click on the "Remove" button.

You will find that it is better to use put the last/bottom attribute as the label attribute and remove it from the hierarchy
definition.

You can create different permutations of the attributes in the Hierarchy List by using the "Up" and "Down", or "auto"
to permute automatically and review the many options. Treemap redraws the tree as you change the hierarchy.

Once you are happy with a hierarchy you can give it a name (by typing a new name where it says "hierarchy 1") and
you can use the "New" button to create another hierarchy. Remember to save the settings as well!

Example of Flexible Hierarchy

Open the "election.tm3" file and color by the attribute "Party in 2000". This shows which states voted for who in the

1 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/hierarchy_overview.html

last presential election. Changing one of the two colors will make things more readable.

This file has a default hierarchy of states within regions, but now you can go the newly added "Hierarchy" tab
window and add levels in the hierarchy.

For example, you can select the attribute "Party in 1996" from the list of attributes and then click on "Add".
The hierarchy now has an additional level, and regroups all the states that voted for Democrats and those who voted
for Republicans.

If you now select "Party in 1996" in the hierarchy and click on "Move Up", this particular attribute will be at the top
level of the hierarchy.

Next, remove the attribute "Party in 1996" from the hierarchy (by selecting it in the hierarchy and clicking on
"Remove").

Add the attribute "Population" in the hierarchy. Since it is a numerical attribute, there is no natural grouping. The
bottom binning widget shows the distribution of the values.

Take a look at the hierarchy panel for the attribute "Population". It says 49 (for 49 values) and "No binning".
No binning is actually a drop down box with different options, namely, Equally Spaced Bins, Equally Dense Bins, and
User Defined Bins.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

2 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/saved.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Save Settings
You can save the hierarchies you created, layout options, zoom level, label, size and color choices and filtering options
by using Save Settings.

Select Save Settings in the File menu.

Select the same directory as the corresponding data input file (.tm3 or .xml) is in. Data input files and tms files can be
saved to and loaded from any accessible directory as long as the tms files are in the same directory as their
corresponding data input files.

Choose a file name. The default name is the same name as the data input file. The extension ".tms" will automatically
be added at the end of the file.

This .tms file contains the settings and a reference to the data input file it corresponds to.

You can now open the .tms file to load the data and apply the settings automatically.

The following settings are NOT saved:

The nodes that were hidden will appear as gray in the reloading the settings of the .tms file. This way you will be able
to see which nodes were filtered out, and apply "Hide filtered nodes" to remove then. If this is a problem, you can use
the Export function of the file menu to create a new datafile.

Having Problems with Save Settings?


Common Errors experienced by several users:

Make sure you open the *.tms file and not the *.tm3 file. The tms file includes a pointer to the tm3 data and loads it
with the correct settings. This allows saving several settings for the same data file.

If you are using any version prior to Treemap 4.0, save settings will not work. You have to save the new settings
entirely as the format has changed and the old settings files are not updated properly. Start from the tm3 file, set the
controls as you want, and save the settings as a *.tms file.

Create your own BATCH file

Suppose, you wish to create My.BAT file.

Go to NotePad, select "Save As" option from the "File" menu. Then type "My.BAT" and click "Save". Make sure to
have the "My.BAT" within double quotes (") as they are required to correctly save this file as Batch format. You can
use any text editor to effectively create your own BATCH file, however, remember to include the double quotes (").

The commands that should be put into the BATCH file:

java -jar TreemapProgram.jar command line arguments


The input files don't have to be in the "data" directory any more. (See the link for command line arguments.)

1 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/saved.html

pause
This command is optional and is needed only if you wish to monitor the type of errors that occur at runtime. If
there are any, please email the entire error message to us at treemap@cs.umd.edu, so we can continually
improve the quality of Treemap for future usage.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

2 of 2 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/create_TM3_file.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Create your own TM3 data file


.

Note: Treemap does not support the .tm2 format any longer.

Treemap uses a very simple TAB-delimited format that includes both the attributes values and the tree structure. You can
create the data with a spreadsheet, or export it from a database.

Standard Treemap file including a default hierarchy


Creating a new Treemap file with a spreadsheet program:

On the first row of the spreadsheet, put all the attribute labels for your data, placing one label per cell. For
example, to create a data file on traffic information (as seen above), you would put "Length (miles)" in the first
cell, "Traffic Lights" in the next cell, "Speed Limit" in the third cell, and "Repairs per week" in the fourth cell.

In the next row, put the type of each attribute data. Data can be of type FLOAT, INTEGER, DATE, or
STRING. Data types must be typed in UPPERCASE letters. In the traffic example, one would have "FLOAT"
in the first cell of the second row, "INTEGER" in the second, "INTEGER" in the third, and "FLOAT" in the
fourth.

NOTE: If the attribute type is DATE, then the format should be MM/DD/YYYY. Please do not add any
other values like time or day along with the date value. Make sure you enter the data values using the
above mentioned date pattern only.

Fill in the values for each attribute for an item, placing one item per row. After all the attribute values are
filled, include one blank column. After the blank column, list the hierarchy path starting with the name of the
root. For example, "Roads" would be in the first cell after the blank column, "Highway" in the second, and
"Route 1" in the last cell. (Note that the leaves of the tree do not need to be at the same depth.)

Now save the file as a tab-delimited text file, such as, traffic.txt. The file is now ready to be loaded by
Treemap, but we like to rename the data file with an .tm3 extension to identify them as treemap datafiles.
Rename the data so the extension is .tm3 instead of .txt.

After loading the .tm3 file, you can change the Legend for Color to "Location" from the control panel of
treemap, which is a column containing controls on the right hand side.

1 of 3 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/create_TM3_file.html

The picture below shows how Treemap looks like after loading the created file, traffic.txt (or traffic.tm3) and
applying several settings from the control panel. (If you don't do anything after you load the file, all cells will
appear as white because the default Legend for Color is "(None)".)

If you apply some settings after loading a .tm3 file, you can save them. See Save Settings.

Simplified format for use with the flexible hierarchy

If you do no want to - or need to - include a hierarchy in the treemap because it can be created with the flexible
hierarchy, simply omit to include a hierarchy in the file. The firearm.tm3 file is an example of such file.
Treemap will pick the first string attribute as default attribute for labeling (the default labeling being usually the
last string of the path definition found in the data file for each node.

Common Problems
If your newly created Treemap file does not load correctly it could be caused by one of the following problems.

1. Make sure you have no empty values in your attribute data table.

2. Excel sometimes adds extra white space if you move your cursor to areas outside your data, or replace cells that once
had information with white space when deleted. This causes a problem with Treemap. To remedy this, open your file
in excel. Select all of your data, but only your data. DO NOT SELECT ANY OUTSIDE BLANK CELLS. Select the
copy command. Then open a new spreadsheet and paste the information you had selected. Now without changing or
exploring the data save the file as a tab delimited text file and the white space should be gone.

3. Make sure that INTEGERs are really integers.

4. Make sure that DATEs have the format MM/DD/YYYY.


If they have other formats than this, you can change it in Excel.
1. Open the file in Excel.
2. Click on the column's letter (e.g. G) to select the whole column with the different date format.
3. From the menu, select Format and then Cells.
4. From the Category: select Date.
5. Choose the type that conforms to MM/DD/YYYY (e.g. 3/14/1998).

5. If you have nodes with negative values for the attribute you chose for map to size, those nodes will not be shown.

6. Remember that there may not be enough pixels to show every node in your tree. Make the window size bigger, use
zooming and filtering to limit the number of nodes shown, remove the borders, and of course set the size attribute to
fit the characteristic of the nodes you care about and want to see.

2 of 3 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/create_TM3_file.html

7. If you try to open your .tm3 file with Excel and it complains that your file has an invalid SYLK file format, this
means that the first 2 characters of the file is "ID". One way to avoid this problem is to change the case, such as "Id".
Read more about SYLK file format problem at Microsoft support.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

3 of 3 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/create_XML_file.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Create your own XML data file


Treemap uses the simple XML format designed for the data set in the IV03 contest .
The simple XML format for the IV03 contest is specified in treeml.dtd.
The sample tree is also provided under data/ directory in the Treemap bundle you download. (Actually there is
a slight modification in terms of the location of the .dtd file, i.e. the DOCTYPE line.)

You need to have treeml.dtd in the same directory as your XML files if the DOCTYPE line in your .xml file
looks like:
<!DOCTYPE tree SYSTEM "treeml.dtd">

You don't need to have treeml.dtd locally at all, if the DOCTYPE line in your .xml file has an absolute
reference:
<!DOCTYPE tree SYSTEM "http://www.cs.umd.edu/hcil/iv03contest/datasets
/treeml.dtd">

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:49 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/changing_data.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Using Treemap to monitor changing data


.

Automatic Reload

Treemap is not a realtime visualization system but you can still use Treemap to monitor data on a regular basis by
reloading the data file every once in a while.

In the "Options" menu of the Treemap window, select "Reload Data File". You will be asked to input the number of
seconds between reload, and whether or not you want a warning before every reload (otherwise the data can be
reloaded and cancel your current exploration (zoom, filter etc.)

If you loaded a "tms" settings file originally (which is most likely), it will reload the same tms file which will triggers a
reload of the data file.

Of course, as you reload the file, the data ranges may have changed. Treemap will detect out of range values, give a
warning and adapt the widgets automatically. To have more control over what happens we recommend that you create
a test file (possibly edited by hand) that includes extreme values for all attributes. You can pick colors for the extrem
values and save the settings. Note that Treemap will only show the colors corresponding to the range of data in the
data file, so when your treemap is looking at data in the normal range it will not show the legend for extreme or
abnormal values.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:50 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/netviz.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Network Visualization (NetViz)


NetViz is the abbreviation for Network Visualization and this abbreviation is commonly used in Treemap. This feature
allows to have links between leaf nodes. Those links are stored in a .tnv file (stands for treemap netviz file). The format of
tnv files are defined below.

The NetViz feature is special in that there are no arrows to indicate incoming and outgoing links. Instead, the curvature of
the link is used to determine that. The curve is nearer to the source node.

A .tnv file depends on leaf nodes that Treemap shows just before loading it (the .tnv file). Steps to visualize the links are as
follows:
(Suppose our data input file is a .tm3 file.)

1. Make sure you have a .tm3 file and a corresponding .tnv file.
2. Open the .tm3 file.
3. Select File->Import NetViz Table from the menu.
4. Open the .tnv file that corresponds to this .tm3 file.
5. Under Options menu either choose Enable global Netviz feature to view all links or Enable under cursor
NetViz feature to view the links that are related to one node at a time. Position the mouse over a node and you will
see all incoming and outgoing links of that node.

Color of links

The color of all links are RED by default. If you want to base the color of a link on a nominal attribute of the target node, go
to the Legend Tab in Control Panel and choose the attribute you want to be effective from the "Link Color" combo box.
This combo box will appear only when necessary, that is whenever a .tnv file is loaded or whenever a directory is mapped
during which automatic generation of NetViz links is requested. When you load a new file, since there will be no NetViz
links associated, the combo box will disappear.

The format of .tnv files

.tnv files are TAB delimited text files that can be opened by or generated in Excel.

For an input data file to have a corresponding .tnv file (or .tnv files), the input data must have an attribute that has a unique
value for every node. We call an attribute having this property a key attribute. If you create a key attribute, it is strongly
recommended that you choose its type as STRING.

The first line of a .tnv file has the name of a key attribute, which should appear exactly the same as in the data input file.
Every other line in the file represents the links as follows: The first column of every line has the source node's key attribute
value and the remaining columns have the target nodes' that the source node connects to.

Name .tnv file example


A B D E In this example, the name of the key attribute is "Name". A has outgoing links to B, D and E; while C has
C AB outgoing links to A and B.

Automatic Generation of NetViz Links As Mapping a directory

1 of 2 6/3/2011 10:50 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/netviz.html

When mapping a directory, you have the choice of automatically generating NetViz links. (See Directory Mapping to learn
where this choice appears.) All .html, .shtml, .htm files (case of extension doesn't matter) will be examined for HREF and
SRC tags and as long as the references can be found under the directory that is mapped, NetViz links will be generated from
those files to the nodes representing references.

After mapping a directory to generate NetViz links, it is a good idea to go to the Legend Tab (in Control Panel) and set the
"Size" legend to "NONE". This setting leads to a clearer appearance of NetViz links.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

2 of 2 6/3/2011 10:50 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/feature_set.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Feature Set
Treemap started to have so many features that it might be too complex for different users. Especially beginners may have a
hard time to find where to start. Treemap now allows you to exclude some features. The whole concept is called the feature
set (the set of all features you can exclude or include.)

By default, all features are included in Treemap. These features consist of:

menu items like File->Open


Attribute table, which is located on the top right hand side
Tabs (and items inside) in Control Panel, which spans the middle and bottom on the right hand side

You can create your own feature set, edit and save an existing one, simply apply an existing feature set, and delete an
existing feature set. After you go to Options menu and select Select UI Feature Set, the "Select Feature Set" dialog
box will appear which shows the available feature sets as a list of items (their names).

To edit an existing feature set, press Edit button, select or deselect the features you want from the dialog that appears and
then "Save" them by pressing Save in the "Treemap Features" dialog box.

To view what features are available in a feature set, you can simply press Edit and later Cancel in "Treemap Features"
dialog box.

To create a new feature set, press New. All features will be selected in the dialog that appears. You can simply deselect the
features you don't want and then save it by pressing Save button.

To delete a feature set, select the feature set you want to delete from the list displayed in the dialog box, and then press
Delete.

To apply a feature set, select the feature set you want to apply from the list displayed in the dialog box, and then press
Apply.

The feature sets are kept as files in the system under features/ directory. Although we strongly discourage you doing that, if
you are an expert user, and delete those files (or add new ones) without using Treemap, you may want to press Refresh
button to update the list of available feature sets. Treemap is robust in that if a feature set becomes unavailable, and you
select it from the list to do something with it (Apply, Edit) the list will be automatically refreshed, so you will see that the
feature set you selected will disappear because it doesn't exist any more.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:50 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/map_dir.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Map a Directory
This feature allows you to display a Treemap of all the files in a directory.

Select "File" from the menu bar and click on "Map Directory" from the file menu.

Click on the directory that you wish to map, then press "Map Selected".

To map an entire hard drive, type the letter of the drive followed by a ":\", for example "C:\" would map the entire C
drive.
WARNING: We have mapped directories of more than 160,000 files, but the limit is a function of the memory
available, the memory allocated to java, the depth of the hierarchy etc. We have not focused on optimizing Treemap
for large trees.

Beginning from Treemap 4.1, it is possible to automatically generate NetViz links by mapping a directory (see
Network Visualization for more details.). Since it takes time to generate links, you will be asked whether you want
Treemap to do this processing ("Do you want NetViz links to be extracted from html files?"). Depending on your
answer, the number of steps differ (4 if "Yes", 3 if "No"). In both cases, step 1 counts the files and collects path
information for every file under the selected directory. Step 2 looks at attributes for every file (file age, file type, file
size). Step 3 will generate NetViz links if "Yes" was the response to the question above. In both cases, settings (such
as color of nodes in accordance with their file type attribute) are applied in the last step.

Coloring by attribute type:We selected some default colors for common file types, but you can change those colors
or add new ones, then save the settings.

Save Settings: For the settings to be used with any directory you want to map, the settings have to be saved as
"Directory_Settings.tms", the default name proposed by the dialog box. This file must always be in the data folder. If
not, directory mapping will not work. Enter another name for the .tms file such as "mydir.tms" if you want Treemap to
save settings for this particular map of the selected directory. Treemap will automatically create a corresponding .tm3
file (in this case "mydir.tm3") to save the data, and then save the settings into the .tms file, which you entered the
name of (in this case, "mydir.tms"). The resulting .tms file is not any different than .tms files that are created upon
loading an input data file. Just in the same way, opening this .tms file will have the effect of loading the corresponding
.tm3 file and applying the settings found in the .tms file.

Note that this behavior (for directory mapping data) is effective since Treemap 4.1. Prior to that, a .tms file for
directory mapping data would behave differently, much like as a shortcut that remaps the same directory (as opposed
to loading an input data file, such as a .tm3 file) and applies the settings found in the .tms file. This behavior no longer
exists since Treemap 4.1.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:50 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/tree_size.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

How large a tree could I display with Treemap?


We have not focused on optimizing Treemap for very large data files, and chose instead to improve the functionalities
of Treemap. Nevertheless we can say that Treemap was successfully used in the following cases:

Mapping a directory comprising of 54,000 files with 20 levels.

Data Files with 25,000 nodes along with 8-9 attributes.

The size of the tree you can display with Treemap will also depend on the amount of memory allocated to run
Treemap. In some cases it might help to increase the maximum memory allocated to Java heap size. This is done in
the command line that starts Treemap by adding the "-Xmxm" parameter. For example to set the max memory for
Treemap to be 256M, change the run.bat file to look like this:

java -Xmx256M -jar Treemap.jar

If you don't specify a maximum size, then the default maximum size is taken as 64M. If Treemap doesn't have enough
memory, it will display a message indicating that it is out of memory.

(Note: Since Treemap 4.1 out of memory errors are handled more smoothly than earlier versions. For this reason, the
use of log files has been discontinued.)

If you are dealing with extremely large trees, you might want to look at this project: Visualizing a million items, and
also look at the results of the InfoVis Contest 2003.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:50 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/arguments.html

Treemap 4.1 Documentation

[Previous] [Table of Contents] [Next]

Command line arguments


You may have the following command line arguments when you run Treemap.

-i input file
input file can be either a data input file (.tm3/.xml) or a .tms file. If it is a .tms file, the corresponding data input file
must be located in the same directory as the .tms file. Treemap will open this file as soon as it starts up.
Example: java -jar treemap.jar -i census.tm3
-n node to highlight
If this argument is used, -i input file has to be used, too. On the opened input file, the node with the label node to
highlight will be highlighted. (If the label is not unique, the first one found will be highlighted.)
Example: java -jar treemap.jar -i election.tm3 -n Maryland
-d directory
You give the directory to map as an argument such as C:\Temp. If you use this argument, you cannot use -i input file.
Or else, this argument will be ignored and input file will be opened instead.
Example: java -jar treemap.jar -d C:\Temp
-f feature set
You give the name of the feature set you want. When Treemap starts up, only the selected features in feature set will
be present.
Example: java -jar treemap.jar -f expert

These command line arguments can be used together in any order as long as they satisfy the conditions discussed above. The
same kind of command line argument should not be provided again as in java -jar treemap.jar -i election.tm3 -i
census.tm3. Or else, the last command line argument will be used and the earlier ones (of the same kind) will be all
ignored.

You can edit run.bat and add the command line arguments there to avoid typing the command line arguments every time you
run Treemap, especially if you happen to use the same arguments frequently.

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:50 AM
Treemap 4.1 Documentation http://www.cs.umd.edu/hcil/treemap/doc4.1/next4.2.html

Treemap 4.1 Documentation

[Previous] [Table of Contents]

Our Plans for 4.2


.

What's next?

More details soon...

In brief, and contingent on securing support for the students, we plan to work on:

Creating better example datasets, providing better help, and examples thru applet
Connecting Treemap and SpaceTree
Revised flexible hierarchy interface
Improved labeling
Providing quick access to several treemap files
Searching the treemap for a substring
Visualizing time series data

Questions
Contact us at: treemap@cs.umd.edu
Return to Treemap main page

1 of 1 6/3/2011 10:50 AM

You might also like