treemap

README

🍬 Pretty Treemaps

Looking to run this for Go coverage? Check https://github.com/nikolaydubina/go-cover-treemap

Uses "Squarified Treemaps" (Mark Bruls, Kees Huizing, and Jarke J. van Wijk., 2000) algorithm.

$ go install github.com/nikolaydubina/treemap/cmd/treemap@latest 
$ echo '
Africa/Algeria,33333216,72
Africa/Angola,12420476,42
Africa/Benin,8078314,56
...
' | treemap > out.svg

Adjusting size

$ ... | treemap -w 1080 -h 360 > out.svg

$ ... | treemap -w 1080 -h 1080 > out.svg

Imputing heat

$ ... | treemap -impute-heat > out.svg

Different colorscheme

$ ... | treemap -color RdYlGn > out.svg

Tree-Hue coloring when there is no heat

$ ... | treemap -color balanced > out.svg

Without color

$ ... | treemap -color none > out.svg

Format

Size and heat is optional.

</ delimitered path>,<size>,<heat>

Algorithms

• Squarified algorithm for treemap layout problem. This is very common algorithm used in Plotly and most of visualization packages. "Squarified Treemaps", Mark Bruls, Kees Huizing, and Jarke J. van Wijk, 2000
• Tree-Hue Color algorithm for generating colors for nodes in treemap. The idea is to represent hierarchical structure by recursively painting similar hue to subtrees. Nikolay Dubina, 2021

Contributions

Welcomed!

References

• Plotly treemaps: https://plotly.com/python/treemaps/
• go-colorful: https://github.com/lucasb-eyer/go-colorful
• D3 treemap is using Squerified: https://github.com/d3/d3-hierarchy
• Interactive treemap: https://github.com/vasturiano/treemap-chart
• Squerified in Rust: https://github.com/bacongobbler/treemap-rs
• Squerified in JavaScript: https://github.com/clementbat/treemap
• Squerified in Python: https://github.com/laserson/squarify
• Treemap Go tool: https://github.com/willpoint/treemap
• Plotly color scales: https://plotly.com/python/builtin-colorscales
• Plotly color scales source: https://github.com/plotly/plotly.py/blob/master/packages/python/plotly/_plotly_utils/colors/colorbrewer.py
• Colorbrewer project, that is used in Plotly: http://colorbrewer2.org

Appendix A: Long Roots

When roots have one child multiple times it takes extra vertical space, which is very useful for narrow final dimensions.

Can collapse them into one node

Long roots without collapsing somewhere deep inside

Long roots with collapsing somewhere deep inside

Appendix B: Less Illustrative Examples

Large dimensions and large tree (e.g. github.com/golang/go)

$ ... | treemap -w 4096 -h 4096 > out.svg

Documentation

Index

• func CollapseLongPaths(t *Tree)
• func CollapseLongPathsFromNode(t *Tree, nodeName string)
• func SetNamesFromPaths(t *Tree)
• type Node
• type SumSizeImputer
  • func (s SumSizeImputer) ImputeSize(t Tree)
  • func (s SumSizeImputer) ImputeSizeNode(t Tree, node string)
• type Tree
  • func (t Tree) HasHeat() bool
  • func (t Tree) HeatRange() (minHeat float64, maxHeat float64)
  • func (t Tree) NormalizeHeat()
• type WeightedHeatImputer
  • func (s WeightedHeatImputer) ImputeHeat(t Tree)
  • func (s WeightedHeatImputer) ImputeHeatNode(t Tree, node string)

Functions

func CollapseLongPaths

func CollapseLongPaths(t *Tree)

CollapseLongPaths will collapse all long chains in tree.

func CollapseLongPathsFromNode

func CollapseLongPathsFromNode(t *Tree, nodeName string)

CollapseLongPathsFromNode will collapse current node into children as long as it has single child. Will set name of this node to joined path from roots. Will set size and heat to this child's size and heat. Expecting Name containing either single value for current node.

func SetNamesFromPaths

func SetNamesFromPaths(t *Tree)

SetNamesFromPaths will update each node to its path leaf as name.

Types

type Node

type Node struct {
	Path    string
	Name    string
	Size    float64
	Heat    float64
	HasHeat bool
}

type SumSizeImputer

type SumSizeImputer struct {
	EmptyLeafSize float64
}

SumSizeImputer will set sum of children into empty parents and fill children with contant.

func (SumSizeImputer) ImputeSize

func (s SumSizeImputer) ImputeSize(t Tree)

func (SumSizeImputer) ImputeSizeNode

func (s SumSizeImputer) ImputeSizeNode(t Tree, node string)

type Tree

type Tree struct {
	Nodes map[string]Node
	To    map[string][]string
	Root  string
}

func (Tree) HasHeat

func (t Tree) HasHeat() bool

func (Tree) HeatRange

func (t Tree) HeatRange() (minHeat float64, maxHeat float64)

func (Tree) NormalizeHeat

func (t Tree) NormalizeHeat()

type WeightedHeatImputer

type WeightedHeatImputer struct {
	EmptyLeafHeat float64
}

WeightedHeatImputer will make color of parent to weighted sum of colors of its children.

func (WeightedHeatImputer) ImputeHeat

func (s WeightedHeatImputer) ImputeHeat(t Tree)

func (WeightedHeatImputer) ImputeHeatNode

func (s WeightedHeatImputer) ImputeHeatNode(t Tree, node string)