Skip to content

Commit e0e7a1a

Browse files
authored
Merge pull request #3687 from plotly/fix-3653
update description for `violin.scalegroup`
2 parents 7b2946a + 23a1b17 commit e0e7a1a

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

src/traces/violin/attributes.js

+14-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,17 @@ module.exports = {
1616
x: boxAttrs.x,
1717
x0: boxAttrs.x0,
1818
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+
}),
2030
orientation: extendFlat({}, boxAttrs.orientation, {
2131
description: [
2232
'Sets the orientation of the violin(s).',
@@ -44,7 +54,9 @@ module.exports = {
4454
description: [
4555
'If there are multiple violins that should be sized according to',
4656
'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'
4860
].join(' ')
4961
},
5062
scalemode: {

0 commit comments

Comments
 (0)