README
Yeah, no kidding, you give me a range (width & height) and reference lines, and I'll give you blocks, the same as cutting the cake! :fork_and_knife: :cake:
slices
Node.js module for slicing given area into blocks with the given reference lines
var Slices = require('slices');
var blocks = Slices(500, 500, [100], [100]);
Get blocks:
[
{ width: 100, height: 100, x: 0, y: 0 },
{ width: 400, height: 100, x: 100, y: 0 },
{ width: 100, height: 400, x: 0, y: 100 },
{ width: 400, height: 400, x: 100, y: 100 }
]
Installation
npm install slices
API
Slices(width, height, lineXArray, lineYArray [, options])
- width: Number of pixels wide
- height: Number of pixels high
- lineXArray: reference lines of the X axis
- lineYArray: reference lines of the Y axis
- options: slice with some optional parameters, see options for detail.
Options
middleBoundaryMode
Either true or false, default is false.
If set to true, this will put spaces between each two lines of X axis as parent-block, the areas between the first line of Y axis and the last will be children of the parent-block, and it will generate boundary data.
Below is an example:
Slices(500, 500, [100, 300], [100, 200, 300], {middleBoundaryMode: true});
Get blocks like below:
[
{
"width": 500,
"height": 100,
"x": 0,
"y": 0,
"children": [
{
"width": 100,
"height": 100,
"x": 100,
"y": 0,
"left": 0,
"top": 0,
"parentBlockIndex": 0,
"index": 0
},
{
"width": 100,
"height": 100,
"x": 200,
"y": 0,
"left": 100,
"top": 0,
"parentBlockIndex": 0,
"index": 1
}
],
"boundary": {
"leftTop": {
"x": 100,
"y": 0
},
"rightBottom": {
"x": 300,
"y": 100
}
}
},
...
]
Where is this library used?
If you are using this library in one of your projects, add it in this list :)
Testing
npm test
License
MIT, see the LICENSE file for detail.