Skip to content

Commit dc0c5d7

Browse files
committed
improve streamtube attr descriptions
1 parent 62b90b5 commit dc0c5d7

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

src/traces/streamtube/attributes.js

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ var attrs = {
2121
valType: 'data_array',
2222
role: 'info',
2323
editType: 'calc+clearAxisTypes',
24-
description: 'Sets the x coordinates of the vector field'
24+
description: 'Sets the x coordinates of the vector field.'
2525
},
2626
y: {
2727
valType: 'data_array',
2828
role: 'info',
2929
editType: 'calc+clearAxisTypes',
30-
description: 'Sets the y coordinates of the vector field'
30+
description: 'Sets the y coordinates of the vector field.'
3131
},
3232
z: {
3333
valType: 'data_array',
3434
role: 'info',
3535
editType: 'calc+clearAxisTypes',
36-
description: 'Sets the z coordinates of the vector field'
36+
description: 'Sets the z coordinates of the vector field.'
3737
},
3838

3939
u: {
@@ -57,23 +57,20 @@ var attrs = {
5757
editType: 'calc',
5858
description: [
5959
'Sets the x components of the starting position of the streamtubes',
60-
''
6160
].join(' ')
6261
},
6362
starty: {
6463
valType: 'data_array',
6564
editType: 'calc',
6665
description: [
6766
'Sets the y components of the starting position of the streamtubes',
68-
''
6967
].join(' ')
7068
},
7169
startz: {
7270
valType: 'data_array',
7371
editType: 'calc',
7472
description: [
7573
'Sets the z components of the starting position of the streamtubes',
76-
''
7774
].join(' ')
7875
},
7976

src/traces/streamtube/index.js

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,16 @@ module.exports = {
2222

2323
meta: {
2424
description: [
25-
'Use streamtube trace to visualize flow in a vector field',
25+
'Use streamtube trace to visualize flow in a vector fields.',
2626
'',
27-
'....'
27+
'Specify a vector field using 6 1D arrays of equal length,',
28+
'3 position arrays `x`, `y` and `z`',
29+
'and 3 vector component arrays `u`, `v`, `w`.',
30+
'',
31+
'By default, the tubes\' starting positions will be cut from the vector field\'s',
32+
'x-z plane at its minimum y value.',
33+
'To specify your own starting position, use attributes `startx`, `starty`',
34+
'and `startz`.'
2835
].join(' ')
2936
}
3037
};

0 commit comments

Comments
 (0)