https://github.com/nikolaydubina/treemap
🍬 Pretty Treemaps
https://github.com/nikolaydubina/treemap
command-line-tool data-visualization graph heatmap tree
Last synced: 7 months ago
JSON representation
🍬 Pretty Treemaps
- Host: GitHub
- URL: https://github.com/nikolaydubina/treemap
- Owner: nikolaydubina
- Created: 2021-12-03T12:01:16.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T13:05:21.000Z (8 months ago)
- Last Synced: 2025-04-09T23:13:54.314Z (7 months ago)
- Topics: command-line-tool, data-visualization, graph, heatmap, tree
- Language: Go
- Homepage:
- Size: 5.88 MB
- Stars: 158
- Watchers: 6
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# 🍬 Pretty Treemaps
> _Looking to run this for Go coverage? Check https://github.com/nikolaydubina/go-cover-treemap_
[](https://pkg.go.dev/github.com/nikolaydubina/treemap)
[](https://codecov.io/gh/nikolaydubina/treemap)
[](https://goreportcard.com/report/github.com/nikolaydubina/treemap)
[](https://securityscorecards.dev/viewer/?uri=github.com/nikolaydubina/treemap)
Uses "Squarified Treemaps" (Mark Bruls, Kees Huizing, and Jarke J. van Wijk., 2000) algorithm.
```bash
$ 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
```bash
$ ... | treemap -w 1080 -h 360 > out.svg
```
```bash
$ ... | treemap -w 1080 -h 1080 > out.svg
```
Imputing heat
```bash
$ ... | treemap -impute-heat > out.svg
```
Different colorscheme
```bash
$ ... | treemap -color RdYlGn > out.svg
```
Tree-Hue coloring when there is no heat
```
$ ... | treemap -color balanced > out.svg
```
Without color
```bash
$ ... | treemap -color none > out.svg
```
## Format
Size and heat is optional.
```
delimitered path>,,
```
## 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`)
```bash
$ ... | treemap -w 4096 -h 4096 > out.svg
```
## Appendix C: Known Issues
### The entire treemap is a black box when viewed from Jenkins
It's convenient to create treemap svg reports in a Jenkins jobs, because you can
browse the job's "artifacts" from your browser. However, out of the box, Jenkin's
[Content Security Policy](https://www.jenkins.io/doc/book/security/configuring-content-security-policy/)
prevents inline styles from being applied. Instead of your treemap, you'll see
a giant black rectangle.
If you look at the javascript console in the developer tools, you will see:
```
Refused to apply inline style because it violates the following
Content Security Policy directive: "style-src 'self'".
```
You can relax Jenkin's CSP rules by following the examples at:
* [Jenkins error - Blocked script execution in . because the document's frame is sandboxed and the 'allow-scripts' permission is not set](https://stackoverflow.com/questions/34315723/jenkins-error-blocked-script-execution-in-url-because-the-documents-frame)
* [https://stackoverflow.com/questions/35783964/jenkins-html-publisher-plugin-no-css-is-displayed-when-report-is-viewed-in-j](https://stackoverflow.com/questions/35783964/jenkins-html-publisher-plugin-no-css-is-displayed-when-report-is-viewed-in-j)