hovermode -> hoveron

Author: Jon M. Mease

src/traces/parcats/attributes.js

@@ -44,17 +44,17 @@ module.exports = {
         editType: 'plot'
         // plotAttrs.hoverinfo description is appropriate
     }),
-    hovermode: {
+    hoveron: {
         valType: 'enumerated',
         values: ['category', 'color', 'dimension'],
         dflt: 'category',
         role: 'info',
         editType: 'plot',
         description: [
-            'Sets the hover mode of the parcats diagram.',
+            'Sets the hover interaction mode for the parcats diagram.',
             'If `category`, hover interaction take place per category.',
             'If `color`, hover interactions take place per color per category.',
-            'If `dimension`, hover interactions take across all categories per dimension.'
+            'If `dimension`, hover interactions take place across all categories per dimension.'
         ].join(' ')
     },
     arrangement: {

src/traces/parcats/defaults.js

@@ -98,7 +98,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
 
     mergeLength(traceOut, dimensions, 'values', len);
 
-    coerce('hovermode');
+    coerce('hoveron');
     coerce('arrangement');
     coerce('bundlecolors');
     coerce('sortpaths');

src/traces/parcats/parcats.js

@@ -694,7 +694,7 @@ function emitPointsEventColorHovermode(bandElement, eventName, event) {
 }
 
 /**
- * Create hover label for a band element's category (for use when hovermode === 'category')
+ * Create hover label for a band element's category (for use when hoveron === 'category')
  *
  * @param {ClientRect} rootBBox
  *  Client bounding box for root of figure
@@ -755,7 +755,7 @@ function createHoverLabelForCategoryHovermode(rootBBox, bandElement) {
 }
 
 /**
- * Create hover label for a band element's category (for use when hovermode === 'category')
+ * Create hover label for a band element's category (for use when hoveron === 'category')
  *
  * @param {ClientRect} rootBBox
  *  Client bounding box for root of figure
@@ -779,7 +779,7 @@ function createHoverLabelForDimensionHovermode(rootBBox, bandElement) {
 }
 
 /**
- * Create hover labels for a band element's category (for use when hovermode === 'dimension')
+ * Create hover labels for a band element's category (for use when hoveron === 'dimension')
  *
  * @param {ClientRect} rootBBox
  *  Client bounding box for root of figure
@@ -899,13 +899,13 @@ function mouseoverCategoryBand(bandViewModel) {
             var gd = bandViewModel.parcatsViewModel.graphDiv;
             var fullLayout = gd._fullLayout;
             var rootBBox = fullLayout._paperdiv.node().getBoundingClientRect();
-            var hovermode = bandViewModel.parcatsViewModel.hovermode;
+            var hoveron = bandViewModel.parcatsViewModel.hoveron;
 
             /** @type {HTMLElement} */
             var bandElement = this;
 
             // Handle style and events
-            if(hovermode === 'color') {
+            if(hoveron === 'color') {
                 styleForColorHovermode(bandElement);
                 emitPointsEventColorHovermode(bandElement, 'plotly_hover', d3.event);
             } else {
@@ -916,11 +916,11 @@ function mouseoverCategoryBand(bandViewModel) {
             // Handle hover label
             if(bandViewModel.parcatsViewModel.hoverinfoItems.indexOf('none') === -1) {
                 var hoverItems;
-                if(hovermode === 'category') {
+                if(hoveron === 'category') {
                     hoverItems = createHoverLabelForCategoryHovermode(rootBBox, bandElement);
-                } else if(hovermode === 'color') {
+                } else if(hoveron === 'color') {
                     hoverItems = createHoverLabelForColorHovermode(rootBBox, bandElement);
-                } else if(hovermode === 'dimension') {
+                } else if(hoveron === 'dimension') {
                     hoverItems = createHoverLabelForDimensionHovermode(rootBBox, bandElement);
                 }
 
@@ -962,11 +962,11 @@ function mouseoutCategory(bandViewModel) {
         // Emit unhover event
         if(parcatsViewModel.hoverinfoItems.indexOf('skip') === -1) {
 
-            var hovermode = bandViewModel.parcatsViewModel.hovermode;
+            var hoveron = bandViewModel.parcatsViewModel.hoveron;
             var bandElement = this;
 
             // Handle style and events
-            if(hovermode === 'color') {
+            if(hoveron === 'color') {
                 emitPointsEventColorHovermode(bandElement, 'plotly_unhover', d3.event);
             } else {
                 emitPointsEventCategoryHovermode(bandElement, 'plotly_unhover', d3.event);
@@ -1209,7 +1209,7 @@ function dragDimensionEnd(d) {
     // ----------------------------
     if(d.parcatsViewModel.hoverinfoItems.indexOf('skip') === -1) {
         if(!d.dragHasMoved && d.potentialClickBand) {
-            if(d.parcatsViewModel.hovermode === 'color') {
+            if(d.parcatsViewModel.hoveron === 'color') {
                 emitPointsEventColorHovermode(d.potentialClickBand, 'plotly_click', d3.event.sourceEvent);
             } else {
                 emitPointsEventCategoryHovermode(d.potentialClickBand, 'plotly_click', d3.event.sourceEvent);
@@ -1489,7 +1489,7 @@ function createParcatsViewModel(graphDiv, layout, wrappedParcatsModel) {
         y: traceY,
         width: traceWidth,
         height: traceHeight,
-        hovermode: trace.hovermode,
+        hoveron: trace.hoveron,
         hoverinfoItems: hoverinfoItems,
         arrangement: trace.arrangement,
         bundlecolors: trace.bundlecolors,
@@ -1949,8 +1949,8 @@ function createDimensionViewModel(parcatsViewModel, dimensionModel) {
  *  X position of this trace with respect to the Figure (pixels)
  * @property {Number} y
  *  Y position of this trace with respect to the Figure (pixels)
- * @property {String} hovermode
- *  Hover mode. One of: 'none', 'category', 'color', or 'dimension'
+ * @property {String} hoveron
+ *  Hover interaction mode. One of: 'category', 'color', or 'dimension'
  * @property {Array.<String>} hoverinfoItems
  *  Info to display on hover. Array with a combination of 'counts' and/or 'probabilities', or 'none', or 'skip'
  * @property {String} arrangement

test/image/mocks/parcats_hovermode_color.json renamed to test/image/mocks/parcats_hoveron_color.json

@@ -2,7 +2,7 @@
   "data": [
     {"type": "parcats",
       "domain": {"x": [0.125, 0.625],"y": [0.25, 0.75]},
-      "hovermode": "color",
+      "hoveron": "color",
       "hoverinfo": "probability",
       "dimensions":[
         {"label": "One", "values": [1, 1, 2, 1, 2, 1, 1, 2, 1]},

test/image/mocks/parcats_hovermode_dimension.json renamed to test/image/mocks/parcats_hoveron_dimension.json

@@ -2,7 +2,7 @@
   "data": [
     {"type": "parcats",
       "domain": {"x": [0.125, 0.625],"y": [0.25, 0.75]},
-      "hovermode": "dimension",
+      "hoveron": "dimension",
       "hoverinfo": "probability+count",
       "dimensions":[
         {"label": "One", "values": [1, 1, 2, 1, 2, 1, 1, 2, 1]},

test/jasmine/tests/parcats_test.js

@@ -1328,7 +1328,7 @@ describe('Click events', function() {
     });
 });
 
-describe('Click events with hovermode color', function() {
+describe('Click events with hoveron color', function() {
 
     // Variable declarations
     // ---------------------
@@ -1340,7 +1340,7 @@ describe('Click events with hovermode color', function() {
     // --------
     beforeEach(function() {
         gd = createGraphDiv();
-        mock = Lib.extendDeep({}, require('@mocks/parcats_hovermode_color.json'));
+        mock = Lib.extendDeep({}, require('@mocks/parcats_hoveron_color.json'));
     });
 
     afterEach(destroyGraphDiv);
@@ -1583,7 +1583,7 @@ describe('Hover events', function() {
     });
 });
 
-describe('Hover events with hovermode color', function() {
+describe('Hover events with hoveron color', function() {
 
     // Variable declarations
     // ---------------------
@@ -1595,12 +1595,12 @@ describe('Hover events with hovermode color', function() {
     // --------
     beforeEach(function() {
         gd = createGraphDiv();
-        mock = Lib.extendDeep({}, require('@mocks/parcats_hovermode_color.json'));
+        mock = Lib.extendDeep({}, require('@mocks/parcats_hoveron_color.json'));
     });
 
     afterEach(destroyGraphDiv);
 
-    it('hover and unhover should fire on category hovermode color', function(done) {
+    it('hover and unhover should fire on category hoveron color', function(done) {
 
         var hoverData,
             unhoverData,
@@ -1667,7 +1667,7 @@ describe('Hover events with hovermode color', function() {
             .then(done);
     });
 
-    it('hover and unhover should fire on path hovermode color', function(done) {
+    it('hover and unhover should fire on path hoveron color', function(done) {
 
         var hoverData,
             unhoverData,