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

PR for v.1.1.0

Author: hcpchris

CHANGES.rst

@@ -1,4 +1,40 @@
-Release 1.0.1
+Release 1.1.0
+=========================================
+
+* Align the API to **Highcharts (JS) v.11**. In particular, this includes:
+
+  * Updating documentation for ``options.chart.ChartOptions.styled_mode`` to align
+    to new v11 design changes.
+  * Updated documentation for ``options.series.data.base.DataBase.color_index`` to align to
+    new v11 design changes.
+  * Added new ``utility_classes.data_labels.SunburstDataLabel`` class to patch missing
+    data label ``.rotation_mode`` property.
+  * Updated ``options.plot_options.SunburstOptions.data_labels`` to accept ``SunburstDataLabel``
+    values.
+  * Updated documentation of ``options.axes.labels.AxisLabelOptions.distance`` to reflect new (or 
+    newly-documented) behavior.
+  * Added new ``utility_classes.data_labels.OrganizationDataLabel`` class to patch misisng data label ``.
+    link_text_path`` property.
+  * Updated ``options.plot_options.organization.OrganizationOptions.data_labels`` to accept ``OrganizationDataLabel``
+    values.
+  * Added ``.description_format`` property to ``options.plot_options.accessibility.TypeOptionsAccessibility``.
+  * Added ``PictorialOptions`` / ``PictorialSeries`` series type with related classes.
+  * Added ``.minor_ticks_per_major`` to ``options.axes.x_axis.XAxisOptions``.
+  * Added ``.stack_shadow`` to ``options.axes.y_axis.YAxisOptions``.
+  * Added ``.border_radius`` to ``ColumnRangeOptions`` / ``ColumnRangeSeries``.
+  * Added ``.play_as_sand`` and ``.download_midi`` to ``global_options.language.Language``.
+  * Added ``.border_radius`` to ``PieOptions`` / ``PieSeries``.
+  * Added ``.style`` to ``utility_classes.buttons.CollapseButtonConfiguration``.
+  * Added ``utility_classes.events.SimulationEvents`` and modified ``NetworkGraphOptions`` to support.
+  * Added ``options.sonification`` and all related classes.
+  * Added series-level ``SeriesSonification`` to all series.
+
+* **FIXED:** Broken heatmap and tilemap documentation links.
+* **FIXED:** Fixed missing ``TreegraphOptions`` / ``TreegraphSeries`` series type.
+
+-------------------------------
+
+Release 1.0.2
 =========================================
 
 * **DOCUMENTATION:** Added documentation of hard dependencies to the README (issue #37).

README.rst

@@ -15,6 +15,8 @@ visualization library, with full integration into the robust Python ecosystem, i
     dataframe.
   * ...and even more use-case specific integrations across the broader toolkit.
 
+The library supports Highcharts (JS) v.10.2 and higher, including Highcharts (JS) v.11.0.0.
+
 **COMPLETE DOCUMENTATION:** https://core-docs.highchartspython.com/en/latest/index.html
 
 -------------

docs/_static/flowmap-example.png

@@ -211,6 +211,7 @@ Core Components
     - :class:`XAxis <highcharts_core.options.axes.x_axis.XAxis>`
   * - :mod:`.options.axes.y_axis <highcharts_core.options.axes.y_axis>`
     - :class:`YAxis <highcharts_core.options.axes.y_axis.YAxis>`
+      :class:`StackShadow <highcharts_core.options.axes.y_axis.StackShadow>`
   * - :mod:`.options.axes.z_axis <highcharts_core.options.axes.z_axis>`
     - :class:`ZAxis <highcharts_core.options.axes.z_axis.ZAxis>`
   * - :mod:`.options.boost <highcharts_core.options.boost>`
@@ -363,6 +364,8 @@ Core Components
       :class:`ParentNodeOptions <highcharts_core.options.plot_options.packedbubble.ParentNodeOptions>`
   * - :mod:`.options.plot_options.pareto <highcharts_core.options.plot_options.pareto>`
     - :class:`ParetoOptions <highcharts_core.options.plot_options.pareto.ParetoOptions>`
+  * - :mod:`.options.plot_options.pictorial <highcharts_core.options.plot_options.pictorial>`
+    - :class:`PictorialOptions <highcharts_core.options.plot_options.pictorial.PictorialOptions>`
   * - :mod:`.options.plot_options.pie <highcharts_core.options.plot_options.pie>`
     - :class:`PieOptions <highcharts_core.options.plot_options.pie.PieOptions>`
       :class:`VariablePieOptions <highcharts_core.options.plot_options.pie.VariablePieOptions>`
@@ -382,12 +385,17 @@ Core Components
       :class:`Scatter3DOptions <highcharts_core.options.plot_options.scatter.Scatter3DOptions>`
   * - :mod:`.options.plot_options.series <highcharts_core.options.plot_options.series>`
     - :class:`SeriesOptions <highcharts_core.options.plot_options.series.SeriesOptions>`
+  * - :mod:`.options.plot_options.sonification <highcharts_core.options.plot_options.sonification>`
+    - :class:`SeriesSonification <highcharts_core.options.plot_options.sonification.SeriesSonification>`
   * - :mod:`.options.plot_options.spline <highcharts_core.options.plot_options.spline>`
     - :class:`SplineOptions <highcharts_core.options.plot_options.spline.SplineOptions>`
   * - :mod:`.options.plot_options.sunburst <highcharts_core.options.plot_options.sunburst>`
     - :class:`SunburstOptions <highcharts_core.options.plot_options.sunburst.SunburstOptions>`
   * - :mod:`.options.plot_options.timeline <highcharts_core.options.plot_options.timeline>`
     - :class:`TimelineOptions <highcharts_core.options.plot_options.timeline.TimelineOptions>`
+  * - :mod:`.options.plot_options.treegraph <highcharts_core.options.plot_options.treegraph>`
+    - :class:`TreegraphOptions <highcharts_core.options.plot_options.treegraph.TreegraphOptions>`
+      :class:`TreegraphEvents <highcharts_core.options.plot_options.treegraph.TreegraphEvents>`
   * - :mod:`.options.plot_options.treemap <highcharts_core.options.plot_options.treemap>`
     - :class:`TreemapOptions <highcharts_core.options.plot_options.treemap.TreemapOptions>`
   * - :mod:`.options.plot_options.vector <highcharts_core.options.plot_options.vector>`
@@ -475,6 +483,8 @@ Core Components
       :class:`SinglePointBase <highcharts_core.options.series.data.single_point.SinglePointBase>`
   * - :mod:`.options.series.data.sunburst <highcharts_core.options.series.data.sunburst>`
     - :class:`SunburstData <highcharts_core.options.series.data.sunburst.SunburstData>`
+  * - :mod:`.options.series.data.treegraph <highcharts_core.options.series.data.treegraph>`
+    - :class:`TreegraphData <highcharts_core.options.series.data.treegraph.TreegraphData>`
   * - :mod:`.options.series.data.treemap <highcharts_core.options.series.data.treemap>`
     - :class:`TreemapData <highcharts_core.options.series.data.treemap.TreemapData>`
   * - :mod:`.options.series.data.vector <highcharts_core.options.series.data.vector>`
@@ -512,6 +522,9 @@ Core Components
     - :class:`PackedBubbleSeries <highcharts_core.options.series.packedbubble.PackedBubbleSeries>`
   * - :mod:`.options.series.pareto <highcharts_core.options.series.pareto>`
     - :class:`ParetoSeries <highcharts_core.options.series.pareto.ParetoSeries>`
+  * - :mod:`.options.series.pictorial <highcharts_core.options.series.pictorial>`
+    - :class:`PictorialSeries <highcharts_core.options.series.pictorial.PictorialSeries>`
+      :class:`PictorialPaths <highcharts_core.options.series.pictorial.PictorialPaths>`
   * - :mod:`.options.series.pie <highcharts_core.options.series.pie>`
     - :class:`PieSeries <highcharts_core.options.series.pie.PieSeries>`
       :class:`VariablePieSeries <highcharts_core.options.series.pie.VariablePieSeries>`
@@ -533,6 +546,8 @@ Core Components
     - :class:`SunburstSeries <highcharts_core.options.series.sunburst.SunburstSeries>`
   * - :mod:`.options.series.timeline <highcharts_core.options.series.timeline>`
     - :class:`TimelineSeries <highcharts_core.options.series.timeline.TimelineSeries>`
+  * - :mod:`.options.series.treegraph <highcharts_core.options.series.treegraph>`
+    - :class:`TreegraphSeries <highcharts_core.options.series.treegraph.TreegraphSeries>`
   * - :mod:`.options.series.treemap <highcharts_core.options.series.treemap>`
     - :class:`TreemapSeries <highcharts_core.options.series.treemap.TreemapSeries>`
   * - :mod:`.options.series.vector <highcharts_core.options.series.vector>`
@@ -541,6 +556,22 @@ Core Components
     - :class:`VennSeries <highcharts_core.options.series.venn.VennSeries>`
   * - :mod:`.options.series.wordcloud <highcharts_core.options.series.wordcloud>`
     - :class:`WordcloudSeries <highcharts_core.options.series.wordcloud.WordcloudSeries>`
+  * - :mod:`.options.sonification <highcharts_core.options.sonification>`
+    - :class:`SonificationOptions <highcharts_core.options.sonification.SonificationOptions>`
+  * - :mod:`.options.sonification.grouping <highcharts_core.options.sonification.grouping>`
+    - :class:`PointGrouping <highcharts_core.options.sonification.grouping.SonificationGrouping>`
+  * - :mod:`.options.sonification.mapping <highcharts_core.options.sonification.mapping>`
+    - :class:`SonificationMapping <highcharts_core.options.sonification.mapping.SonificationMapping>`
+      :class:`AudioParameter <highcahrts_core.options.sonification.mapping.AudioParameter>`
+      :class:`AudioFilter <highcharts_core.options.sonification.mapping.AudioFilter>`
+      :class:`PitchParameter <highcharts_core.options.sonification.mapping.PitchParameter>`
+      :class:`TremoloEffect <highcahrts_core.options.sonification.mapping.TremoloEffect>`
+  * - :mod:`.options.sonification.track_configurations <highcharts_core.options.sonification.track_configurations>`
+    - :class:`InstrumentTrackConfiguration <highcharts_core.options.sonification.track_configurations.InstrumentTrackConfiguration>`
+      :class:`SpeechTrackConfiguration <highcharts_core.options.sonification.track_configurations.SpeechTrackConfiguration>`
+      :class:`ContextTrackConfiguration <highcharts_core.options.sonification.track_configurations.ContextTrackConfiguration>`
+      :class:`TrackConfigurationBase <highcharts_core.options.sonification.track_configurations.TrackConfigurationBase>`
+      :class:`ActiveWhen <highcharts_core.options.sonification.track_configurations.ActiveWhen>`
   * - :mod:`.options.subtitle <highcharts_core.options.subtitle>`
     - :class:`Subtitle <highcharts_core.options.subtitle.Subtitle>`
   * - :mod:`.options.time <highcharts_core.options.time>`
@@ -563,6 +594,7 @@ Core Components
       :class:`Separator <highcharts_core.utility_classes.breadcrumbs.Separator>`
   * - :mod:`.utility_classes.buttons <highcharts_core.utility_classes.buttons>`
     - :class:`ExportingButtons <highcharts_core.utility_classes.buttons.ExportingButtons>`
+      :class:`CollapseButtonConfiguration <highcharts_core.utility_classes.buttons.CollapseButtonConfiguration>`
       :class:`ContextButtonConfiguration <highcharts_core.utility_classes.buttons.ContextButtonConfiguration>`
       :class:`ButtonConfiguration <highcharts_core.utility_classes.buttons.ButtonConfiguration>`
       :class:`ButtonTheme <highcharts_core.utility_classes.buttons.ButtonTheme>`
@@ -573,6 +605,8 @@ Core Components
     - :class:`DataGroupingOptions <highcharts_core.utility_classes.data_grouping.DataGroupingOptions>`
   * - :mod:`.utility_classes.data_labels <highcharts_core.utility_classes.data_labels>`
     - :class:`DataLabel <highcharts_core.utility_classes.data_labels.DataLabel>`
+      :class:`SunburstDataLabel <highcharts_core.utility_classes.data_labels.SunburstDataLabel>`
+      :class:`OrganizationDataLabel <highcharts_core.utility_classes.data_labels.OrganizationDataLabel>`
       :class:`NodeDataLabel <highcharts_core.utility_classes.data_labels.NodeDataLabel>`
       :class:`Filter <highcharts_core.utility_classes.data_labels.Filter>`
   * - :mod:`.utility_classes.date_time_label_formats <highcharts_core.utility_classes.date_time_label_formats>`
@@ -583,6 +617,7 @@ Core Components
       :class:`NavigationEvents <highcharts_core.utility_classes.events.NavigationEvents>`
       :class:`PointEvents <highcharts_core.utility_classes.events.PointEvents>`
       :class:`SeriesEvents <highcharts_core.utility_classes.events.SeriesEvents>`
+      :class:`SimulationEvents <highcharts_core.utility_classes.events.SimulationEvents>`
       :class:`ClusterEvents <highcharts_core.utility_classes.events.ClusterEvents>`
       :class:`AxisEvents <highcharts_core.utility_classes.events.AxisEvents>`
       :class:`MouseEvents <highcharts_core.utility_classes.events.MouseEvents>`

docs/_static/geoheatmap-example.png

@@ -71,5 +71,6 @@ Sub-components
     - :class:`XAxis <highcharts_core.options.axes.x_axis.XAxis>`
   * - :mod:`.options.axes.y_axis <highcharts_core.options.axes.y_axis>`
     - :class:`YAxis <highcharts_core.options.axes.y_axis.YAxis>`
+      :class:`StackShadow <highcharts_core.options.axes.y_axis.StackShadow>`
   * - :mod:`.options.axes.z_axis <highcharts_core.options.axes.z_axis>`
     - :class:`ZAxis <highcharts_core.options.axes.z_axis.ZAxis>`

docs/_static/pictorial-example.png

@@ -26,3 +26,23 @@ class: :class:`YAxis <highcharts_core.options.axes.y_axis.YAxis>`
       :parts: -1
 
   |
+
+--------------
+
+.. module:: highcharts_core.options.axes.y_axis
+
+********************************************************************************************************************
+class: :class:`StackShadow <highcharts_core.options.axes.y_axis.StackShadow>`
+********************************************************************************************************************
+
+.. autoclass:: StackShadow
+  :members:
+  :inherited-members:
+
+  .. collapse:: Class Inheritance
+
+    .. inheritance-diagram:: StackShadow
+      :top-classes: highcharts_core.metaclasses.HighchartsMeta
+      :parts: -1
+
+  |