Skip to content

Commit 01e15b4

Browse files
committed
improve barpolar attribute descriptions
1 parent e6c4dad commit 01e15b4

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

src/traces/barpolar/attributes.js

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
'use strict';
1010

11+
var extendFlat = require('../../lib/extend').extendFlat;
1112
var scatterPolarAttrs = require('../scatterpolar/attributes');
1213
var barAttrs = require('../bar/attributes');
1314

@@ -28,11 +29,34 @@ module.exports = {
2829
// description: 'Sets the orientation of the bars.'
2930
// },
3031

31-
base: barAttrs.base,
32-
offset: barAttrs.offset,
33-
width: barAttrs.width,
32+
base: extendFlat({}, barAttrs.base, {
33+
description: [
34+
'Sets where the bar base is drawn (in radial axis units).',
35+
'In *stack* barmode,',
36+
'traces that set *base* will be excluded',
37+
'and drawn in *overlay* mode instead.'
38+
].join(' ')
39+
}),
40+
offset: extendFlat({}, barAttrs.offset, {
41+
description: [
42+
'Shifts the angular position where the bar is drawn',
43+
'(in *thetatunit* units).'
44+
].join(' ')
45+
}),
46+
width: extendFlat({}, barAttrs.width, {
47+
description: [
48+
'Sets the bar angular width (in *thetaunit* units).'
49+
].join(' ')
50+
}),
3451

35-
text: barAttrs.text,
52+
text: extendFlat({}, barAttrs.text, {
53+
description: [
54+
'Sets hover text elements associated with each bar.',
55+
'If a single string, the same string appears over all bars.',
56+
'If an array of string, the items are mapped in order to the',
57+
'this trace\'s coordinates.'
58+
].join(' ')
59+
}),
3660
// hovertext: barAttrs.hovertext,
3761

3862
// textposition: {},

0 commit comments

Comments
 (0)