layout
Organize and layout items based on various algorithms
Getting Started
Install the module with: npm install layout
// Load in layoutvar layout = ; // Generate a new layer to organize items onvar layer = ; // Add items that you want to organizelayer;layer;layer; // Export the infovar info = layer'export'; // We get back the width and height of the pack as well as organized items height: 80 width: 40 items: height: 10 width: 10 meta: 'small' x: 0 y: 0 height: 20 width: 10 meta: 'medium' x: 0 y: 10 height: 50 width: 40 meta: 'large' x: 0 y: 30
Documentation
Layout is a constructor function
/** * Layout adds items in an algorithmic fashion * @constructor * @param * Algorithms available: top-down, left-right, diagonal, alt-diagonal */
Items can be added via addItem
which are required to have a height
and width
. Any additional info should be stored inside of meta
.
/** * @param * @param * @param * @param */
export
is how you take your items and organize them.
/** * @returns * @returns * @returns * @returns */
Custom algorithms
You can add your own algorithm via layout.addAlgorithm
/** * Method to add new algorithms via * @param * @param */
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.
License
Copyright (c) 2012 Todd Wolfson Licensed under the MIT license.