kwolo.treemap.net 1.0.1

Treemap Algorithms .Net

This project is based on the Java sources published by the University of Maryland See http://www.cs.umd.edu/hcil/treemap/ for more info on the original projects.

Compatibility

The project was built and tested using C# on dotnet core 3.1

License

See License.md for information on licensing and intellectual property rights.

Brief intro

See the original site for more detailed info but, in brief:

1. Create a list of IMappable objects and set their sizes
2. Create a new root TreeModel, passing it the root item
3. Add child IMappable as new TreeModel objects to the root, using its addChild() method
4. Get the tree model to lay out its children, by calling the root's getTreeItems() method
5. Create a new SquarifiedLayout object
6. Call layout() on the SquarifiedLayout object, passing the mappable items from #4 and the bounding rectangle

For example:

private static TreeModel BuildTreeModel(IMappable data)
{
    return AddTree(data, 0);
}

private static TreeModel AddTree(IMappable item, int depth)
{
    item.setDepth(depth);
    var tree = new TreeModel(item);

    // The assumption here is that the item inherits from IMappable
    // and has a list of children

    item.Children.ForEach(c =>
        tree.addChild(
            AddTree(c, depth + 1)
        ));

    return tree;
}

var data = GetSomeData() // Inherits from IMappable, with child objects
var tree = BuildTreeModel(data);
var bounds = new Rect(0, 0, BoundsWidth, BoundsHeight);
var layout = new SquarifiedLayout();
tree.layout(layout, bounds);

See the Integration Tests for a more complete example.