File tree Expand file tree Collapse file tree 1 file changed +4
-3
lines changed Expand file tree Collapse file tree 1 file changed +4
-3
lines changed Original file line number Diff line number Diff line change @@ -14,11 +14,10 @@ modules, use as you would anything else.
14
14
import TreeMap from ' replot-treemap'
15
15
```
16
16
17
- ## API
17
+ ## Quick Start
18
18
replot-treemap is designed to create beautiful treemaps right out of the box.
19
19
The only * required* input is properly formatted data.
20
20
21
- ### Basic Usage
22
21
In the simplest case, just supply data (as a Javascript array) and specify the
23
22
keys for the titles and weights -:
24
23
@@ -41,7 +40,7 @@ render() {
41
40
- ` titleKey ` defaults to ` "title" `
42
41
- ` weightKey ` defaults to ` "weight" `
43
42
44
- ### Advanced Usage - Nesting
43
+ ### Nesting
45
44
Replot treemaps are able to display nested data, as long as the structure of the
46
45
data is an proper flat format. If flat nested data is supplied, a ` keyOrder `
47
46
prop, which details titleKeys at various levels in the form of a Javascript
@@ -72,6 +71,8 @@ render() {
72
71
}
73
72
```
74
73
74
+ ## API
75
+
75
76
### Dimensions
76
77
Dimensions may be specified by passing in ` width ` and ` height ` props. The
77
78
unit is pixels, and the treemap defaults to 800 by 400 pixels.
You can’t perform that action at this time.
0 commit comments