Skip to content

update description for violin.scalegroup #3687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2019
Merged

update description for violin.scalegroup #3687

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/traces/violin/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,17 @@ module.exports = {
x: boxAttrs.x,
x0: boxAttrs.x0,
y0: boxAttrs.y0,
name: boxAttrs.name,
name: extendFlat({}, boxAttrs.name, {
description: [
'Sets the trace name.',
'The trace name appear as the legend item and on hover.',
'For violin traces, the name will also be used for the position',
'coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are',
'missing and the position axis is categorical.',
'Note that the trace name is also used as a default value',
'for attribute `scalegroup` (please see its description for details).'
].join(' ')
}),
orientation: extendFlat({}, boxAttrs.orientation, {
description: [
'Sets the orientation of the violin(s).',
Expand Down Expand Up @@ -44,7 +54,9 @@ module.exports = {
description: [
'If there are multiple violins that should be sized according to',
'to some metric (see `scalemode`), link them by providing a non-empty group id here',
'shared by every trace in the same group.'
'shared by every trace in the same group.',
'If a violin\'s `width` is undefined, `scalegroup` will default to the trace\'s name.',
'In this case, violins with the same names will be linked together'
].join(' ')
},
scalemode: {
Expand Down