https://github.com/nodesource/deep-partition-layout
A fork of d3's partition layout which includes the values of inner nodes in its final sums
https://github.com/nodesource/deep-partition-layout
Last synced: 8 months ago
JSON representation
A fork of d3's partition layout which includes the values of inner nodes in its final sums
- Host: GitHub
- URL: https://github.com/nodesource/deep-partition-layout
- Owner: nodesource
- License: mit
- Archived: true
- Created: 2015-09-28T08:02:13.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-16T21:24:14.000Z (almost 10 years ago)
- Last Synced: 2025-02-25T21:37:00.701Z (11 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 2
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# deep-partition-layout
A fork of [d3](http://github.com/mbostock/d3)'s [partition layout](https://github.com/d3/d3-hierarchy/blob/master/src/partition.js) which includes the values of inner nodes in its final sums.
## Usage
### `partition = Partition()`
Creates a new partition layout instance.
### `partition.children([children])`
If children is specified, sets the specified children accessor function. If children is not specified, returns the current children accessor function, which by default assumes that the input data is an object with a children array:
``` javascript
function children(d) {
return d.children
}
```
### `partition.value([value])`
If value is specified, sets the value accessor to the specified function. If value is not specified, returns the current value accessor, which assumes that the input data is an object with a numeric value attribute:
``` javascript
function value(d) {
return d.value
}
```
***Note:*** *multiple calls to `partition.nodes` on the same root node will result in re-accummulating each node's values. It's wise to have your `value` accessor set to something other than the default to avoid unexpected results.*
### `partition.sort([comparator])`
If comparator is specified, sets the sort order of sibling nodes for the layout using the specified comparator function. If comparator is not specified, returns the current group sort order, which defaults to descending order by the associated input data's numeric value attribute:
``` javascript
function comparator(a, b) {
return b.value - a.value
}
```
### `partition.size([size])`
If size is specified, sets the available layout size to the specified two-element array of numbers representing x and y.
``` javascript
import Partition from 'deep-partition-layout'
const width = 320
const height = 240
const partition = Partition()
.size([width, height])
```
### `partition.nodes(root)`
Runs the partition layout, returning the array of nodes associated with the specified root node. In the process of doing so, the following properties will be added to each node in your tree:
* `parent`: the parent node, or null for the root.
* `children`: the array of child nodes, or null for leaf nodes.
* `value`: the node value, as returned by the value accessor.
* `depth`: the depth of the node, starting at 0 for the root.
* `x`: the minimum x-coordinate of the node position.
* `y`: the minimum y-coordinate of the node position.
* `dx`: the x-extent of the node position.
* `dy`: the y-extent of the node position.
## Authors and Contributors
Hugh KennedyGitHub/hughskTwitter/@hughskennedy
Contributions are welcomed from anyone wanting to improve this project!
## License & Copyright
**deep-partition-layout** is Copyright (c) 2015 NodeSource and licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included [LICENSE.md](./LICENSE.md) file for more details.