Added error handling for series unsupported for export.

Author: hcpchris

docs/errors.rst

@@ -230,6 +230,18 @@ HighchartsUnsupportedProtocolError (from :class:`ValueError <python:ValueError>`
 
 --------------
 
+HighchartsUnsupportedExportError (from :class:`ValueError <python:ValueError>`)
+==========================================================================================
+
+.. autoexception:: HighchartsUnsupportedExportError
+
+  .. collapse:: Class Inheritance
+
+    .. inheritance-diagram:: HighchartsUnsupportedExportError
+      :parts: -1
+
+--------------
+
 HighchartsUnsupportedExportTypeError (from :class:`ValueError <python:ValueError>`)
 ==========================================================================================
 

docs/using.rst

@@ -701,6 +701,14 @@ environment. The actual file itself is produced using a
 
     .. include:: using/download_visualizations/_using_custom.rst
 
+
+.. warning::
+
+  As of Highcharts for Python v.1.1.0, the Highcharts :term:`Export Server` does not yet fully 
+  support all of the series types added in Highcharts (JS) v.11. Attempting to programmatically download
+  one of those new as-yet-unsupported visualizations will generate a 
+  :exc:`HighchartsUnsupportedExportError <highcharts_core.errors.HighchartsUnsupportedExportError>`.
+
 -----------------------------
 
 .. target-notes::

highcharts_core/constants.py

@@ -916,4 +916,11 @@ def __eq__(self, other):
     'noise',
     'filteredNoise',
     'wind',
+]
+
+EXPORT_SERVER_UNSUPPORTED_SERIES_TYPES = [
+    'pictorial',
+    'flowmap',
+    'geoheatmap',
+    'treegraph',
 ]

highcharts_core/errors.py

@@ -108,6 +108,12 @@ class HighchartsUnsupportedProtocolError(HighchartsExportServerError):
     pass
 
 
+class HighchartsUnsupportedExportError(HighchartsExportServerError):
+    """:exc:`ValueError <python:ValueError>` encountered when trying to export a series type that 
+    is not yet supported by the :term:`Export Server`.
+    """
+    pass
+
 class HighchartsUnsupportedExportTypeError(HighchartsExportServerError):
     """:exc:`ValueError <python:ValueError>` encountered when requesting an unsupported
     image type from a :term:`Export Server`."""

highcharts_core/headless_export.py

@@ -11,7 +11,7 @@
 import requests
 from validator_collection import validators
 
-from highcharts_core import errors
+from highcharts_core import errors, constants
 from highcharts_core.decorators import class_sensitive
 from highcharts_core.metaclasses import HighchartsMeta
 from highcharts_core.utility_classes.javascript_functions import CallbackFunction
@@ -531,6 +531,25 @@ def custom_code(self) -> Optional[CallbackFunction]:
     def custom_code(self, value):
         self._custom_code = value
 
+    @classmethod
+    def is_export_supported(cls, options) -> bool:
+        """Evaluates whether the Highcharts Export Server supports exporting the series types in ``options``.
+        
+        :rtype: :class:`bool <python:bool>`
+        """
+        if not isinstance(options, HighchartsOptions):
+            return False
+
+        if not options.series:
+            return True
+
+        series_types = [x.type for x in options.series]
+        for item in series_types:
+            if item in constants.EXPORT_SERVER_UNSUPPORTED_SERIES_TYPES:
+                return False
+            
+        return True
+
     @classmethod
     def _get_kwargs_from_dict(cls, as_dict):
         url = as_dict.get('url', None)
@@ -693,6 +712,12 @@ def request_chart(self,
 
         as_json = json.dumps(payload)
 
+        if not self.is_export_supported(self.options):
+            raise errors.HighchartsUnsupportedExportError('The Highcharts Export Server currently only supports '
+                                                          'exports from Highcharts (Javascript) v.10. You are '
+                                                          'using a series type introduced in v.11. Sorry, but '
+                                                          'that functionality is still forthcoming.')
+        
         options_as_json = self.options.to_json()
         if isinstance(options_as_json, bytes):
             options_as_str = str(options_as_json, encoding = 'utf-8')