Skip to content

Commit f722c5d

Browse files
committed
transforms: fill in groupby descriptions
1 parent 0e1e9a7 commit f722c5d

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

src/transforms/groupby.js

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,31 @@ exports.name = 'groupby';
1717
exports.attributes = {
1818
active: {
1919
valType: 'boolean',
20-
dflt: true
20+
dflt: true,
21+
description: [
22+
'Toggles whether or not the filter is active.'
23+
].join(' ')
2124
},
2225
groups: {
2326
valType: 'data_array',
24-
dflt: []
27+
dflt: [],
28+
description: [
29+
'Sets the groups in which the trace data will be split.',
30+
'For example, with `x` set to *[1, 2, 3, 4]* and',
31+
'`groups` set to *[\'a\', \'b\', \'a\', \'b\']*,',
32+
'the groupby transform with split in one trace',
33+
'with `x` [1, 3] and one trace with `x` [2, 4].'
34+
].join(' ')
2535
},
2636
style: {
2737
valType: 'any',
28-
dflt: {}
38+
dflt: {},
39+
description: [
40+
'Sets each group style.',
41+
'For example, with `groups` set to *[\'a\', \'b\', \'a\', \'b\']*',
42+
'and `style` set to *{ a: { marker: { color: \'red\' } }}',
43+
'marker points in group *\'a\'* will be drawn in red.'
44+
].join(' ')
2945
}
3046
};
3147

0 commit comments

Comments
 (0)