unifiedhovertitle.text

Author: archmoj

draftlogs/7439_add.md

@@ -1 +1 @@
- - Add unifiedhovertitle to format unified hover title [[#7439](https://github.com/plotly/plotly.js/pull/7439)]
+ - Add `unifiedhovertitle.text` to format unified hover titles [[#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 unifiedhovertitle = (
+        var unifiedhovertitleText = ((
             hovermode === 'x unified' ?
                 item0.xa :
                 item0.ya
-            ).unifiedhovertitle;
+            ).unifiedhovertitle || {}).text;
 
-        var mainText = !unifiedhovertitle ? t0 :
-            Lib.hovertemplateString(unifiedhovertitle, {}, fullLayout._d3locale,
+        var mainText = !unifiedhovertitleText ? t0 :
+            Lib.hovertemplateString(unifiedhovertitleText, {}, 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,9 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
 
     if(!options.noHover) {
         if(axType !== 'category') coerce('hoverformat');
-        if(!options.noUnifiedhovertitle) coerce('unifiedhovertitle');
+        if(!options.noUnifiedhovertitle) {
+            coerce('unifiedhovertitle.text');
+        }
     }
 
     var dfltColor = coerce('color');

src/plots/cartesian/layout_attributes.js

@@ -977,13 +977,16 @@ module.exports = {
         description: descriptionWithDates('hover text')
     },
     unifiedhovertitle: {
-        valType: 'string',
-        dflt: '',
-        editType: 'none',
-        description: [
-            'Template string used for rendering the title that appear on x or y unified hover box.',
-            templateFormatStringDescription()
-        ].join(' ')
+        text : {
+            valType: 'string',
+            dflt: '',
+            editType: 'none',
+            description: [
+                'Template string used for rendering the title that appear on x or y unified hover box.',
+                templateFormatStringDescription()
+            ].join(' ')
+        },
+        editType: 'none'
     },
     // lines and grids
     showline: {

test/jasmine/tests/hover_label_test.js

@@ -6911,7 +6911,7 @@ describe('hovermode: (x|y)unified', function() {
             y: [2, 3, 1]
         }], {
             xaxis: {
-                unifiedhovertitle: 'X: %{x:.2f}',
+                unifiedhovertitle: { text: 'X: %{x:.2f}' },
             },
             hovermode: 'x unified',
             showlegend: false,
@@ -6946,7 +6946,7 @@ describe('hovermode: (x|y)unified', function() {
         }], {
             xaxis: {
                 type: 'date',
-                unifiedhovertitle: 'X: %{x|%x %X}',
+                unifiedhovertitle: { text: 'X: %{x|%x %X}' },
             },
             hovermode: 'x unified',
             showlegend: false,

test/plot-schema.json

@@ -14985,10 +14985,14 @@
      "valType": "any"
     },
     "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",
-     "valType": "string"
+     "role": "object",
+     "text": {
+      "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",
+      "valType": "string"
+     }
     },
     "visible": {
      "description": "A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false",
@@ -16246,10 +16250,14 @@
      "valType": "any"
     },
     "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",
-     "valType": "string"
+     "role": "object",
+     "text": {
+      "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",
+      "valType": "string"
+     }
     },
     "visible": {
      "description": "A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false",