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

PR for v.1.1.0

Author: hcpchris

CHANGES.rst

@@ -1,3 +1,17 @@
+Release 1.1.0
+=========================================
+
+* Align the API to **Highcharts (JS) v.11**. In particular, this includes:
+
+  * Changes inherited from **Highcharts Core for Python v.1.1.0**. See `here <https://core-docs.highchartspython.com/en/latest/history.html#release-1-1-0>`__.
+  * Added ``options.drilldown.Drilldown.map_zooming`` property.
+  * Added ``FlowmapOptions`` / ``FlowmapSeries`` support.
+  * Added ``GeoHeatmapOptions`` / ``GeoHeatmapSeries`` support.
+
+* **FIXED:** Fixed missing ``TreegraphOptions`` / ``TreegraphSeries`` series type.
+
+---------------
+
 Release 1.0.1
 =========================================
 

README.rst

@@ -16,6 +16,8 @@ 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.
+
 **Highcharts Maps for Python** is fully integrated with the broader Python ecosystem,
 offerin gnative integrations with:
 

docs/_static/flowmap-example.png

@@ -340,6 +340,9 @@ Core Components
   * - :mod:`.options.plot_options.dumbbell <highcharts_maps.options.plot_options.dumbbell>`
     - :class:`DumbbellOptions <highcharts_maps.options.plot_options.dumbbell.DumbbellOptions>`
       :class:`LollipopOptions <highcharts_maps.options.plot_options.dumbbell.LollipopOptions>`
+  * - :mod:`.options.plot_options.flowmap <highcharts_maps.options.plot_options.flowmap>`
+    - :class:`FlowmapOptions <highcharts_maps.options.plot_options.flowmap.FlowmapOptions>`
+      :class:`GeoHeatmapOptions <highcharts_maps.options.plot_options.flowmap.GeoHeatmapOptions>`
   * - :mod:`.options.plot_options.funnel <highcharts_maps.options.plot_options.funnel>`
     - :class:`FunnelOptions <highcharts_maps.options.plot_options.funnel.FunnelOptions>`
       :class:`Funnel3DOptions <highcharts_maps.options.plot_options.funnel.Funnel3DOptions>`
@@ -382,6 +385,8 @@ Core Components
       :class:`ParentNodeOptions <highcharts_maps.options.plot_options.packedbubble.ParentNodeOptions>`
   * - :mod:`.options.plot_options.pareto <highcharts_maps.options.plot_options.pareto>`
     - :class:`ParetoOptions <highcharts_maps.options.plot_options.pareto.ParetoOptions>`
+  * - :mod:`.options.plot_options.pictorial <highcharts_maps.options.plot_options.pictorial>`
+    - :class:`PictorialOptions <highcharts_maps.options.plot_options.pictorial.PictorialOptions>`
   * - :mod:`.options.plot_options.pie <highcharts_maps.options.plot_options.pie>`
     - :class:`PieOptions <highcharts_maps.options.plot_options.pie.PieOptions>`
       :class:`VariablePieOptions <highcharts_maps.options.plot_options.pie.VariablePieOptions>`
@@ -401,12 +406,17 @@ Core Components
       :class:`Scatter3DOptions <highcharts_maps.options.plot_options.scatter.Scatter3DOptions>`
   * - :mod:`.options.plot_options.series <highcharts_maps.options.plot_options.series>`
     - :class:`SeriesOptions <highcharts_maps.options.plot_options.series.SeriesOptions>`
+  * - :mod:`.options.plot_options.sonification <highcharts_maps.options.plot_options.sonification>`
+    - :class:`SeriesSonification <highcharts_maps.options.plot_options.sonification.SeriesSonification>`
   * - :mod:`.options.plot_options.spline <highcharts_maps.options.plot_options.spline>`
     - :class:`SplineOptions <highcharts_maps.options.plot_options.spline.SplineOptions>`
   * - :mod:`.options.plot_options.sunburst <highcharts_maps.options.plot_options.sunburst>`
     - :class:`SunburstOptions <highcharts_maps.options.plot_options.sunburst.SunburstOptions>`
   * - :mod:`.options.plot_options.timeline <highcharts_maps.options.plot_options.timeline>`
     - :class:`TimelineOptions <highcharts_maps.options.plot_options.timeline.TimelineOptions>`
+  * - :mod:`.options.plot_options.treegraph <highcharts_maps.options.plot_options.treegraph>`
+    - :class:`TreegraphOptions <highcharts_maps.options.plot_options.treegraph.TreegraphOptions>`
+      :class:`TreegraphEvents <highcharts_maps.options.plot_options.treegraph.TreegraphEvents>`
   * - :mod:`.options.plot_options.treemap <highcharts_maps.options.plot_options.treemap>`
     - :class:`TreemapOptions <highcharts_maps.options.plot_options.treemap.TreemapOptions>`
   * - :mod:`.options.plot_options.vector <highcharts_maps.options.plot_options.vector>`
@@ -478,6 +488,7 @@ Core Components
       :class:`CartesianValueData <highcharts_maps.options.series.data.cartesian.CartesianValueData>`
   * - :mod:`.options.series.data.connections <highcharts_maps.options.series.data.connections>`
     - :class:`ConnectionData <highcharts_maps.options.series.data.connections.ConnectionData>`
+      :class:`FlowmapData <highcharts_maps.options.series.data.connections.FlowmapData>`
       :class:`WeightedConnectionData <highcharts_maps.options.series.data.connections.WeightedConnectionData>`
       :class:`OutgoingWeightedConnectionData <highcharts_maps.options.series.data.connections.OutgoingWeightedConnectionData>`
       :class:`ConnectionBase <highcharts_maps.options.series.data.connections.ConnectionBase>`
@@ -504,6 +515,8 @@ Core Components
       :class:`SinglePointBase <highcharts_maps.options.series.data.single_point.SinglePointBase>`
   * - :mod:`.options.series.data.sunburst <highcharts_maps.options.series.data.sunburst>`
     - :class:`SunburstData <highcharts_maps.options.series.data.sunburst.SunburstData>`
+  * - :mod:`.options.series.data.treegraph <highcharts_maps.options.series.data.treegraph>`
+    - :class:`TreegraphData <highcharts_maps.options.series.data.treegraph.TreegraphData>`
   * - :mod:`.options.series.data.treemap <highcharts_maps.options.series.data.treemap>`
     - :class:`TreemapData <highcharts_maps.options.series.data.treemap.TreemapData>`
   * - :mod:`.options.series.data.vector <highcharts_maps.options.series.data.vector>`
@@ -517,6 +530,9 @@ Core Components
   * - :mod:`.options.series.dumbbell <highcharts_maps.options.series.dumbbell>`
     - :class:`DumbbellSeries <highcharts_maps.options.series.dumbbell.DumbbellSeries>`
       :class:`LollipopSeries <highcharts_maps.options.series.dumbbell.LollipopSeries>`
+  * - :mod:`.options.series.flowmap <highcharts_maps.options.series.flowmap>`
+    - :class:`FlowmapSeries <highcharts_maps.options.series.flowmap.FlowmapSeries>`
+      :class:`GeoHeatmapSeries <highcharts_maps.options.series.flowmap.GeoHeatmapSeries>`
   * - :mod:`.options.series.funnel <highcharts_maps.options.series.funnel>`
     - :class:`FunnelSeries <highcharts_maps.options.series.funnel.FunnelSeries>`
       :class:`Funnel3DSeries <highcharts_maps.options.series.funnel.Funnel3DSeries>`
@@ -541,6 +557,9 @@ Core Components
     - :class:`PackedBubbleSeries <highcharts_maps.options.series.packedbubble.PackedBubbleSeries>`
   * - :mod:`.options.series.pareto <highcharts_maps.options.series.pareto>`
     - :class:`ParetoSeries <highcharts_maps.options.series.pareto.ParetoSeries>`
+  * - :mod:`.options.series.pictorial <highcharts_maps.options.series.pictorial>`
+    - :class:`PictorialSeries <highcharts_maps.options.series.pictorial.PictorialSeries>`
+      :class:`PictorialPaths <highcharts_maps.options.series.pictorial.PictorialPaths>`
   * - :mod:`.options.series.pie <highcharts_maps.options.series.pie>`
     - :class:`PieSeries <highcharts_maps.options.series.pie.PieSeries>`
       :class:`VariablePieSeries <highcharts_maps.options.series.pie.VariablePieSeries>`
@@ -562,6 +581,8 @@ Core Components
     - :class:`SunburstSeries <highcharts_maps.options.series.sunburst.SunburstSeries>`
   * - :mod:`.options.series.timeline <highcharts_maps.options.series.timeline>`
     - :class:`TimelineSeries <highcharts_maps.options.series.timeline.TimelineSeries>`
+  * - :mod:`.options.series.treegraph <highcharts_maps.options.series.treegraph>`
+    - :class:`TreegraphSeries <highcharts_maps.options.series.treegraph.TreegraphSeries>`
   * - :mod:`.options.series.treemap <highcharts_maps.options.series.treemap>`
     - :class:`TreemapSeries <highcharts_maps.options.series.treemap.TreemapSeries>`
   * - :mod:`.options.series.vector <highcharts_maps.options.series.vector>`
@@ -570,6 +591,22 @@ Core Components
     - :class:`VennSeries <highcharts_maps.options.series.venn.VennSeries>`
   * - :mod:`.options.series.wordcloud <highcharts_maps.options.series.wordcloud>`
     - :class:`WordcloudSeries <highcharts_maps.options.series.wordcloud.WordcloudSeries>`
+  * - :mod:`.options.sonification <highcharts_maps.options.sonification>`
+    - :class:`SonificationOptions <highcharts_maps.options.sonification.SonificationOptions>`
+  * - :mod:`.options.sonification.grouping <highcharts_maps.options.sonification.grouping>`
+    - :class:`PointGrouping <highcharts_maps.options.sonification.grouping.SonificationGrouping>`
+  * - :mod:`.options.sonification.mapping <highcharts_maps.options.sonification.mapping>`
+    - :class:`SonificationMapping <highcharts_maps.options.sonification.mapping.SonificationMapping>`
+      :class:`AudioParameter <highcahrts_core.options.sonification.mapping.AudioParameter>`
+      :class:`AudioFilter <highcharts_maps.options.sonification.mapping.AudioFilter>`
+      :class:`PitchParameter <highcharts_maps.options.sonification.mapping.PitchParameter>`
+      :class:`TremoloEffect <highcahrts_core.options.sonification.mapping.TremoloEffect>`
+  * - :mod:`.options.sonification.track_configurations <highcharts_maps.options.sonification.track_configurations>`
+    - :class:`InstrumentTrackConfiguration <highcharts_maps.options.sonification.track_configurations.InstrumentTrackConfiguration>`
+      :class:`SpeechTrackConfiguration <highcharts_maps.options.sonification.track_configurations.SpeechTrackConfiguration>`
+      :class:`ContextTrackConfiguration <highcharts_maps.options.sonification.track_configurations.ContextTrackConfiguration>`
+      :class:`TrackConfigurationBase <highcharts_maps.options.sonification.track_configurations.TrackConfigurationBase>`
+      :class:`ActiveWhen <highcharts_maps.options.sonification.track_configurations.ActiveWhen>`
   * - :mod:`.options.subtitle <highcharts_maps.options.subtitle>`
     - :class:`Subtitle <highcharts_maps.options.subtitle.Subtitle>`
   * - :mod:`.options.time <highcharts_maps.options.time>`
@@ -641,6 +678,7 @@ Core Components
     - :class:`Jitter <highcharts_maps.utility_classes.jitter.Jitter>`
   * - :mod:`.utility_classes.markers <highcharts_maps.utility_classes.markers>`
     - :class:`Marker <highcharts_maps.utility_classes.markers.Marker>`
+      :class:`FlowmapMarker <highcharts_maps.utility_classes.markers.FlowmapMarker>`
   * - :mod:`.utility_classes.menus <highcharts_maps.utility_classes.menus>`
     - :class:`MenuObject <highcharts_maps.utility_classes.menus.MenuObject>`
       :class:`MenuItem <highcharts_maps.utility_classes.menus.MenuItem>`

docs/_static/geoheatmap-example.png

@@ -29,6 +29,7 @@
   plot_options/index
   responsive
   series/index
+  sonification/index
   subtitle
   time
   title
@@ -292,6 +293,9 @@ Sub-components
   * - :mod:`.options.plot_options.dumbbell <highcharts_maps.options.plot_options.dumbbell>`
     - :class:`DumbbellOptions <highcharts_maps.options.plot_options.dumbbell.DumbbellOptions>`
       :class:`LollipopOptions <highcharts_maps.options.plot_options.dumbbell.LollipopOptions>`
+  * - :mod:`.options.plot_options.flowmap <highcharts_maps.options.plot_options.flowmap>`
+    - :class:`FlowmapOptions <highcharts_maps.options.plot_options.flowmap.FlowmapOptions>`
+      :class:`GeoHeatmapOptions <highcharts_maps.options.series.flowmap.GeoHeatmapOptions>`
   * - :mod:`.options.plot_options.funnel <highcharts_maps.options.plot_options.funnel>`
     - :class:`FunnelOptions <highcharts_maps.options.plot_options.funnel.FunnelOptions>`
       :class:`Funnel3DOptions <highcharts_maps.options.plot_options.funnel.Funnel3DOptions>`
@@ -334,6 +338,8 @@ Sub-components
       :class:`ParentNodeOptions <highcharts_maps.options.plot_options.packedbubble.ParentNodeOptions>`
   * - :mod:`.options.plot_options.pareto <highcharts_maps.options.plot_options.pareto>`
     - :class:`ParetoOptions <highcharts_maps.options.plot_options.pareto.ParetoOptions>`
+  * - :mod:`.options.plot_options.pictorial <highcharts_maps.options.plot_options.pictorial>`
+    - :class:`PictorialOptions <highcharts_maps.options.plot_options.pictorial.PictorialOptions>`
   * - :mod:`.options.plot_options.pie <highcharts_maps.options.plot_options.pie>`
     - :class:`PieOptions <highcharts_maps.options.plot_options.pie.PieOptions>`
       :class:`VariablePieOptions <highcharts_maps.options.plot_options.pie.VariablePieOptions>`
@@ -353,12 +359,17 @@ Sub-components
       :class:`Scatter3DOptions <highcharts_maps.options.plot_options.scatter.Scatter3DOptions>`
   * - :mod:`.options.plot_options.series <highcharts_maps.options.plot_options.series>`
     - :class:`SeriesOptions <highcharts_maps.options.plot_options.series.SeriesOptions>`
+  * - :mod:`.options.plot_options.sonification <highcharts_maps.options.plot_options.sonification>`
+    - :class:`SeriesSonification <highcharts_maps.options.plot_options.sonification.SeriesSonification>`
   * - :mod:`.options.plot_options.spline <highcharts_maps.options.plot_options.spline>`
     - :class:`SplineOptions <highcharts_maps.options.plot_options.spline.SplineOptions>`
   * - :mod:`.options.plot_options.sunburst <highcharts_maps.options.plot_options.sunburst>`
     - :class:`SunburstOptions <highcharts_maps.options.plot_options.sunburst.SunburstOptions>`
   * - :mod:`.options.plot_options.timeline <highcharts_maps.options.plot_options.timeline>`
     - :class:`TimelineOptions <highcharts_maps.options.plot_options.timeline.TimelineOptions>`
+  * - :mod:`.options.plot_options.treegraph <highcharts_maps.options.plot_options.treegraph>`
+    - :class:`TreegraphOptions <highcharts_maps.options.plot_options.treegraph.TreegraphOptions>`
+      :class:`TreegraphEvents <highcharts_maps.options.plot_options.treegraph.TreegraphEvents>`
   * - :mod:`.options.plot_options.treemap <highcharts_maps.options.plot_options.treemap>`
     - :class:`TreemapOptions <highcharts_maps.options.plot_options.treemap.TreemapOptions>`
   * - :mod:`.options.plot_options.vector <highcharts_maps.options.plot_options.vector>`
@@ -430,6 +441,7 @@ Sub-components
       :class:`CartesianValueData <highcharts_maps.options.series.data.cartesian.CartesianValueData>`
   * - :mod:`.options.series.data.connections <highcharts_maps.options.series.data.connections>`
     - :class:`ConnectionData <highcharts_maps.options.series.data.connections.ConnectionData>`
+      :class:`FlowmapData <highcharts_maps.options.series.data.connections.FlowmapData>`
       :class:`WeightedConnectionData <highcharts_maps.options.series.data.connections.WeightedConnectionData>`
       :class:`OutgoingWeightedConnectionData <highcharts_maps.options.series.data.connections.OutgoingWeightedConnectionData>`
       :class:`ConnectionBase <highcharts_maps.options.series.data.connections.ConnectionBase>`
@@ -456,6 +468,8 @@ Sub-components
       :class:`SinglePointBase <highcharts_maps.options.series.data.single_point.SinglePointBase>`
   * - :mod:`.options.series.data.sunburst <highcharts_maps.options.series.data.sunburst>`
     - :class:`SunburstData <highcharts_maps.options.series.data.sunburst.SunburstData>`
+  * - :mod:`.options.series.data.treegraph <highcharts_maps.options.series.data.treegraph>`
+    - :class:`TreegraphData <highcharts_maps.options.series.data.treegraph.TreegraphData>`
   * - :mod:`.options.series.data.treemap <highcharts_maps.options.series.data.treemap>`
     - :class:`TreemapData <highcharts_maps.options.series.data.treemap.TreemapData>`
   * - :mod:`.options.series.data.vector <highcharts_maps.options.series.data.vector>`
@@ -469,6 +483,9 @@ Sub-components
   * - :mod:`.options.series.dumbbell <highcharts_maps.options.series.dumbbell>`
     - :class:`DumbbellSeries <highcharts_maps.options.series.dumbbell.DumbbellSeries>`
       :class:`LollipopSeries <highcharts_maps.options.series.dumbbell.LollipopSeries>`
+  * - :mod:`.options.series.flowmap <highcharts_maps.options.series.flowmap>`
+    - :class:`FlowmapSeries <highcharts_maps.options.series.flowmap.FlowmapSeries>`
+      :class:`GeoHeatmapSeries <highcharts_maps.options.series.flowmap.GeoHeatmapSeries>`
   * - :mod:`.options.series.funnel <highcharts_maps.options.series.funnel>`
     - :class:`FunnelSeries <highcharts_maps.options.series.funnel.FunnelSeries>`
       :class:`Funnel3DSeries <highcharts_maps.options.series.funnel.Funnel3DSeries>`
@@ -493,6 +510,9 @@ Sub-components
     - :class:`PackedBubbleSeries <highcharts_maps.options.series.packedbubble.PackedBubbleSeries>`
   * - :mod:`.options.series.pareto <highcharts_maps.options.series.pareto>`
     - :class:`ParetoSeries <highcharts_maps.options.series.pareto.ParetoSeries>`
+  * - :mod:`.options.series.pictorial <highcharts_maps.options.series.pictorial>`
+    - :class:`PictorialSeries <highcharts_maps.options.series.pictorial.PictorialSeries>`
+      :class:`PictorialPaths <highcharts_maps.options.series.pictorial.PictorialPaths>`
   * - :mod:`.options.series.pie <highcharts_maps.options.series.pie>`
     - :class:`PieSeries <highcharts_maps.options.series.pie.PieSeries>`
       :class:`VariablePieSeries <highcharts_maps.options.series.pie.VariablePieSeries>`
@@ -514,6 +534,8 @@ Sub-components
     - :class:`SunburstSeries <highcharts_maps.options.series.sunburst.SunburstSeries>`
   * - :mod:`.options.series.timeline <highcharts_maps.options.series.timeline>`
     - :class:`TimelineSeries <highcharts_maps.options.series.timeline.TimelineSeries>`
+  * - :mod:`.options.series.treegraph <highcharts_maps.options.series.treegraph>`
+    - :class:`TreegraphSeries <highcharts_maps.options.series.treegraph.TreegraphSeries>`
   * - :mod:`.options.series.treemap <highcharts_maps.options.series.treemap>`
     - :class:`TreemapSeries <highcharts_maps.options.series.treemap.TreemapSeries>`
   * - :mod:`.options.series.vector <highcharts_maps.options.series.vector>`
@@ -522,6 +544,22 @@ Sub-components
     - :class:`VennSeries <highcharts_maps.options.series.venn.VennSeries>`
   * - :mod:`.options.series.wordcloud <highcharts_maps.options.series.wordcloud>`
     - :class:`WordcloudSeries <highcharts_maps.options.series.wordcloud.WordcloudSeries>`
+  * - :mod:`.options.sonification <highcharts_maps.options.sonification>`
+    - :class:`SonificationOptions <highcharts_maps.options.sonification.SonificationOptions>`
+  * - :mod:`.options.sonification.grouping <highcharts_maps.options.sonification.grouping>`
+    - :class:`PointGrouping <highcharts_maps.options.sonification.grouping.SonificationGrouping>`
+  * - :mod:`.options.sonification.mapping <highcharts_maps.options.sonification.mapping>`
+    - :class:`SonificationMapping <highcharts_maps.options.sonification.mapping.SonificationMapping>`
+      :class:`AudioParameter <highcahrts_core.options.sonification.mapping.AudioParameter>`
+      :class:`AudioFilter <highcharts_maps.options.sonification.mapping.AudioFilter>`
+      :class:`PitchParameter <highcharts_maps.options.sonification.mapping.PitchParameter>`
+      :class:`TremoloEffect <highcahrts_core.options.sonification.mapping.TremoloEffect>`
+  * - :mod:`.options.sonification.track_configurations <highcharts_maps.options.sonification.track_configurations>`
+    - :class:`InstrumentTrackConfiguration <highcharts_maps.options.sonification.track_configurations.InstrumentTrackConfiguration>`
+      :class:`SpeechTrackConfiguration <highcharts_maps.options.sonification.track_configurations.SpeechTrackConfiguration>`
+      :class:`ContextTrackConfiguration <highcharts_maps.options.sonification.track_configurations.ContextTrackConfiguration>`
+      :class:`TrackConfigurationBase <highcharts_maps.options.sonification.track_configurations.TrackConfigurationBase>`
+      :class:`ActiveWhen <highcharts_maps.options.sonification.track_configurations.ActiveWhen>`
   * - :mod:`.options.subtitle <highcharts_maps.options.subtitle>`
     - :class:`Subtitle <highcharts_maps.options.subtitle.Subtitle>`
   * - :mod:`.options.time <highcharts_maps.options.time>`