Skip to content

Commit 8182cab

Browse files
committed
comment out 'sizemode' (for now)
- `absoluteTubeSize` doesn't behave well enough for our needs. - leave 'fixed' as open item
1 parent c40dd6b commit 8182cab

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

src/traces/streamtube/attributes.js

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,23 @@ var attrs = {
7878
},
7979

8080
// TODO
81+
//
82+
// Should add 'absolute' (like cone traces have), but currently gl-streamtube3d's
83+
// `absoluteTubeSize` doesn't behave well enough for our needs.
84+
//
85+
// 'fixed' would be a nice addition to plot stream 'lines', see
86+
// https://github.com/plotly/plotly.js/commit/812be20750e21e0a1831975001c248d365850f73#r29129877
87+
//
88+
// sizemode: {
89+
// valType: 'enumerated',
90+
// values: ['scaled', 'absolute', 'fixed'],
91+
// dflt: 'scaled',
92+
// role: 'info',
93+
// editType: 'calc',
94+
// description: [
95+
// 'Sets the mode by which the streamtubes are sized.'
96+
// ].join(' ')
97+
// },
8198
// maxLength
8299

83100
sizeref: {
@@ -86,7 +103,11 @@ var attrs = {
86103
editType: 'calc',
87104
min: 0,
88105
dflt: 1,
89-
description: ''
106+
description: [
107+
'The scaling factor for the streamtubes.',
108+
'The default is 1, which avoids two max divergence tubes from touching',
109+
'at adjacent starting positions.'
110+
].join(' ')
90111
},
91112

92113
text: {

src/traces/streamtube/defaults.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
4040

4141
// TODO adapt these
4242
// coerce('maxLength');
43-
// coerce('sizemode');
4443

4544
coerce('sizeref');
4645

0 commit comments

Comments
 (0)