Skip to content

Commit bfa200e

Browse files
committed
Updates to documentation.
1 parent dac4602 commit bfa200e

File tree

6 files changed

+24
-5
lines changed

6 files changed

+24
-5
lines changed

CHANGES.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Release 1.2.0
1111
* **BUGFIX:** Fixed de-serialization error in ``options.series.data.geometric.GeometricZData`` which
1212
prevented the population of ``.properties``.
1313
* **DOCS:** Several documentation fixes.
14+
* **DEPENDENCY:** Bumped ``requests`` version for security patch.
1415

1516
---------------------
1617

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ JavaScript data visualization library.
1616
* The **Highcharts Export Server** - enabling the programmatic creation of static
1717
(downloadable) data visualizations
1818

19-
The library supports Highcharts (JS) v.10.2 and higher, including Highcharts (JS) v.11.0.0.
19+
The library supports Highcharts (JS) v.10.2 and higher, including Highcharts (JS) v.11.1.0.
2020

2121
**Highcharts Maps for Python** is fully integrated with the broader Python ecosystem,
2222
offerin gnative integrations with:
@@ -87,7 +87,7 @@ Before you install, please be aware of the following "hard" dependencies:
8787
it won't work with earlier versions of Highcharts)
8888
* `Highcharts Core for Python <https://core-docs.highchartspython.com/en/latest/>`__ v.1.0 or higher
8989
* `esprima-python <https://github.com/Kronuz/esprima-python>`__ v.4.0 or higher
90-
* `requests <https://requests.readthedocs.io/en/latest/>`__ v.2.28 or higher
90+
* `requests <https://requests.readthedocs.io/en/latest/>`__ v.2.31 or higher
9191
* `validator-collection <https://validator-collection.readthedocs.io/en/latest/>`__
9292
v.1.5 or higher
9393
* `topojson <https://mattijn.github.io/topojson/>`__ v.1.5 or higher

docs/_contributors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* Chris Modzelewski (`@insightindustry <https://github.com/insightindustry>`_)
1+
* Chris Modzelewski (`@hcpchris <https://github.com/hcpchris>`__ / `@insightindustry <https://github.com/insightindustry>`__)

docs/_dependencies.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
* `highcharts-core <https://core-docs.highchartspython.com>`_ v.1.0.0 or higher
3636
* `esprima-python <https://github.com/Kronuz/esprima-python>`_ v.4.0 or higher
37-
* `requests <https://requests.readthedocs.io/en/latest/>`_ v.2.28 or higher
37+
* `requests <https://requests.readthedocs.io/en/latest/>`_ v.2.31 or higher
3838
* `validator-collection <https://validator-collection.readthedocs.io/en/latest/>`_
3939
v.1.5 or higher
4040
* `topojson <https://mattijn.github.io/topojson/>`_ v.1.5 or higher

docs/glossary.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,24 @@ Glossary
176176

177177
* `Highcharts Node Export Server Documentation <https://github.com/highcharts/node-export-server>`__
178178

179+
Format String
180+
.. versionadded: v.1.2.0
181+
182+
Format strings are templates for labels introduced in Highcharts for Python v.1.2.
183+
Since Highcharts (JS) v.11.1, format strings support logic.
184+
185+
We recommend using format strings if you:
186+
187+
* Need to save the chart configuration to JSON.
188+
* Need to provide a GUI for end users so that callbacks are not practical, or XSS is a concern.
189+
* Need to send the charts over to our export server to execute (all callbacks are stripped out).
190+
* Are creating a wrapper for another programming language than JavaScript.
191+
192+
.. seealso::
193+
194+
For a full overview over templating in format strings, please see the Highcharts (JS)
195+
`Templating <https://www.highcharts.com/docs/chart-concepts/templating>`__ article.
196+
179197
Formatter
180198
A particular type of :term:`callback function` used extensively in Highcharts. In
181199
general terms, a formatter receives a context (for example a data point) and returns

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Highcharts Maps for Python
3838

3939
.. sidebar:: Version Compatibility
4040

41-
**Latest Highcharts (JS) version supported:** v.11.0.0
41+
**Latest Highcharts (JS) version supported:** v.11.1.0
4242

4343
**Highcharts Maps for Python** is designed to be compatible with:
4444

0 commit comments

Comments
 (0)