@@ -16,7 +16,17 @@ module.exports = {
16
16
x : boxAttrs . x ,
17
17
x0 : boxAttrs . x0 ,
18
18
y0 : boxAttrs . y0 ,
19
- name : boxAttrs . name ,
19
+ name : extendFlat ( { } , boxAttrs . name , {
20
+ description : [
21
+ 'Sets the trace name.' ,
22
+ 'The trace name appear as the legend item and on hover.' ,
23
+ 'For violin traces, the name will also be used for the position' ,
24
+ 'coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are' ,
25
+ 'missing and the position axis is categorical.' ,
26
+ 'Note that the trace name is also used as a default value' ,
27
+ 'for attribute `scalegroup` (please see its description for details).'
28
+ ] . join ( ' ' )
29
+ } ) ,
20
30
orientation : extendFlat ( { } , boxAttrs . orientation , {
21
31
description : [
22
32
'Sets the orientation of the violin(s).' ,
@@ -44,7 +54,9 @@ module.exports = {
44
54
description : [
45
55
'If there are multiple violins that should be sized according to' ,
46
56
'to some metric (see `scalemode`), link them by providing a non-empty group id here' ,
47
- 'shared by every trace in the same group.'
57
+ 'shared by every trace in the same group.' ,
58
+ 'If a violin\'s `width` is undefined, `scalegroup` will default to the trace\'s name.' ,
59
+ 'In this case, violins with the same names will be linked together'
48
60
] . join ( ' ' )
49
61
} ,
50
62
scalemode : {
0 commit comments