Merge pull request #26 from highcharts-for-python/develop

PR for v.1.2.0

Author: hcpchris

CHANGES.rst

@@ -1,10 +1,16 @@
-Release 1.1.1
+Release 1.2.0
 =========================================
 
-* **FIXED:** Problem when producing a JS literal, with the JS code inserting an unnecessary ``new``.
-* **ENHANCEMENT:** Added more elegant error handling when something goes wrong displaying a chart in Jupyter.
+* **ENHANCEMENT:** Align the API to **Highcharts (JS) v.11.1** (#22). In particular, this includes:
 
----------------------
+  * Changes inherited from **Highcharts Core for Python v.1.2.0**. See `here <https://core-docs.highchartspython.com/en/latest/history.html#release-1-2-0>`__.
+
+* **ENHANCEMENT:** Added support for the inclusion of scripts based on features used in the chart (#7).
+* **ENHANCEMENT:** Added ``dict`` support to ``.style`` property on labels and titles.
+* **DOCS:** Various documentation updates and fixes.
+* **DEPENDENCY:** Bumped ``requests`` version for security patch.
+
+---------------
 
 Release 1.1.0
 =========================================

README.rst

@@ -17,7 +17,7 @@ JavaScript data visualization library.
   * The **Highcharts Export Server** - enabling the programmatic creation of static
     (downloadable) data visualizations
 
-The library supports Highcharts (JS) v.10.2 and higher, including Highcharts (JS) v.11.0.0.
+The library supports Highcharts (JS) v.10.2 and higher, including Highcharts (JS) v.11.1.0.
 
 **Highcharts Gantt for Python** is fully integrated with the broader Python ecosystem,
 featuring native integrations with:
@@ -86,7 +86,7 @@ Before you install, please be aware of the following "hard" dependencies:
     it won't work with earlier versions of Highcharts Stock)
   * `Highcharts Stock for Python <https://stock-docs.highchartspython.com/en/latest/>`__ v.1.0 or higher
   * `esprima-python <https://github.com/Kronuz/esprima-python>`__ v.4.0 or higher
-  * `requests <https://requests.readthedocs.io/en/latest/>`__ v.2.28 or higher
+  * `requests <https://requests.readthedocs.io/en/latest/>`__ v.2.31 or higher
   * `validator-collection <https://validator-collection.readthedocs.io/en/latest/>`__
     v.1.5 or higher
 

docs/_dependencies.rst

@@ -34,7 +34,7 @@
 
     * `highcharts-stock <https://stock-docs.highchartspython.com>`_ v.1.0.0 or higher
     * `esprima-python <https://github.com/Kronuz/esprima-python>`_ v.4.0 or higher
-    * `requests <https://requests.readthedocs.io/en/latest/>`_ v.2.28 or higher
+    * `requests <https://requests.readthedocs.io/en/latest/>`_ v.2.31 or higher
     * `validator-collection <https://validator-collection.readthedocs.io/en/latest/>`_
       v.1.5 or higher
 

docs/_static/tiledwebmap-example.png

@@ -74,10 +74,10 @@ we recommend that you click the following badge:
     :target: https://mybinder.org/v2/gh/highcharts-for-python/highcharts-for-python-demos/HEAD
     :alt: Binder: Highcharts for Python Demos
 
-This will clone the `Highcharts for Python Demos <https://github.com/highcharts-for-python-demos>`__
+This will clone the `Highcharts for Python Demos <https://github.com/highcharts-for-python/highcharts-for-python-demos>`__
 source repository within a Docker image, and launch `Jupyter Lab <https://jupyter.org>`__ within that
 Docker container. This will then let you browse, edit, and run any of the Jupyter Notebooks contained
-within the `Highcharts for Python Demos <https://github.com/highcharts-for-python-demos>`__ repo.
+within the `Highcharts for Python Demos <https://github.com/highcharts-for-python/highcharts-for-python-demos>`__ repo.
 
 How the Demos are Organized
 ==============================
@@ -122,4 +122,4 @@ Running Demos Locally
 .. note::
 
   You can run the demos locally by following instructions in the 
-  `Highcharts for Python Demos <https://github.com/highcharts-for-python-demos>`__ Github repo's README.
+  `Highcharts for Python Demos <https://github.com/highcharts-for-python/highcharts-for-python-demos>`__ Github repo's README.

docs/demos.rst

@@ -172,6 +172,24 @@ Glossary
 
       * `Highcharts Node Export Server Documentation <https://github.com/highcharts/node-export-server>`__
 
+  Format String
+    .. versionadded: v.1.2.0
+
+    Format strings are templates for labels introduced in Highcharts for Python v.1.2. 
+    Since Highcharts (JS) v.11.1, format strings support logic. 
+    
+    We recommend using format strings if you:
+
+      * Need to save the chart configuration to JSON.
+      * Need to provide a GUI for end users so that callbacks are not practical, or XSS is a concern.
+      * Need to send the charts over to our export server to execute (all callbacks are stripped out).
+      * Are creating a wrapper for another programming language than JavaScript.
+    
+    .. seealso::
+
+      For a full overview over templating in format strings, please see the Highcharts (JS) 
+      `Templating <https://www.highcharts.com/docs/chart-concepts/templating>`__ article.
+
   Formatter
     A particular type of :term:`callback function` used extensively in Highcharts. In
     general terms, a formatter receives a context (for example a data point) and returns

docs/glossary.rst

@@ -38,7 +38,7 @@ Highcharts Gantt for Python
 
 .. sidebar:: Version Compatibility
 
-  **Latest Highcharts (JS) version supported:** v.11.0.0
+  **Latest Highcharts (JS) version supported:** v.11.1.0
 
   **Highcharts Gantt for Python** is designed to be compatible with:
 

docs/index.rst

@@ -692,14 +692,22 @@ to visualize your data.
           :class:`highcharts_maps.options.plot_options.mapline.MapLineOptions`
 
           :class:`highcharts_maps.options.series.mapline.MapLineSeries`
-      * - **Map**
+      * - **Map Point**
         - .. figure:: _static/mappoint-example.png
             :alt: Map Point Example Chart
             :width: 100%
 
           :class:`highcharts_maps.options.plot_options.mappoint.MapPointOptions`
 
           :class:`highcharts_maps.options.series.mappoint.MapPointSeries`
+      * - **Tiled Web Map**
+        - .. figure:: _static/tiledwebmap-example.png
+            :alt: Tiled Web Map Example Chart
+            :width: 100%
+
+          :class:`highcharts_maps.options.plot_options.tiledwebmap.TiledWebMapOptions`
+
+          :class:`highcharts_maps.options.series.tiledwebmap.TiledWebMapSeries`
 
   .. tab:: Gantt
 

docs/visualizations.rst

@@ -1 +1 @@
-__version__ = '1.1.1'
+__version__ = '1.2.0'

highcharts_gantt/__version__.py

@@ -1,10 +1,10 @@
-from typing import Optional
+from typing import Optional, List
 
 from validator_collection import validators, checkers
 
 from highcharts_stock.chart import Chart as ChartBase
 
-from highcharts_gantt import constants, errors, utility_functions
+from highcharts_gantt import errors, utility_functions
 from highcharts_gantt.options import (HighchartsOptions, 
                                       HighchartsStockOptions,
                                       HighchartsGanttOptions)
@@ -30,43 +30,6 @@ def __init__(self, **kwargs):
 
         super().__init__(**kwargs)
 
-    def _jupyter_include_scripts(self):
-        """Return the JavaScript code that is used to load the Highcharts JS libraries.
-
-        .. note::
-
-          Currently includes *all* `Highcharts JS <https://www.highcharts.com/>`_ modules
-          in the HTML. This issue will be addressed when roadmap issue :issue:`2` is
-          released.
-
-        :rtype: :class:`str <python:str>`
-        """
-        js_str = ''
-        if self.is_gantt_chart:
-            for item in constants.GANTT_INCLUDE_LIBS:
-                js_str += utility_functions.jupyter_add_script(item)
-                js_str += """.then(() => {"""
-                
-            for item in constants.GANTT_INCLUDE_LIBS:
-                js_str += """});"""
-        elif self.is_stock_chart:
-            for item in constants.STOCK_INCLUDE_LIBS:
-                js_str += utility_functions.jupyter_add_script(item)
-                js_str += """.then(() => {"""
-
-            for item in constants.STOCK_INCLUDE_LIBS:
-                js_str += """});"""
-
-        else:
-            for item in constants.INCLUDE_LIBS:
-                js_str += utility_functions.jupyter_add_script(item)
-                js_str += """.then(() => {"""
-
-            for item in constants.INCLUDE_LIBS:
-                js_str += """});"""
-
-        return js_str
-
     def _jupyter_javascript(self, 
                             global_options = None, 
                             container = None,
@@ -126,6 +89,27 @@ def _jupyter_javascript(self,
 
         return js_str
 
+    def get_required_modules(self, include_extension = False) -> List[str]:
+        """Return the list of URLs from which the Highcharts JavaScript modules
+        needed to render the chart can be retrieved.
+        
+        :param include_extension: if ``True``, will return script names with the 
+          ``'.js'`` extension included. Defaults to ``False``.
+        :type include_extension: :class:`bool <python:bool>`
+
+        :rtype: :class:`list <python:list>`
+        """
+        initial_scripts = ['highcharts']
+        if self.is_gantt_chart:
+            initial_scripts.extend(['gantt/modules/gantt'])
+        has_stock_tools = hasattr(self.options, 'stock_tools') and self.options.stock_tools
+        if self.is_stock_chart or has_stock_tools:
+            initial_scripts.append('modules/stock')
+
+        scripts = self._process_required_modules(initial_scripts, include_extension)
+
+        return scripts
+
     def _repr_html_(self):
         """Produce the HTML representation of the chart.