Added support for BorderRadius object and fixed missing SunburstOptions.border_radius property.

Author: hcpchris

docs/api.rst

@@ -622,6 +622,8 @@ Core Components
       :class:`ASTNode <highcharts_core.utility_classes.ast.ASTNode>`
       :class:`TextPath <highcharts_core.utility_classes.ast.TextPath>`
       :class:`AttributeObject <highcharts_core.utility_classes.ast.AttributeObject>`
+  * - :mod:`.utility_classes.border_radius <highcharts_core.utility_classes.border_radius>`
+    - :class:`BorderRadius <highcharts_core.utility_classes.border_radius.BorderRadius>`
   * - :mod:`.utility_classes.breadcrumbs <highcharts_core.utility_classes.breadcrumbs>`
     - :class:`BreadcrumbOptions <highcharts_core.utility_classes.breadcrumbs.BreadcrumbOptions>`
       :class:`Separator <highcharts_core.utility_classes.breadcrumbs.Separator>`

docs/api/utility_classes/border_radius.rst

@@ -0,0 +1,29 @@
+##########################################################################################
+:mod:`.border_radius <highcharts_core.utility_classes.border_radius>`
+##########################################################################################
+
+.. contents:: Module Contents
+  :local:
+  :depth: 3
+  :backlinks: entry
+
+--------------
+
+.. module:: highcharts_core.utility_classes.border_radius
+
+********************************************************************************************************************
+class: :class:`BorderRadius <highcharts_core.utility_classes.border_radius.BorderRadius>`
+********************************************************************************************************************
+
+.. autoclass:: BorderRadius
+  :members:
+  :inherited-members:
+
+  .. collapse:: Class Inheritance
+
+    .. inheritance-diagram:: BorderRadius
+      :top-classes: highcharts_core.metaclasses.HighchartsMeta
+      :parts: -1
+
+  |
+

docs/api/utility_classes/index.rst

@@ -53,6 +53,8 @@ Sub-components
       :class:`ASTNode <highcharts_core.utility_classes.ast.ASTNode>`
       :class:`TextPath <highcharts_core.utility_classes.ast.TextPath>`
       :class:`AttributeObject <highcharts_core.utility_classes.ast.AttributeObject>`
+  * - :mod:`.utility_classes.border_radius <highcharts_core.utility_classes.border_radius>`
+    - :class:`BorderRadius <highcharts_core.utility_classes.border_radius.BorderRadius>`
   * - :mod:`.utility_classes.breadcrumbs <highcharts_core.utility_classes.breadcrumbs>`
     - :class:`BreadcrumbOptions <highcharts_core.utility_classes.breadcrumbs.BreadcrumbOptions>`
       :class:`Separator <highcharts_core.utility_classes.breadcrumbs.Separator>`

highcharts_core/options/plot_options/bar.py

@@ -10,6 +10,7 @@
 from highcharts_core.utility_classes.patterns import Pattern
 from highcharts_core.utility_classes.data_grouping import DataGroupingOptions
 from highcharts_core.utility_classes.partial_fill import PartialFillOptions
+from highcharts_core.utility_classes.border_radius import BorderRadius
 
 
 class BaseBarOptions(SeriesOptions):
@@ -61,7 +62,7 @@ def border_color(self, value):
         self._border_color = utility_functions.validate_color(value)
 
     @property
-    def border_radius(self) -> Optional[int | float | Decimal]:
+    def border_radius(self) -> Optional[int | float | Decimal | str | BorderRadius]:
         """The corner radius of the border surrounding each column or bar. Defaults to
         ``0``.
 
@@ -71,9 +72,23 @@ def border_radius(self) -> Optional[int | float | Decimal]:
 
     @border_radius.setter
     def border_radius(self, value):
-        self._border_radius = validators.numeric(value,
-                                                 allow_empty = True,
-                                                 minimum = 0)
+        if value is None:
+            self._border_radius = None
+        else:
+            try:
+                self._border_radius = validators.numeric(value,
+                                                        allow_empty = True,
+                                                        minimum = 0)
+            except (ValueError, TypeError):
+                try:
+                    self._border_radius = validate_types(value, BorderRadius)
+                except (ValueError, TypeError):
+                    if not isinstance(value, str):
+                        raise errors.HighchartsValueError(f'border_radius must be a numeric value, '
+                                                          f'a string, or an instance of BorderRadius. '
+                                                          f'Received {value.__class__.__name__}.')
+                        
+                    self._border_radius = value
 
     @property
     def border_width(self) -> Optional[int | float | Decimal]:

highcharts_core/options/plot_options/pie.py

@@ -8,6 +8,7 @@
 from highcharts_core.utility_classes.gradients import Gradient
 from highcharts_core.utility_classes.patterns import Pattern
 from highcharts_core.utility_classes.data_labels import PieDataLabel
+from highcharts_core.utility_classes.border_radius import BorderRadius
 from highcharts_core.decorators import validate_types
 
 
@@ -95,7 +96,7 @@ def border_color(self, value):
         self._border_color = utility_functions.validate_color(value)
 
     @property
-    def border_radius(self) -> Optional[str | int | float | Decimal]:
+    def border_radius(self) -> Optional[str | int | float | Decimal | BorderRadius]:
         """
         .. versionadded:: Highcharts Core for Python v.1.1.0 / Highcharts Core (JS) v.11.0.0
         
@@ -106,7 +107,9 @@ def border_radius(self) -> Optional[str | int | float | Decimal]:
             A numerical value signifies the value is expressed in pixels. A percentage string like `50%`
             signifies a size relative to the radius and the inner radius.
             
-        :rtype: numeric, :class:`str <python:str>` or :obj:`None <python:None>`
+        :rtype: numeric, :class:`str <python:str>`, 
+          :class:`BorderRadius <highcharts_core.utility_classes.border_radius.BorderRadius>` or 
+          :obj:`None <python:None>`
         """
         return self._border_radius
 
@@ -116,11 +119,14 @@ def border_radius(self, value):
             self._border_radius = None
         else:
             try:
-                value = validators.string(value)
-                if '%' not in value:
-                    raise ValueError
-            except (TypeError, ValueError):
-                value = validators.numeric(value, minimum = 0)
+                value = validate_types(value, types = BorderRadius)
+            except (ValueError, TypeError):
+                try:
+                    value = validators.string(value)
+                    if '%' not in value:
+                        raise ValueError
+                except (TypeError, ValueError):
+                    value = validators.numeric(value, minimum = 0)
 
             self._border_radius = value
 

highcharts_core/options/plot_options/sunburst.py

@@ -12,6 +12,7 @@
 from highcharts_core.utility_classes.breadcrumbs import BreadcrumbOptions
 from highcharts_core.utility_classes.shadows import ShadowOptions
 from highcharts_core.utility_classes.data_labels import SunburstDataLabel
+from highcharts_core.utility_classes.border_radius import BorderRadius
 
 
 class SunburstOptions(GenericTypeOptions):
@@ -28,6 +29,7 @@ class SunburstOptions(GenericTypeOptions):
     """
 
     def __init__(self, **kwargs):
+        self._border_radius = None
         self._color_index = None
         self._crisp = None
         self._shadow = None
@@ -46,6 +48,7 @@ def __init__(self, **kwargs):
         self._sliced_offset = None
         self._start_angle = None
 
+        self.border_radius = kwargs.get('border_radius', None)
         self.color_index = kwargs.get('color_index', None)
         self.crisp = kwargs.get('crisp', None)
         self.shadow = kwargs.get('shadow', None)
@@ -117,6 +120,35 @@ def border_width(self, value):
                                                 allow_empty = True,
                                                 minimum = 0)
 
+    @property
+    def border_radius(self) -> Optional[int | float | Decimal | str | BorderRadius]:
+        """The corner radius of the border surrounding each column or bar. Defaults to
+        ``0``.
+
+        :rtype: numeric or :obj:`None <python:None>`
+        """
+        return self._border_radius
+
+    @border_radius.setter
+    def border_radius(self, value):
+        if value is None:
+            self._border_radius = None
+        else:
+            try:
+                self._border_radius = validators.numeric(value,
+                                                        allow_empty = True,
+                                                        minimum = 0)
+            except (ValueError, TypeError):
+                try:
+                    self._border_radius = validate_types(value, BorderRadius)
+                except (ValueError, TypeError):
+                    if not isinstance(value, str):
+                        raise errors.HighchartsValueError(f'border_radius must be a numeric value, '
+                                                          f'a string, or an instance of BorderRadius. '
+                                                          f'Received {value.__class__.__name__}.')
+                        
+                    self._border_radius = value
+
     @property
     def breadcrumbs(self) -> Optional[BreadcrumbOptions]:
         """Options for the breadcrumbs, the navigation at the top leading the way up
@@ -468,6 +500,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'allow_traversing_tree': as_dict.get('allowTraversingTree', None),
             'border_color': as_dict.get('borderColor', None),
             'border_width': as_dict.get('borderWidth', None),
+            'border_radius': as_dict.get('borderRadius', None),
             'breadcrumbs': as_dict.get('breadcrumbs', None),
             'center': as_dict.get('center', None),
             'color_by_point': as_dict.get('colorByPoint', None),
@@ -491,6 +524,7 @@ def _to_untrimmed_dict(self, in_cls = None) -> dict:
             'allowTraversingTree': self.allow_traversing_tree,
             'borderColor': self.border_color,
             'borderWidth': self.border_width,
+            'borderRadius': self.border_radius,
             'breadcrumbs': self.breadcrumbs,
             'center': self.center,
             'colorByPoint': self.color_by_point,

highcharts_core/utility_classes/border_radius.py

@@ -0,0 +1,120 @@
+from typing import Optional
+from decimal import Decimal
+
+from validator_collection import validators
+
+from highcharts_core import errors
+from highcharts_core.decorators import class_sensitive
+from highcharts_core.metaclasses import HighchartsMeta
+
+
+class BorderRadius(HighchartsMeta):
+    """Precise configuration of Border Radius behavior."""
+
+    def __init__(self, **kwargs):
+        self._radius = None
+        self._scope = None
+        self._where = None
+        
+        self.radius = kwargs.get('radius', None)
+        self.scope = kwargs.get('scope', None)
+        self.where = kwargs.get('where', None)
+        
+    @property
+    def radius(self) -> Optional[str | int | float | Decimal]:
+        """The border radius. 
+        
+        A number signifies pixels. 
+        
+        A percentage string, like for example 50%, signifies a relative size. 
+        
+        .. note::
+
+          For columns this is relative to the column width, for pies it is relative to the radius 
+          and the inner radius.
+        
+        :rtype: numeric or :class:`str <python:str>` or :obj:`None <python:None>`
+        """
+        return self._radius
+    
+    @radius.setter
+    def radius(self, value):
+        if value is None:
+            self._radius = None
+        else:
+            try:
+                self._radius = validators.numeric(value, allow_empty = None)
+            except (ValueError, TypeError):
+                if not isinstance(value, str):
+                    raise errors.HighchartsValueError(f'radius expects a number or string. '
+                                                      f'Received: {value.__class__.__name__}')
+                self._radius = value
+                
+    @property
+    def scope(self) -> Optional[str]:
+        """The scope of the rounding for column charts. 
+        
+        .. note::
+        
+          In a stacked column chart:
+          
+            * the value ``'point'`` means each single point will get rounded corners
+            * the value ``'stack'`` means the rounding will apply to the full stack, so that 
+              only points close to the top or bottom will receive rounding.
+              
+        :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
+        """
+        return self._scope
+    
+    @scope.setter
+    def scope(self, value):
+        if not value:
+            self._scope = None
+        else:
+            value = value.lower()
+            if value not in ['point', 'stack']:
+                raise errors.HighchartsValueError(f'scope expects either "point" or "stack". '
+                                                  f'Received: {value}')
+            self._scope = value
+
+    @property
+    def where(self) -> Optional[str]:
+        """For column charts, where in the point or stack to apply rounding. 
+        
+        * The value ``'end'`` means only those corners at the point value will be rounded, 
+          leaving the corners at the base or threshold unrounded. This is the most intuitive behaviour. 
+        * The value ``'all'`` means the base will be rounded, in addition to the corners at the point value.
+        
+        :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
+        """
+        return self._where
+    
+    @where.setter
+    def where(self, value):
+        if not value:
+            self._where = None
+        else:
+            value = value.lower()
+            if value not in ['end', 'all']:
+                raise errors.HighchartsValueError(f'where expects either "end" or "all". '
+                                                  f'Received: {value}')
+            self._where = value
+
+    @classmethod
+    def _get_kwargs_from_dict(cls, as_dict):
+        kwargs = {
+            'radius': as_dict.get('radius', None),
+            'scope': as_dict.get('scope', None),
+            'where': as_dict.get('where', None)
+        }
+
+        return kwargs
+
+    def _to_untrimmed_dict(self, in_cls = None) -> dict:
+        untrimmed = {
+            'radius': self.radius,
+            'scope': self.scope,
+            'where': self.where
+        }
+
+        return untrimmed