Skip to content

Commit a7a9528

Browse files
committed
Update attribute description
1 parent ade0021 commit a7a9528

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/components/legend/attributes.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ module.exports = {
4141
'Sets the max height (in px) of the legend, or max height ratio (reference height * ratio) if less than one.',
4242
'Default value is: 0.5 for horizontal legends; 1 for vertical legends. The minimum allowed height is 30px.',
4343
'For a ratio of 0.5, the legend will take up to 50% of the reference height before displaying a scrollbar.',
44-
'The reference height is the full layout height except for vertically oriented legends with',
45-
'a `yref` of `"paper"`, where the reference height is the plot height.'
44+
'The reference height is the full layout height with the following exception: vertically oriented legends with',
45+
'a `yref` of `"paper"`, unless the legend is located above/below the plot. In this case, the reference height',
46+
'is the plot height.'
4647
].join(' ')
4748
},
4849
borderwidth: {
@@ -243,7 +244,7 @@ module.exports = {
243244
values: ['auto', 'top', 'middle', 'bottom'],
244245
editType: 'legend',
245246
description: [
246-
'Sets the legend\'s vertical position anchor',
247+
'Sets the legend\'s vertical position anchor.',
247248
'This anchor binds the `y` position to the *top*, *middle*',
248249
'or *bottom* of the legend.',
249250
'Value *auto* anchors legends at their bottom for `y` values less than or equal to 1/3,',

0 commit comments

Comments
 (0)