Merge pull request #24 from highcharts-for-python/23-align-highcharts-gantt-for-python-to-highcharts-gantt-js-v111

hcpchris · web-flow · commit 70f1cdf2d677 · 2023-06-07T15:56:18.000-04:00
PR for v.1.2.0
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,18 +1,16 @@
 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 ``options.series.labels.SeriesLabel.style`` and ``utility_classes.data_labels.DataLabel.style``.
-
-------------------
+* **ENHANCEMENT:** Align the API to **Highcharts (JS) v.11.1** (#22). In particular, this includes:
 
-Release 1.1.1
-=========================================
+  * 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>`__.
 
-* **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:** 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
 =========================================
diff --git a/README.rst b/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
 
diff --git a/docs/_dependencies.rst b/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
 
diff --git a/docs/_static/tiledwebmap-example.png b/docs/_static/tiledwebmap-example.png
diff --git a/docs/demos.rst b/docs/demos.rst
@@ -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.
diff --git a/docs/glossary.rst b/docs/glossary.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
diff --git a/docs/index.rst b/docs/index.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:
 
diff --git a/docs/visualizations.rst b/docs/visualizations.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
 
diff --git a/highcharts_gantt/options/axes/x_axis.py b/highcharts_gantt/options/axes/x_axis.py
@@ -82,6 +82,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'categories': as_dict.get('categories', None),
             'ceiling': as_dict.get('ceiling', None),
             'class_name': as_dict.get('className', None),
+            'crossing': as_dict.get('crossing', None),
             'date_time_label_formats': as_dict.get('dateTimeLabelFormats', None),
             'end_on_tick': as_dict.get('endOnTick', None),
             'events': as_dict.get('events', None),
diff --git a/highcharts_gantt/options/axes/y_axis.py b/highcharts_gantt/options/axes/y_axis.py
@@ -84,6 +84,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'categories': as_dict.get('categories', None),
             'ceiling': as_dict.get('ceiling', None),
             'class_name': as_dict.get('className', None),
+            'crossing': as_dict.get('crossing', None),
             'date_time_label_formats': as_dict.get('dateTimeLabelFormats', None),
             'end_on_tick': as_dict.get('endOnTick', None),
             'events': as_dict.get('events', None),
diff --git a/highcharts_gantt/options/plot_options/bar.py b/highcharts_gantt/options/plot_options/bar.py
@@ -57,6 +57,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'include_in_data_export': as_dict.get('includeInDataExport', None),
             'keys': as_dict.get('keys', None),
             'label': as_dict.get('label', None),
+            'legend_symbol': as_dict.get('legendSymbol', None),
             'linked_to': as_dict.get('linkedTo', None),
             'marker': as_dict.get('marker', None),
             'on_point': as_dict.get('onPoint', None),
@@ -91,6 +92,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'linecap': as_dict.get('linecap', None),
             'line_width': as_dict.get('lineWidth', None),
             'negative_color': as_dict.get('negativeColor', None),
+            'point_description_format': as_dict.get('pointDescriptionFormat', None),
             'point_interval': as_dict.get('pointInterval', None),
             'point_interval_unit': as_dict.get('pointIntervalUnit', None),
             'point_placement': as_dict.get('pointPlacement', None),
@@ -122,6 +124,7 @@ def _get_kwargs_from_dict(cls, as_dict):
 
             'drag_drop': as_dict.get('dragDrop', None),
             'negative_color': as_dict.get('negativeColor', None),
+            'point_description_format': as_dict.get('pointDescriptionFormat', None),
             'point_interval': as_dict.get('pointInterval', None),
             'point_interval_unit': as_dict.get('pointIntervalUnit', None),
             'point_placement': as_dict.get('pointPlacement', None),
diff --git a/highcharts_gantt/options/plot_options/series.py b/highcharts_gantt/options/plot_options/series.py
@@ -261,6 +261,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'include_in_data_export': as_dict.get('includeInDataExport', None),
             'keys': as_dict.get('keys', None),
             'label': as_dict.get('label', None),
+            'legend_symbol': as_dict.get('legendSymbol', None),
             'linked_to': as_dict.get('linkedTo', None),
             'marker': as_dict.get('marker', None),
             'on_point': as_dict.get('onPoint', None),
@@ -302,6 +303,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'connect_ends': as_dict.get('connectEnds', None),
             'drag_drop': as_dict.get('dragDrop', None),
             'negative_color': as_dict.get('negativeColor', None),
+            'point_description_format': as_dict.get('pointDescriptionFormat', None),
             'point_interval': as_dict.get('pointInterval', None),
             'point_interval_unit': as_dict.get('pointIntervalUnit', None),
             'point_placement': as_dict.get('pointPlacement', None),
diff --git a/highcharts_gantt/options/series/bar.py b/highcharts_gantt/options/series/bar.py
@@ -82,6 +82,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'include_in_data_export': as_dict.get('includeInDataExport', None),
             'keys': as_dict.get('keys', None),
             'label': as_dict.get('label', None),
+            'legend_symbol': as_dict.get('legendSymbol', None),
             'linked_to': as_dict.get('linkedTo', None),
             'marker': as_dict.get('marker', None),
             'on_point': as_dict.get('onPoint', None),
diff --git a/highcharts_gantt/options/series/gantt.py b/highcharts_gantt/options/series/gantt.py
@@ -78,6 +78,7 @@ def _get_kwargs_from_dict(cls, as_dict):
             'include_in_data_export': as_dict.get('includeInDataExport', None),
             'keys': as_dict.get('keys', None),
             'label': as_dict.get('label', None),
+            'legend_symbol': as_dict.get('legendSymbol', None),
             'linked_to': as_dict.get('linkedTo', None),
             'marker': as_dict.get('marker', None),
             'on_point': as_dict.get('onPoint', None),
diff --git a/pyproject.toml b/pyproject.toml
@@ -60,7 +60,7 @@ dependencies = [
     "highcharts-stock>=1.0.0-rc1",
     "esprima>=4.0.1",
     "validator-collection>=1.5.0",
-    "requests>=2.28.1"
+    "requests>=2.31.0"
 ]
 
 [tool.hatch.version]
@@ -74,7 +74,7 @@ path = "highcharts_gantt/__version__.py"
 "History" = "https://github.com/highcharts-for-python/highcharts-gantt/blob/master/CHANGES.rst"
 "Bug Tracker" = "https://github.com/highcharts-for-python/highcharts-gantt/issues"
 "Demo" = "https://github.com/highcharts-for-python/highcharts-for-python-demos"
-#"Sponsor" = "https://github.com/sponsors/highcharts-for-python"
+"Sponsor" = "https://github.com/sponsors/highcharts-for-python"
 
 [project.optional-dependencies]
 dev = [
diff --git a/requirements.dev.txt b/requirements.dev.txt
@@ -12,7 +12,7 @@ Sphinx==6.1.3
 sphinx-rtd-theme==1.2.0
 sphinx-toolbox>=3.4.0
 sphinx-tabs>=3.4.1
-requests==2.28.1
+requests==2.31.0
 tox==4.0.0
 urllib3==1.26.9
 validator-collection==1.5.0
diff --git a/requirements.travis.txt b/requirements.travis.txt
@@ -12,7 +12,7 @@ Sphinx==6.1.3
 sphinx-rtd-theme==1.2.0
 sphinx-toolbox>=3.4.0
 sphinx-tabs>=3.4.1
-requests==2.28.1
+requests==2.31.0
 tox==4.0.0
 urllib3==1.26.9
 validator-collection==1.5.0
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
 esprima==4.0.1
-requests==2.28.1
+requests==2.31.0
 validator-collection==1.5.0
 highcharts-stock>=1.0.0-rc1
