Invoking TreeMap through the command line
TreeMap can be invoked from the command line, typically for automating and batch processing the production of several treemaps.
If you intend to use this scripting possibility in unattended and automated batch jobs (typically a night job running on a remote build server): non-human devices that utilize our software without user interaction are counted as users and you would then need to order the appropriate number of licenses.
TreeMap comes bundled with its own optimized Java runtime (that can be found in the jre directory), which is order of magnitude faster for certain operations (in particular for all word-wrap operations) than the standard Java runtime. Nevertheless, TreeMap is fully compatible with Java 11. The invocation of TreeMap from the command line can be done as follows:
- Windows
-
Start Command Prompt application and then type:
cd "C:\Program Files\TreeMap"
jre\bin\java -jar lib/treemap-swing.jar --out output.png data.mtm`- macOS
-
Start Terminal application
cd /Applications/TreeMap/
./.install4j/jre.bundle/Contents/Home/bin/java -jar lib/treemap-swing.jar --out output.svg data.xls- Linux
cd /usr/local/TreeMap
jre/bin/java -jar lib/treemap-swing.jar --out output.ps data.csvA typical usage scenario is to have some settings applied the data. To
proceed, create a settings file (menu:File[Export Settings…] with the
.mtms file extension) that then be loaded together with the data by
specifying it with the --settings option .
To be able to produce treemaps of arbitrary sizes, tick “Fixed” in menu:Rendering[Dimension] pane of the configuration panel and set the desired dimension.
Command line options
TreeMap can be invoked from the command line with the following options::
-h,--help-
Show the help
-l, --language <argument>-
Set the default language
-e, --expert-
Run TreeMap in expert mode
-g, --disable-logging-
Disable logging window
-f, --lf <argument>-
Set the look and feel
-u, --uiscaling <argument>-
Scale the UI
-b, --label <argument>-
Set the variable to use for labeling
-k, --background <argument>-
Set the variable to use as background
-a, --groupby <argument>-
Set the variable to use to groupBy
-c, --color <argument>-
Set the variable to use for coloring
-s, --size <argument>-
Set the variable to use to display the size. The area of the nested shapes will be proportional to its values. To control the dimension of the treemap (its size in pixels), use the
--dimensionoption. -H, --height <argument>-
Set the variable to use to display the height
--colormap <argument>-
Set the colormap to use
--algorithm <argument>-
Set the TreeMap algorithm to use
--aggregation <argument>-
Set the aggregation method to use
--scale <argument>-
Set the scaling method to use
--nesting <argument>-
Set the nesting method to use
--ordering <argument>-
Set the ordering method to use
--depth <argument>-
Set the depth scheme to use
-labeling <argument>-
Set the labeling method to use
--rendering <argument>-
Set the rendering method to use
-d, --dimension <argument>-
Specify the dimension of the treemap (default is 608;569)
--dpi <argument>-
Set the output image resolution (only for raster output formats, default is 72). With a specified DPI of 144, the output file dimension will be 1216x1138 for the default dimension, but will look identical (but more precise) than the 72 DPI version.
--settings <argument>-
Load a particular settings file
--out <argument>-
Specify the output file. The format is determined automatically from the file extension. Supported formats are PNG, JPEG, GIF, TIFF, SVG, PDF, Postscript, EMF.