revise attributes

Author: archmoj

Diff for: src/components/fx/hover.js

@@ -692,7 +692,7 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
     gd._spikepoints = newspikepoints;
 
     var sortHoverData = function() {
-        if(!hoversubplots) {
+        if(hoversubplots !== 'axis') {
             hoverData.sort(function(d1, d2) { return d1.distance - d2.distance; });
         }
 

Diff for: src/components/fx/layout_attributes.js

@@ -80,13 +80,14 @@ module.exports = {
     },
     hoversubplots: {
         valType: 'enumerated',
-        values: ['axis', false],
-        dflt: false,
+        values: ['overlaying', 'axis'],
+        dflt: 'overlaying',
         editType: 'none',
         description: [
             'Determines expansion of hover effects to other subplots',
-            'If *axis*, points from subplots linked to the axis of hovered subplot are included.',
-            'Has an effect only when `hovermode` is set to *x*, *x unified*, *y* or *y unified*.',
+            'If *overlaying* all subplots using the main axis and occupying the same space are included.',
+            'If *axis*, also include stacked subplots using the same axis',
+            'when `hovermode` is set to *x*, *x unified*, *y* or *y unified*.',
         ].join(' ')
     },
     hoverdistance: {

Diff for: test/plot-schema.json

@@ -2635,13 +2635,13 @@
     ]
    },
    "hoversubplots": {
-    "description": "Determines expansion of hover effects to other subplots If *axis*, points from subplots linked to the axis of hovered subplot are included. Has an effect only when `hovermode` is set to *x*, *x unified*, *y* or *y unified*.",
-    "dflt": false,
+    "description": "Determines expansion of hover effects to other subplots If *overlaying* all subplots using the main axis and occupying the same space are included. If *axis*, also include stacked subplots using the same axis when `hovermode` is set to *x*, *x unified*, *y* or *y unified*.",
+    "dflt": "overlaying",
     "editType": "none",
     "valType": "enumerated",
     "values": [
-     "axis",
-     false
+     "overlaying",
+     "axis"
     ]
    },
    "images": {