Skip to content

Commit 31e4e34

Browse files
committed
more comments on (hover|spike)distance and point vs area objects
1 parent eb98c91 commit 31e4e34

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

src/components/fx/layout_attributes.js

+9-2
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,11 @@ module.exports = {
4646
editType: 'none',
4747
description: [
4848
'Sets the default distance (in pixels) to look for data',
49-
'to add hover labels (-1 means no cutoff, 0 means no looking for data)'
49+
'to add hover labels (-1 means no cutoff, 0 means no looking for data).',
50+
'This is only a real distance for hovering on point-like objects,',
51+
'like scatter points. For area-like objects (bars, scatter fills, etc)',
52+
'hovering is on inside the area and off outside, but these objects',
53+
'will not supersede hover on point-like objects in case of conflict.'
5054
].join(' ')
5155
},
5256
spikedistance: {
@@ -57,7 +61,10 @@ module.exports = {
5761
editType: 'none',
5862
description: [
5963
'Sets the default distance (in pixels) to look for data to draw',
60-
'spikelines to (-1 means no cutoff, 0 means no looking for data).'
64+
'spikelines to (-1 means no cutoff, 0 means no looking for data).',
65+
'As with hoverdistance, distance does not apply to area-like objects.',
66+
'In addition, some objects can be hovered on but will not generate',
67+
'spikelines, such as scatter fills.'
6168
].join(' ')
6269
},
6370
hoverlabel: {

0 commit comments

Comments
 (0)