Skip to content

Commit 5be9c36

Browse files
committed
reorder box attributes + make notched role: 'info'
1 parent 4805faa commit 5be9c36

File tree

1 file changed

+54
-44
lines changed

1 file changed

+54
-44
lines changed

src/traces/box/attributes.js

+54-44
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ module.exports = {
5252
'See overview for more info.'
5353
].join(' ')
5454
},
55+
5556
name: {
5657
valType: 'string',
5758
role: 'info',
@@ -64,40 +65,10 @@ module.exports = {
6465
'missing and the position axis is categorical'
6566
].join(' ')
6667
},
67-
text: extendFlat({}, scatterAttrs.text, {
68-
description: [
69-
'Sets the text elements associated with each sample value.',
70-
'If a single string, the same string appears over',
71-
'all the data points.',
72-
'If an array of string, the items are mapped in order to the',
73-
'this trace\'s (x,y) coordinates.',
74-
'To be seen, trace `hoverinfo` must contain a *text* flag.'
75-
].join(' ')
76-
}),
77-
hovertext: extendFlat({}, scatterAttrs.hovertext, {
78-
description: 'Same as `text`.'
79-
}),
80-
hovertemplate: hovertemplateAttrs({
81-
description: [
82-
'N.B. This only has an effect when hovering on points.'
83-
].join(' ')
84-
}),
85-
whiskerwidth: {
86-
valType: 'number',
87-
min: 0,
88-
max: 1,
89-
dflt: 0.5,
90-
role: 'style',
91-
editType: 'calc',
92-
description: [
93-
'Sets the width of the whiskers relative to',
94-
'the box\' width.',
95-
'For example, with 1, the whiskers are as wide as the box(es).'
96-
].join(' ')
97-
},
68+
9869
notched: {
9970
valType: 'boolean',
100-
role: 'style',
71+
role: 'info',
10172
editType: 'calc',
10273
description: [
10374
'Determines whether or not notches are drawn.',
@@ -121,6 +92,7 @@ module.exports = {
12192
'For example, with 0, the notches are as wide as the box(es).'
12293
].join(' ')
12394
},
95+
12496
boxpoints: {
12597
valType: 'enumerated',
12698
values: ['all', 'outliers', 'suspectedoutliers', false],
@@ -137,18 +109,6 @@ module.exports = {
137109
'If *false*, only the box(es) are shown with no sample points'
138110
].join(' ')
139111
},
140-
boxmean: {
141-
valType: 'enumerated',
142-
values: [true, 'sd', false],
143-
dflt: false,
144-
role: 'style',
145-
editType: 'calc',
146-
description: [
147-
'If *true*, the mean of the box(es)\' underlying distribution is',
148-
'drawn as a dashed line inside the box(es).',
149-
'If *sd* the standard deviation is also drawn.'
150-
].join(' ')
151-
},
152112
jitter: {
153113
valType: 'number',
154114
min: 0,
@@ -175,6 +135,20 @@ module.exports = {
175135
'right (left) for vertical boxes and above (below) for horizontal boxes'
176136
].join(' ')
177137
},
138+
139+
boxmean: {
140+
valType: 'enumerated',
141+
values: [true, 'sd', false],
142+
dflt: false,
143+
role: 'style',
144+
editType: 'calc',
145+
description: [
146+
'If *true*, the mean of the box(es)\' underlying distribution is',
147+
'drawn as a dashed line inside the box(es).',
148+
'If *sd* the standard deviation is also drawn.'
149+
].join(' ')
150+
},
151+
178152
orientation: {
179153
valType: 'enumerated',
180154
values: ['v', 'h'],
@@ -270,6 +244,7 @@ module.exports = {
270244
},
271245
editType: 'plot'
272246
},
247+
273248
line: {
274249
color: {
275250
valType: 'color',
@@ -287,8 +262,23 @@ module.exports = {
287262
},
288263
editType: 'plot'
289264
},
265+
290266
fillcolor: scatterAttrs.fillcolor,
291267

268+
whiskerwidth: {
269+
valType: 'number',
270+
min: 0,
271+
max: 1,
272+
dflt: 0.5,
273+
role: 'style',
274+
editType: 'calc',
275+
description: [
276+
'Sets the width of the whiskers relative to',
277+
'the box\' width.',
278+
'For example, with 1, the whiskers are as wide as the box(es).'
279+
].join(' ')
280+
},
281+
292282
offsetgroup: barAttrs.offsetgroup,
293283
alignmentgroup: barAttrs.alignmentgroup,
294284

@@ -300,6 +290,26 @@ module.exports = {
300290
marker: scatterAttrs.unselected.marker,
301291
editType: 'style'
302292
},
293+
294+
text: extendFlat({}, scatterAttrs.text, {
295+
description: [
296+
'Sets the text elements associated with each sample value.',
297+
'If a single string, the same string appears over',
298+
'all the data points.',
299+
'If an array of string, the items are mapped in order to the',
300+
'this trace\'s (x,y) coordinates.',
301+
'To be seen, trace `hoverinfo` must contain a *text* flag.'
302+
].join(' ')
303+
}),
304+
hovertext: extendFlat({}, scatterAttrs.hovertext, {
305+
description: 'Same as `text`.'
306+
}),
307+
hovertemplate: hovertemplateAttrs({
308+
description: [
309+
'N.B. This only has an effect when hovering on points.'
310+
].join(' ')
311+
}),
312+
303313
hoveron: {
304314
valType: 'flaglist',
305315
flags: ['boxes', 'points'],

0 commit comments

Comments
 (0)