Skip to content

Commit 7140c3e

Browse files
docs(icicle): clarify the description; set default to 0
1 parent c57dda5 commit 7140c3e

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

src/traces/icicle/attributes.js

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,29 @@ module.exports = {
2929
dflt: 'h',
3030
editType: 'plot',
3131
description: [
32-
'Sets the orientation of the icicle.',
33-
'With *v* the icicle grows vertically.',
34-
'With *h* the icicle grows horizontally.',
32+
'When set in conjunction with `tiling.flip`, determines on',
33+
'which side the root nodes are drawn in the chart. If',
34+
'`tiling.orientation` is *v* and `tiling.flip` is **, the root',
35+
'nodes appear at the top. If `tiling.orientation` is *v* and',
36+
'`tiling.flip` is *y*, the root nodes appear at the bottom. If',
37+
'`tiling.orientation` is *h* and `tiling.flip` is **, the',
38+
'root nodes appear at the left. If `tiling.orientation` is *h*',
39+
'and `tiling.flip` is *x*, the root nodes appear at the right.',
3540
].join(' ')
3641
},
3742

3843
flip: treemapAttrs.tiling.flip,
3944

40-
pad: treemapAttrs.tiling.pad,
45+
pad: {
46+
valType: 'number',
47+
min: 0,
48+
dflt: 0,
49+
editType: 'plot',
50+
description: [
51+
'Sets the inner padding (in px).'
52+
].join(' ')
53+
},
54+
4155

4256
editType: 'calc',
4357
},

0 commit comments

Comments
 (0)