New 2017-Oct-16: master is now webtreemap v2, a complete rewrite with bug fixes, more features, and a different (simpler) API. If you're looking for the old webtreemap, see the v1 branch.
A simple treemap implementation using web technologies (DOM nodes, CSS styling and transitions) rather than a big canvas/svg/plugin. It's usable as a library as part of a larger web app, but it also includes a command-line app that dumps a self-contained HTML file that displays a map.
Play with a demo.
The data format is a tree of
Node, where each node is an object in the shape
described at the top of tree.ts.
<script src='webtreemap.js'></script> <script> // Container must have its own width/height. const container = document.getElementById('myContainer'); // See typings for full API definition. webtreemap.render(container, data, options);
$ npm i webtreemap
Then run with:
$ webtreemap -o output_file < my_data
Input data format is space-separated lines of "size path", where size is a number and path is a '/'-delimited path. For example:
$ cat my_data 100 all 50 all/thing1 25 all/thing2
This is exactly the output produced by
du, so this works:
$ du -ab some_path | webtreemap -o out.html
But note that there's nothing file-system-specific about the data format -- it just uses slash as a nesting delimiter.
The modules of webtreemap can be used both from the web and from the command line, so the build has two layers. The command line app embeds the output of the build into its output so it's a bit confusing.
To build everything, run
yarn run build.
To hack on webtreemap, the pieces of the build are:
yarn run tscbuilds all the
yarn run webpackbuilds the UMD web version from JS of the above.
Because command line embeds the web version in its output, you need to run step 2 before running the output of step 1. Also note we intentionally don't use webpack's ts-loader because we want the TypeScript output for the command-line app.
Command line app
yarn run tsc -w to keep the npm-compatible JS up to date, then run e.g.:
$ du -ab node_modules/ | node build/src/cli.js --title 'node_modules usage' -o demo.html
webtreemap is licensed under the Apache License v2.0. See
LICENSE.txt for the
complete license text.