unifiedhovertemplate > unifiedhovertitle

Author: archmoj

draftlogs/7439_add.md

@@ -1 +1 @@
- - Add unifiedhovertemplate to format unified hover title [[#7439](https://github.com/plotly/plotly.js/pull/7439)]
+ - Add unifiedhovertitle to format unified hover title [[#7439](https://github.com/plotly/plotly.js/pull/7439)]

src/components/fx/hover.js

@@ -1214,14 +1214,14 @@ function createHoverText(hoverData, opts) {
 
         var item0 = groupedHoverData[0];
 
-        var unifiedhovertemplate = (
+        var unifiedhovertitle = (
             hovermode === 'x unified' ?
                 item0.xa :
                 item0.ya
-            ).unifiedhovertemplate;
+            ).unifiedhovertitle;
 
-        var mainText = !unifiedhovertemplate ? t0 :
-            Lib.hovertemplateString(unifiedhovertemplate, {}, fullLayout._d3locale,
+        var mainText = !unifiedhovertitle ? t0 :
+            Lib.hovertemplateString(unifiedhovertitle, {}, fullLayout._d3locale,
                 hovermode === 'x unified' ?
                     {xa: item0.xa, x: item0.xVal} :
                     {ya: item0.ya, y: item0.yVal}

src/plots/cartesian/axis_defaults.js

@@ -102,7 +102,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
 
     if(!options.noHover) {
         if(axType !== 'category') coerce('hoverformat');
-        if(!options.noUnifiedhovertemplate) coerce('unifiedhovertemplate');
+        if(!options.noUnifiedhovertitle) coerce('unifiedhovertitle');
     }
 
     var dfltColor = coerce('color');

src/plots/cartesian/layout_attributes.js

@@ -976,7 +976,7 @@ module.exports = {
         editType: 'none',
         description: descriptionWithDates('hover text')
     },
-    unifiedhovertemplate: {
+    unifiedhovertitle: {
         valType: 'string',
         dflt: '',
         editType: 'none',

src/plots/gl3d/layout/axis_defaults.js

@@ -51,7 +51,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, options) {
                 noTicklabelposition: true,
                 noTicklabeloverflow: true,
                 noInsiderange: true,
-                noUnifiedhovertemplate: true,
+                noUnifiedhovertitle: true,
                 bgColor: options.bgColor,
                 calendar: options.calendar
             },

test/jasmine/tests/hover_label_test.js

@@ -6902,7 +6902,7 @@ describe('hovermode: (x|y)unified', function() {
             .then(done, done.fail);
     });
 
-    it('should format title of unified hover in respect to `unifiedhovertemplate` linear axis', function(done) {
+    it('should format title of unified hover in respect to `unifiedhovertitle` linear axis', function(done) {
         Plotly.newPlot(gd, [{
             type: 'bar',
             y: [1, 2, 3]
@@ -6911,7 +6911,7 @@ describe('hovermode: (x|y)unified', function() {
             y: [2, 3, 1]
         }], {
             xaxis: {
-                unifiedhovertemplate: 'X: %{x:.2f}',
+                unifiedhovertitle: 'X: %{x:.2f}',
             },
             hovermode: 'x unified',
             showlegend: false,
@@ -6934,7 +6934,7 @@ describe('hovermode: (x|y)unified', function() {
         .then(done, done.fail);
     });
 
-    it('should format title of unified hover in respect to `unifiedhovertemplate` date axis', function(done) {
+    it('should format title of unified hover in respect to `unifiedhovertitle` date axis', function(done) {
         Plotly.newPlot(gd, [{
             type: 'bar',
             x: ['2000-01-01', '2000-02-01', '2000-03-01'],
@@ -6946,7 +6946,7 @@ describe('hovermode: (x|y)unified', function() {
         }], {
             xaxis: {
                 type: 'date',
-                unifiedhovertemplate: 'X: %{x|%x %X}',
+                unifiedhovertitle: 'X: %{x|%x %X}',
             },
             hovermode: 'x unified',
             showlegend: false,

test/plot-schema.json

@@ -14949,7 +14949,7 @@
      "editType": "none",
      "valType": "any"
     },
-    "unifiedhovertemplate": {
+    "unifiedhovertitle": {
      "description": "Template string used for rendering the title that appear on x or y unified hover box. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax.",
      "dflt": "",
      "editType": "none",
@@ -16199,7 +16199,7 @@
      "editType": "none",
      "valType": "any"
     },
-    "unifiedhovertemplate": {
+    "unifiedhovertitle": {
      "description": "Template string used for rendering the title that appear on x or y unified hover box. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax.",
      "dflt": "",
      "editType": "none",