toggle-corp/react-store

View on GitHub
docs/components/Visualization/CollapsibleTree.md

Summary

Maintainability
Test Coverage
`CollapsibleTree` (component)
=============================

CollapsibleTree is a tree diagram showing the hierarchical structure of the data

Props
-----

### `boundingClientRect` (required)

Size of the parent element/component (passed by the Responsive hoc)

type: `shape[object Object]`


### `childrenSelector`

Accessor function to return children of node

type: `func`
defaultValue: `d => d.children`


### `className`

Additional css classes passed from parent

type: `string`
defaultValue: `''`


### `colorScheme`

Array of colors as hex color codes

type: `arrayOf[object Object]`
defaultValue: `schemePaired`


### `data`

Hierarchical data structure that can be computed to form a hierarchical layout
<a href="https://github.com/d3/d3-hierarchy">d3-hierarchy</a>

type: `shape[object Object]`
defaultValue: `[]`


### `labelSelector` (required)

Select label for each node

type: `func`


### `margins`

Margins for the chart

type: `shape[object Object]`
defaultValue: `{
    top: 0,
    right: 0,
    bottom: 0,
    left: 0,
}`


### `nodeSize`

Cluster layout's node size
<a href="https://github.com/d3/d3-hierarchy#cluster_nodeSize">nodeSize</a>

type: `arrayOf[object Object]`
defaultValue: `[50, 300]`


### `setSaveFunction`

Handle save functionality

type: `func`
defaultValue: `() => {}`