org.gicentre.treemappa

Class PTreeMappa

java.lang.Object

org.gicentre.treemappa.PTreeMappa

public class PTreeMappa
extends java.lang.Object

Wrapper class to allow Processing sketches to load, create and draw treemaps.

Version:

3.3.0, 18th April, 2016.

Author:

Jo Wood, giCentre.

Constructor Summary

Constructors

Constructor and Description
PTreeMappa(processing.core.PApplet parent) Creates an object capable of building and representing a treemap.
PTreeMappa(processing.core.PApplet parent, int w, int h) Creates an object capable of building and representing a treemap with the given default image dimensions.
PTreeMappa(processing.core.PApplet parent, java.lang.String configFileName) Creates a treemap from the details supplied in the given configuration file.
PTreeMappa(processing.core.PApplet parent, java.lang.String configFileName, int w, int h) Creates a treemap of the given display dimensions from the details supplied in the given configuration file.

Method Summary

Modifier and Type	Method and Description
boolean	buildTreeMap() Builds the treemap from the hierarchical data stored in this object.
processing.core.PImage	createImage() Draws and provides an image containing the current treemap.
void	draw() Draws the treemap directly in the parent sketch.
void	draw(float x, float y, float w, float h) Draws the treemap directly in the parent sketch at the given position and size.
TreeMappa	getTreeMappa() Provides the TreeMappa object used to build and display treemaps.
TreeMapPanel	getTreeMapPanel() Provides a TreeMapPanel used to customise the appearance of the treemap.
void	readData(java.lang.String dataFileName) Reads in CSV tree data from the Processing sketch's data folder.
void	readData(java.lang.String dataFileName, java.lang.String fileFormat) Reads in tree data in the given format from the Processing sketch's data folder.
void	setBranchTextAlignment(int alignX, int alignY) Sets the text alignment for branch labels.
void	setColourTable(java.lang.String cTableFileName) Sets a new colour table from a colour table file.
void	setLeafTextAlignment(int alignX, int alignY) Sets the text alignment for leaf labels.
void	setRenderer(Drawable renderer) Sets the renderer to be used for drawing treemaps.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PTreeMappa

public PTreeMappa(processing.core.PApplet parent)

Creates an object capable of building and representing a treemap.

Parameters:

parent - Sketch in which this treemap will be used.

PTreeMappa

public PTreeMappa(processing.core.PApplet parent,
                  int w,
                  int h)

Creates an object capable of building and representing a treemap with the given default image dimensions.

Parameters:

parent - Sketch in which this treemap will be used.

w - Initial width of the treemap in screen coordinates. If 0, the width of the parent sketch is used.

h - Initial height of the treemap in screen coordinates. If 0, the height of the parent sketch is used.

PTreeMappa

public PTreeMappa(processing.core.PApplet parent,
                  java.lang.String configFileName)

Creates a treemap from the details supplied in the given configuration file.

Parameters:

parent - Sketch in which this treemap will be used.

configFileName - Name of file containing the treemap configuration.

PTreeMappa

public PTreeMappa(processing.core.PApplet parent,
                  java.lang.String configFileName,
                  int w,
                  int h)

Creates a treemap of the given display dimensions from the details supplied in the given configuration file. If the given width and height values are greater than 0, they will override any provided by the configuration file.

Parameters:

parent - Sketch in which this treemap will be used.

configFileName - Name of file containing the treemap configuration.

w - Initial width of the treemap in screen coordinates. If 0, the width provided in the configuration file is used.

h - Initial height of the treemap in screen coordinates. If 0, the height provided in the configuration file is used.

Method Detail

readData

public void readData(java.lang.String dataFileName)

Reads in CSV tree data from the Processing sketch's data folder. If you need to read data from other locations, use TreeMappa's file reading methods instead.

Parameters:

dataFileName - Name of CSV file in the data folder representing the tree data.

readData

public void readData(java.lang.String dataFileName,
                     java.lang.String fileFormat)

Reads in tree data in the given format from the Processing sketch's data folder. If you need to read data from other locations or need to control format options, use TreeMappa's file reading methods instead.

Parameters:

dataFileName - Name of file in the data folder representing the tree data.

fileFormat - Format of data file, can be 'csv', 'csvSpatial', 'csvCompact' or 'treeML;

buildTreeMap

public boolean buildTreeMap()

Builds the treemap from the hierarchical data stored in this object. This method should be called in preference to buildTreeMap() in the TreeMappa class since it will update the treemap panel used for drawing in Processing.

Returns:

True if the tree has been built without problems.

createImage

public processing.core.PImage createImage()

Draws and provides an image containing the current treemap. Note that this will update the treemap with the current layout settings so should not be called repeatedly if no changes have been made since the previous call. Instead, call it once and store the resulting image as a PImage variable.

Returns:

Image representing the treemap.

draw

public void draw(float x,
                 float y,
                 float w,
                 float h)

Draws the treemap directly in the parent sketch at the given position and size.

Parameters:

x - Coordinate of the left hand side of the treemap in pixel units.

y - Coordinate of the top of the treemap in pixel units.

w - Width of the treemap in pixel units.

h - Height of the treemap in pixel units.

draw

public void draw()

Draws the treemap directly in the parent sketch. This is an alternative to calling createImage() and will use the currently selected font and stroke from the parent sketch. Treemap nodes are filled according to the colour rules set for the treemap.

setColourTable

public void setColourTable(java.lang.String cTableFileName)

Sets a new colour table from a colour table file. Assumes the colour table file is stored in the data directory of the sketch.

Parameters:

cTableFileName - Name of file containing the colour table to use to represent treemap nodes.

setRenderer

public void setRenderer(Drawable renderer)

Sets the renderer to be used for drawing treemaps. This need only be set if some non-default rendering is required (such as the sketchy rendering produced by the Handy library).

Parameters:

renderer - New renderer to use or null if default rendering is to be used.

setLeafTextAlignment

public void setLeafTextAlignment(int alignX,
                                 int alignY)

Sets the text alignment for leaf labels. Used for positioning the text of a leaf label relative to its enclosing rectangle. Will default to CENTER if alignment values not recognised.

Parameters:

alignX - Horizontal alignment of text can be Processing constants LEFT, CENTER or RIGHT.

alignY - Vertical alignment of text can be Processing constants TOP, CENTER, or BOTTOM.

setBranchTextAlignment

public void setBranchTextAlignment(int alignX,
                                   int alignY)

Sets the text alignment for branch labels. Used for positioning the text of a branch label relative to its enclosing rectangle.

Parameters:

alignX - Horizontal alignment of text can be Processing constants LEFT, CENTER or RIGHT.

alignY - Vertical alignment of text can be Processing constants TOP, CENTER, or BOTTOM.

getTreeMappa

public TreeMappa getTreeMappa()

Provides the TreeMappa object used to build and display treemaps. This object can be used to customise the features of the treemap that affect layout.

Returns:

TreeMappa object used to build and display treemaps.

getTreeMapPanel

public TreeMapPanel getTreeMapPanel()

Provides a TreeMapPanel used to customise the appearance of the treemap. This object can be used to customise the features of the treemap that affect appearance but not layout.

Returns:

Treemap panel used to display treemaps.