Merge pull request #155 from highcharts-for-python/bugfix/148-nodeformat-not-working-for-sankey-diagram

Bugfix/148 nodeformat not working for sankey diagram. Closes #148

Author: hcpchris

CHANGES.rst

@@ -2,6 +2,8 @@
 Release 1.6.0
 =========================================
 
+* **BUGFIX:** Added support for ``nodeFormat`` and ``nodeFormatter`` to tooltip properties for
+  diagram series (Organization, Dependency Wheel, and Sankey). (#148)
 * **ENHANCEMENT:** Added ability to remove or override the JavaScript event listener when 
   serializing a chart to a JavaScript literal (#131 - courtesy of 
   `@ByronCook <https://github.com/ByronCook>`__ ).

highcharts_core/options/plot_options/arcdiagram.py

@@ -9,6 +9,7 @@
 from highcharts_core.utility_classes.gradients import Gradient
 from highcharts_core.utility_classes.patterns import Pattern
 from highcharts_core.options.plot_options.levels import LevelOptions
+from highcharts_core.options.tooltips import DiagramTooltip
 
 
 class ArcDiagramOptions(GenericTypeOptions):
@@ -250,6 +251,21 @@ def reversed(self, value):
         else:
             self._reversed = bool(value)
 
+    @property
+    def tooltip(self) -> Optional[DiagramTooltip]:
+        """A configuration object for the tooltip rendering of each single series.
+        Properties are inherited from tooltip, but only the following properties can be
+        defined on a series level.
+
+        :rtype: :class:`DiagramTooltip <highcharts_core.options.tooltips.DiagramTooltip` or :obj:`None <python:None>`
+        """
+        return self._tooltip
+
+    @tooltip.setter
+    @class_sensitive(DiagramTooltip)
+    def tooltip(self, value):
+        self._tooltip = value
+
     @classmethod
     def _get_kwargs_from_dict(cls, as_dict):
         kwargs = {

highcharts_core/options/plot_options/dependencywheel.py

@@ -9,6 +9,7 @@
 from highcharts_core.utility_classes.gradients import Gradient
 from highcharts_core.utility_classes.patterns import Pattern
 from highcharts_core.options.plot_options.levels import LevelOptions
+from highcharts_core.options.tooltips import DiagramTooltip
 
 
 class DependencyWheelOptions(GenericTypeOptions):
@@ -306,6 +307,21 @@ def start_angle(self, value):
                                                minimum = 0,
                                                maximum = 360)
 
+    @property
+    def tooltip(self) -> Optional[DiagramTooltip]:
+        """A configuration object for the tooltip rendering of each single series.
+        Properties are inherited from tooltip, but only the following properties can be
+        defined on a series level.
+
+        :rtype: :class:`DiagramTooltip <highcharts_core.options.tooltips.DiagramTooltip` or :obj:`None <python:None>`
+        """
+        return self._tooltip
+
+    @tooltip.setter
+    @class_sensitive(DiagramTooltip)
+    def tooltip(self, value):
+        self._tooltip = value
+
     @classmethod
     def _get_kwargs_from_dict(cls, as_dict):
         kwargs = {

highcharts_core/options/plot_options/organization.py

@@ -8,6 +8,7 @@
 from highcharts_core.options.plot_options.bar import BarOptions
 from highcharts_core.options.plot_options.levels import LevelOptions
 from highcharts_core.utility_classes.data_labels import OrganizationDataLabel
+from highcharts_core.options.tooltips import DiagramTooltip
 
 
 class OrganizationOptions(BarOptions):
@@ -270,6 +271,21 @@ def node_width(self) -> Optional[int | float | Decimal]:
     def node_width(self, value):
         self._node_width = validators.numeric(value, allow_empty = True)
 
+    @property
+    def tooltip(self) -> Optional[DiagramTooltip]:
+        """A configuration object for the tooltip rendering of each single series.
+        Properties are inherited from tooltip, but only the following properties can be
+        defined on a series level.
+
+        :rtype: :class:`DiagramTooltip <highcharts_core.options.tooltips.DiagramTooltip` or :obj:`None <python:None>`
+        """
+        return self._tooltip
+
+    @tooltip.setter
+    @class_sensitive(DiagramTooltip)
+    def tooltip(self, value):
+        self._tooltip = value
+
     @classmethod
     def _get_kwargs_from_dict(cls, as_dict):
         kwargs = {

highcharts_core/options/tooltips.py

@@ -970,3 +970,100 @@ def _to_untrimmed_dict(self, in_cls = None) -> dict:
         }
 
         return untrimmed
+
+
+class DiagramTooltip(Tooltip):
+    """Options for tooltips in diagram series, like :class:`DependencyWheelSeries <highcharts_core.options.series.dependencywheel.DependencyWheelSeries>` or :class:`SankeySeries <highcharts_core.options.series.sankey.SankeySeries>`."""
+    
+    def __init__(self, **kwargs):
+        self._node_format = None
+        self._node_formatter = None
+        
+        self.node_format = kwargs.get('node_format', None)
+        self.node_formatter = kwargs.get('node_formatter', None)
+        
+        super().__init__(**kwargs)
+        
+    @property
+    def node_format(self) -> Optional[str]:
+        """The format string specifying what to show for nodes in the tooltip of a diagram series, as opposed to links.
+        
+        :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
+        """
+        return self._node_format
+    
+    @node_format.setter
+    def node_format(self, value):
+        self._node_format = validators.string(value, allow_empty = True)
+
+    @property
+    def node_formatter(self) -> Optional[CallbackFunction]:
+        """JavaScript callback function to format the text of the tooltip's point line.
+
+        :rtype: :class:`CallbackFunction` or :obj:`None <python:None>`
+        """
+        return self._node_formatter
+
+    @node_formatter.setter
+    @class_sensitive(CallbackFunction)
+    def node_formatter(self, value):
+        self._node_formatter = value
+
+    @classmethod
+    def _get_kwargs_from_dict(cls, as_dict):
+        kwargs = {
+            "animation": as_dict.get("animation", None),
+            "background_color": as_dict.get("backgroundColor", None),
+            "border_color": as_dict.get("borderColor", None),
+            "border_radius": as_dict.get("borderRadius", None),
+            "border_width": as_dict.get("borderWidth", None),
+            "class_name": as_dict.get("className", None),
+            "cluster_format": as_dict.get("clusterFormat", None),
+            "date_time_label_formats": as_dict.get("dateTimeLabelFormats", None),
+            "distance": as_dict.get("distance", None),
+            "enabled": as_dict.get("enabled", None),
+            "follow_pointer": as_dict.get("followPointer", None),
+            "follow_touch_move": as_dict.get("followTouchMove", None),
+            "footer_format": as_dict.get("footerFormat", None),
+            "format": as_dict.get("format", None),
+            "formatter": as_dict.get("formatter", None),
+            "header_format": as_dict.get("headerFormat", None),
+            "header_shape": as_dict.get("headerShape", None),
+            "hide_delay": as_dict.get("hideDelay", None),
+            "null_format": as_dict.get("nullFormat", None),
+            "null_formatter": as_dict.get("nullFormatter", None),
+            "outside": as_dict.get("outside", None),
+            "padding": as_dict.get("padding", None),
+            "point_format": as_dict.get("pointFormat", None),
+            "point_formatter": as_dict.get("pointFormatter", None),
+            "positioner": as_dict.get("positioner", None),
+            "shadow": as_dict.get("shadow", None),
+            "shape": as_dict.get("shape", None),
+            "shared": as_dict.get("shared", None),
+            "snap": as_dict.get("snap", None),
+            "split": as_dict.get("split", None),
+            "stick_on_contact": as_dict.get("stickOnContact", None),
+            "style": as_dict.get("style", None),
+            "use_html": as_dict.get("useHTML", None),
+            "value_decimals": as_dict.get("valueDecimals", None),
+            "value_prefix": as_dict.get("valuePrefix", None),
+            "value_suffix": as_dict.get("valueSuffix", None),
+            "x_date_format": as_dict.get("xDateFormat", None),
+            
+            "node_format": as_dict.get('nodeFormat', None),
+            'node_formatter': as_dict.get('nodeFormatter', None)
+        }
+
+        return kwargs
+
+    def _to_untrimmed_dict(self, in_cls=None) -> dict:
+        untrimmed = {
+            'nodeFormat': self.node_format,
+            'nodeFormatter': self.node_formatter,
+        }
+
+        parent_as_dict = super()._to_untrimmed_dict(in_cls=in_cls) or {}
+        for key in parent_as_dict:
+            untrimmed[key] = parent_as_dict[key]
+
+        return untrimmed

tests/input_files/tooltips/03-diagram.js

@@ -0,0 +1,8 @@
+{
+  nodeFormat: 'Node: {point.name}',
+  borderRadius: 3,
+  borderWidth: 44,
+  valueDecimals: 2,
+  valuePrefix: '$',
+  valueSuffix: ' USD'
+ }

tests/input_files/tooltips/04-diagram.js

@@ -0,0 +1,12 @@
+{
+  nodeFormatter: function () {
+      // The first returned item is the header, subsequent items are the
+      // points
+      return ['<b>' + this.x + '</b>'].concat(
+          this.points ?
+              this.points.map(function (point) {
+                  return point.series.name + ': ' + point.y + 'm';
+              }) : []
+      );
+  }
+}

tests/options/test_tooltips.py

@@ -4,7 +4,8 @@
 
 from validator_collection import checkers
 
-from highcharts_core.options.tooltips import Tooltip as cls
+from highcharts_core.options.tooltips import (Tooltip as cls,
+                                              DiagramTooltip as cls2)
 from highcharts_core.utility_classes.javascript_functions import CallbackFunction
 from highcharts_core import errors
 from tests.fixtures import input_files, check_input_file, to_camelCase, to_js_dict, \
@@ -144,4 +145,140 @@ def test_bug130_tooltip_serialization():
     assert obj.format == '{point.name}: {point.y}'
 
     result = obj.to_js_literal()
-    assert "'{point.name}: {point.y}'" in result or '"{point.name}: {point.y}"' in result
+    assert "'{point.name}: {point.y}'" in result or '"{point.name}: {point.y}"' in result
+    
+#### DIAGRAM TOOLTIP TESTS
+
+STANDARD_PARAMS_2 = [
+    ({}, None),
+    ({
+        'node_format': 'format string',
+        'node_formatter': """function() { return true; }""",
+    }, None),
+    (
+        {
+            "animation": True,
+            "background_color": "#ccc",
+            "border_color": "#999",
+            "border_radius": 4,
+            "border_width": 1,
+            "class_name": "some-class-name",
+            "cluster_format": "format string",
+            "date_time_label_formats": {
+                "day": "test",
+                "hour": "test",
+                "millisecond": "test",
+                "minute": "test",
+                "month": "test",
+                "second": "test",
+                "week": "test",
+                "year": "test",
+            },
+            "distance": 12,
+            "enabled": True,
+            "follow_pointer": True,
+            "follow_touch_move": True,
+            "footer_format": "format string",
+            "formatter": """function() { return true; }""",
+            "header_format": "format string",
+            "header_shape": "circle",
+            "hide_delay": 3,
+            "null_format": "format string",
+            "null_formatter": """function() { return true; }""",
+            "outside": False,
+            "padding": 6,
+            "point_format": "format string",
+            "point_formatter": """function() { return true; }""",
+            "positioner": """function() { return true; }""",
+            "shadow": False,
+            "shape": "rect",
+            "shared": False,
+            "snap": 4,
+            "split": False,
+            "stick_on_contact": True,
+            "style": "style string goes here",
+            "use_html": False,
+            "value_decimals": 2,
+            "value_prefix": "$",
+            "value_suffix": " USD",
+            "x_date_format": "format string",
+        },
+        None,
+    ),
+    (
+        {
+            "formatter": CallbackFunction.from_js_literal("""function () {
+            // The first returned item is the header, subsequent items are the
+            // points
+            return ['<b>' + this.x + '</b>'].concat(
+                this.points ?
+                    this.points.map(function (point) {
+                        return point.series.name + ': ' + point.y + 'm';
+                    }) : []
+            );
+        }"""),
+            "split": True,
+        },
+        None,
+    ),
+    (
+        {
+            "formatter": """function () {
+            // The first returned item is the header, subsequent items are the
+            // points
+            return ['<b>' + this.x + '</b>'].concat(
+                this.points ?
+                    this.points.map(function (point) {
+                        return point.series.name + ': ' + point.y + 'm';
+                    }) : []
+            );
+        }""",
+            "split": True,
+        },
+        None,
+    ),
+    ({"format": "{point.name} {point.y}"}, None),
+    ({"border_width": "not-a-number"}, (ValueError, TypeError)),
+]
+
+
+@pytest.mark.parametrize('kwargs, error', STANDARD_PARAMS_2)
+def test_DiagramTooltip__init__(kwargs, error):
+    Class__init__(cls2, kwargs, error)
+
+
+@pytest.mark.parametrize('kwargs, error', STANDARD_PARAMS_2)
+def test_DiagramTooltip__to_untrimmed_dict(kwargs, error):
+    Class__to_untrimmed_dict(cls2, kwargs, error)
+
+
+@pytest.mark.parametrize('kwargs, error', STANDARD_PARAMS_2)
+def test_DiagramTooltip_from_dict(kwargs, error):
+    Class_from_dict(cls2, kwargs, error)
+
+
+@pytest.mark.parametrize('kwargs, error', STANDARD_PARAMS_2)
+def test_DiagramTooltip_to_dict(kwargs, error):
+    Class_to_dict(cls2, kwargs, error)
+
+
+@pytest.mark.parametrize('filename, as_file, error', [
+    ('tooltips/01.js', False, None),
+    ('tooltips/02.js', False, None),
+    ('tooltips/03-diagram.js', False, None),
+    ('tooltips/04-diagram.js', False, None),
+
+    ('tooltips/error-01.js', False, (TypeError, ValueError)),
+    ('tooltips/error-02.js', False, errors.HighchartsParseError),
+
+    ('tooltips/01.js', True, None),
+    ('tooltips/02.js', True, None),
+    ('tooltips/03-diagram.js', True, None),
+    ('tooltips/04-diagram.js', False, None),
+
+    ('tooltips/error-01.js', True, (TypeError, ValueError)),
+    ('tooltips/error-02.js', True, errors.HighchartsParseError),
+])
+def test_DiagramTooltip_from_js_literal(input_files, filename, as_file, error):
+    Class_from_js_literal(cls2, input_files, filename, as_file, error)
+