Skip to content

Commit

Permalink
Update treemap docs (#1044)
Browse files Browse the repository at this point in the history
  • Loading branch information
mcnuttandrew committed Nov 21, 2018
1 parent 5e763bb commit 398d99e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/treemap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ relative information, such as nested-part-to-whole relationships in a easy to gr
The `treemap` in react-vis builds a series of nested divs (allow for easy and highly restyleable trees). We offer ten different layout
strategies, enabling the construction of standard treemaps, circle packed treemaps, and partition trees (also called icicle diagrams).

Our treemap can target SVG or pure dom (via the renderMode prop)! You can play with the representation above.

## Usage

Import the `treemap` component:
Expand Down Expand Up @@ -180,6 +182,14 @@ Type: `string`

This modifies the tiling strategy for the treemap, for more information see the [d3 hierarchy docs](https://github.com/d3/d3-hierarchy).

#### renderMode

Type: `string`

- One of 'SVG', or 'DOM'

Determines which type of rendering to use for the treemap.

#### sortFunction (optional)

Type: `function`
Expand Down

0 comments on commit 398d99e

Please sign in to comment.