Skip to content

PR for v.1.1.0 #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 26, 2023
Merged

PR for v.1.1.0 #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
13ad50f
Added Sonification support.
hcpchris Apr 26, 2023
65cbf9b
Added Treegraph support.
hcpchris Apr 26, 2023
bd174bd
Added Pictorial series type support.
hcpchris Apr 26, 2023
55a4695
Fixed link in changelog.
hcpchris Apr 26, 2023
442131a
Added docs about unsupported series types on export.
hcpchris Apr 26, 2023
a2c5bb1
Updated docs with v.11.0.0 support info.
hcpchris Apr 26, 2023
06c3aca
Added new series types to visualization docs.
hcpchris Apr 26, 2023
d3a0ef7
Merge pull request #20 from highcharts-for-python/18-add-support-for-…
hcpchris Apr 26, 2023
ada3363
Merge branch 'master' into develop
hcpchris Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
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>`__.

* **FIXED:** Fixed missing ``TreegraphOptions`` / ``TreegraphSeries`` series type.

---------------

Release 1.0.1
=========================================

Expand Down
2 changes: 2 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,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 Gantt for Python** is fully integrated with the broader Python ecosystem,
featuring native integrations with:

Expand Down
Binary file added docs/_static/flowmap-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/geoheatmap-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/pictorial-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/treegraph-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,8 @@ Core Components
:class:`ParentNodeOptions <highcharts_gantt.options.plot_options.packedbubble.ParentNodeOptions>`
* - :mod:`.options.plot_options.pareto <highcharts_gantt.options.plot_options.pareto>`
- :class:`ParetoOptions <highcharts_gantt.options.plot_options.pareto.ParetoOptions>`
* - :mod:`.options.plot_options.pictorial <highcharts_gantt.options.plot_options.pictorial>`
- :class:`PictorialOptions <highcharts_gantt.options.plot_options.pictorial.PictorialOptions>`
* - :mod:`.options.plot_options.pie <highcharts_gantt.options.plot_options.pie>`
- :class:`PieOptions <highcharts_gantt.options.plot_options.pie.PieOptions>`
:class:`VariablePieOptions <highcharts_gantt.options.plot_options.pie.VariablePieOptions>`
Expand Down Expand Up @@ -553,12 +555,17 @@ Core Components
:class:`Scatter3DOptions <highcharts_gantt.options.plot_options.scatter.Scatter3DOptions>`
* - :mod:`.options.plot_options.series <highcharts_gantt.options.plot_options.series>`
- :class:`SeriesOptions <highcharts_gantt.options.plot_options.series.SeriesOptions>`
* - :mod:`.options.plot_options.sonification <highcharts_gantt.options.plot_options.sonification>`
- :class:`SeriesSonification <highcharts_gantt.options.plot_options.sonification.SeriesSonification>`
* - :mod:`.options.plot_options.spline <highcharts_gantt.options.plot_options.spline>`
- :class:`SplineOptions <highcharts_gantt.options.plot_options.spline.SplineOptions>`
* - :mod:`.options.plot_options.sunburst <highcharts_gantt.options.plot_options.sunburst>`
- :class:`SunburstOptions <highcharts_gantt.options.plot_options.sunburst.SunburstOptions>`
* - :mod:`.options.plot_options.timeline <highcharts_gantt.options.plot_options.timeline>`
- :class:`TimelineOptions <highcharts_gantt.options.plot_options.timeline.TimelineOptions>`
* - :mod:`.options.plot_options.treegraph <highcharts_gantt.options.plot_options.treegraph>`
- :class:`TreegraphOptions <highcharts_gantt.options.plot_options.treegraph.TreegraphOptions>`
:class:`TreegraphEvents <highcharts_gantt.options.plot_options.treegraph.TreegraphEvents>`
* - :mod:`.options.plot_options.treemap <highcharts_gantt.options.plot_options.treemap>`
- :class:`TreemapOptions <highcharts_gantt.options.plot_options.treemap.TreemapOptions>`
* - :mod:`.options.plot_options.vbp <highcharts_gantt.options.plot_options.vbp>`
Expand Down Expand Up @@ -691,6 +698,8 @@ Core Components
:class:`SinglePointBase <highcharts_gantt.options.series.data.single_point.SinglePointBase>`
* - :mod:`.options.series.data.sunburst <highcharts_gantt.options.series.data.sunburst>`
- :class:`SunburstData <highcharts_gantt.options.series.data.sunburst.SunburstData>`
* - :mod:`.options.series.data.treegraph <highcharts_gantt.options.series.data.treegraph>`
- :class:`TreegraphData <highcharts_gantt.options.series.data.treegraph.TreegraphData>`
* - :mod:`.options.series.data.treemap <highcharts_gantt.options.series.data.treemap>`
- :class:`TreemapData <highcharts_gantt.options.series.data.treemap.TreemapData>`
* - :mod:`.options.series.data.vector <highcharts_gantt.options.series.data.vector>`
Expand Down Expand Up @@ -777,6 +786,9 @@ Core Components
- :class:`PackedBubbleSeries <highcharts_gantt.options.series.packedbubble.PackedBubbleSeries>`
* - :mod:`.options.series.pareto <highcharts_gantt.options.series.pareto>`
- :class:`ParetoSeries <highcharts_gantt.options.series.pareto.ParetoSeries>`
* - :mod:`.options.series.pictorial <highcharts_gantt.options.series.pictorial>`
- :class:`PictorialSeries <highcharts_gantt.options.series.pictorial.PictorialSeries>`
:class:`PictorialPaths <highcharts_gantt.options.series.pictorial.PictorialPaths>`
* - :mod:`.options.series.pie <highcharts_gantt.options.series.pie>`
- :class:`PieSeries <highcharts_gantt.options.series.pie.PieSeries>`
:class:`VariablePieSeries <highcharts_gantt.options.series.pie.VariablePieSeries>`
Expand Down Expand Up @@ -804,6 +816,8 @@ Core Components
- :class:`SunburstSeries <highcharts_gantt.options.series.sunburst.SunburstSeries>`
* - :mod:`.options.series.timeline <highcharts_gantt.options.series.timeline>`
- :class:`TimelineSeries <highcharts_gantt.options.series.timeline.TimelineSeries>`
* - :mod:`.options.series.treegraph <highcharts_gantt.options.series.treegraph>`
- :class:`TreegraphSeries <highcharts_gantt.options.series.treegraph.TreegraphSeries>`
* - :mod:`.options.series.treemap <highcharts_gantt.options.series.treemap>`
- :class:`TreemapSeries <highcharts_gantt.options.series.treemap.TreemapSeries>`
* - :mod:`.options.series.vbp <highcharts_gantt.options.series.vbp>`
Expand All @@ -816,6 +830,22 @@ Core Components
- :class:`WordcloudSeries <highcharts_gantt.options.series.wordcloud.WordcloudSeries>`
* - :mod:`.options.series.zigzag <highcharts_gantt.options.series.zigzag>`
- :class:`ZigZagSeries <highcharts_gantt.options.series.zigzag.ZigZagSeries>`
* - :mod:`.options.sonification <highcharts_gantt.options.sonification>`
- :class:`SonificationOptions <highcharts_gantt.options.sonification.SonificationOptions>`
* - :mod:`.options.sonification.grouping <highcharts_gantt.options.sonification.grouping>`
- :class:`PointGrouping <highcharts_gantt.options.sonification.grouping.SonificationGrouping>`
* - :mod:`.options.sonification.mapping <highcharts_gantt.options.sonification.mapping>`
- :class:`SonificationMapping <highcharts_gantt.options.sonification.mapping.SonificationMapping>`
:class:`AudioParameter <highcahrts_core.options.sonification.mapping.AudioParameter>`
:class:`AudioFilter <highcharts_gantt.options.sonification.mapping.AudioFilter>`
:class:`PitchParameter <highcharts_gantt.options.sonification.mapping.PitchParameter>`
:class:`TremoloEffect <highcahrts_core.options.sonification.mapping.TremoloEffect>`
* - :mod:`.options.sonification.track_configurations <highcharts_gantt.options.sonification.track_configurations>`
- :class:`InstrumentTrackConfiguration <highcharts_gantt.options.sonification.track_configurations.InstrumentTrackConfiguration>`
:class:`SpeechTrackConfiguration <highcharts_gantt.options.sonification.track_configurations.SpeechTrackConfiguration>`
:class:`ContextTrackConfiguration <highcharts_gantt.options.sonification.track_configurations.ContextTrackConfiguration>`
:class:`TrackConfigurationBase <highcharts_gantt.options.sonification.track_configurations.TrackConfigurationBase>`
:class:`ActiveWhen <highcharts_gantt.options.sonification.track_configurations.ActiveWhen>`
* - :mod:`.options.stock_tools <highcharts_gantt.options.stock_tools>`
- :class:`StockTools <highcharts_gantt.options.stock_tools.StockTools>`
:class:`StockToolsGUI <highcharts_gantt.options.stock_tools.StockToolsGUI>`
Expand Down
26 changes: 26 additions & 0 deletions docs/api/options/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
plot_options/index
responsive
series/index
sonification/index
stock_tools/index
subtitle
time
Expand Down Expand Up @@ -505,12 +506,17 @@ Sub-components
:class:`Scatter3DOptions <highcharts_gantt.options.plot_options.scatter.Scatter3DOptions>`
* - :mod:`.options.plot_options.series <highcharts_gantt.options.plot_options.series>`
- :class:`SeriesOptions <highcharts_gantt.options.plot_options.series.SeriesOptions>`
* - :mod:`.options.plot_options.sonification <highcharts_gantt.options.plot_options.sonification>`
- :class:`SeriesSonification <highcharts_gantt.options.plot_options.sonification.SeriesSonification>`
* - :mod:`.options.plot_options.spline <highcharts_gantt.options.plot_options.spline>`
- :class:`SplineOptions <highcharts_gantt.options.plot_options.spline.SplineOptions>`
* - :mod:`.options.plot_options.sunburst <highcharts_gantt.options.plot_options.sunburst>`
- :class:`SunburstOptions <highcharts_gantt.options.plot_options.sunburst.SunburstOptions>`
* - :mod:`.options.plot_options.timeline <highcharts_gantt.options.plot_options.timeline>`
- :class:`TimelineOptions <highcharts_gantt.options.plot_options.timeline.TimelineOptions>`
* - :mod:`.options.plot_options.treegraph <highcharts_gantt.options.plot_options.treegraph>`
- :class:`TreegraphOptions <highcharts_gantt.options.plot_options.treegraph.TreegraphOptions>`
:class:`TreegraphEvents <highcharts_gantt.options.plot_options.treegraph.TreegraphEvents>`
* - :mod:`.options.plot_options.treemap <highcharts_gantt.options.plot_options.treemap>`
- :class:`TreemapOptions <highcharts_gantt.options.plot_options.treemap.TreemapOptions>`
* - :mod:`.options.plot_options.vbp <highcharts_gantt.options.plot_options.vbp>`
Expand Down Expand Up @@ -643,6 +649,8 @@ Sub-components
:class:`SinglePointBase <highcharts_gantt.options.series.data.single_point.SinglePointBase>`
* - :mod:`.options.series.data.sunburst <highcharts_gantt.options.series.data.sunburst>`
- :class:`SunburstData <highcharts_gantt.options.series.data.sunburst.SunburstData>`
* - :mod:`.options.series.data.treegraph <highcharts_gantt.options.series.data.treegraph>`
- :class:`TreegraphData <highcharts_gantt.options.series.data.treegraph.TreegraphData>`
* - :mod:`.options.series.data.treemap <highcharts_gantt.options.series.data.treemap>`
- :class:`TreemapData <highcharts_gantt.options.series.data.treemap.TreemapData>`
* - :mod:`.options.series.data.vector <highcharts_gantt.options.series.data.vector>`
Expand Down Expand Up @@ -756,6 +764,8 @@ Sub-components
- :class:`SunburstSeries <highcharts_gantt.options.series.sunburst.SunburstSeries>`
* - :mod:`.options.series.timeline <highcharts_gantt.options.series.timeline>`
- :class:`TimelineSeries <highcharts_gantt.options.series.timeline.TimelineSeries>`
* - :mod:`.options.series.treegraph <highcharts_gantt.options.series.treegraph>`
- :class:`TreegraphSeries <highcharts_gantt.options.series.treegraph.TreegraphSeries>`
* - :mod:`.options.series.treemap <highcharts_gantt.options.series.treemap>`
- :class:`TreemapSeries <highcharts_gantt.options.series.treemap.TreemapSeries>`
* - :mod:`.options.series.vbp <highcharts_gantt.options.series.vbp>`
Expand All @@ -768,6 +778,22 @@ Sub-components
- :class:`WordcloudSeries <highcharts_gantt.options.series.wordcloud.WordcloudSeries>`
* - :mod:`.options.series.zigzag <highcharts_gantt.options.series.zigzag>`
- :class:`ZigZagSeries <highcharts_gantt.options.series.zigzag.ZigZagSeries>`
* - :mod:`.options.sonification <highcharts_gantt.options.sonification>`
- :class:`SonificationOptions <highcharts_gantt.options.sonification.SonificationOptions>`
* - :mod:`.options.sonification.grouping <highcharts_gantt.options.sonification.grouping>`
- :class:`PointGrouping <highcharts_gantt.options.sonification.grouping.SonificationGrouping>`
* - :mod:`.options.sonification.mapping <highcharts_gantt.options.sonification.mapping>`
- :class:`SonificationMapping <highcharts_gantt.options.sonification.mapping.SonificationMapping>`
:class:`AudioParameter <highcahrts_core.options.sonification.mapping.AudioParameter>`
:class:`AudioFilter <highcharts_gantt.options.sonification.mapping.AudioFilter>`
:class:`PitchParameter <highcharts_gantt.options.sonification.mapping.PitchParameter>`
:class:`TremoloEffect <highcahrts_core.options.sonification.mapping.TremoloEffect>`
* - :mod:`.options.sonification.track_configurations <highcharts_gantt.options.sonification.track_configurations>`
- :class:`InstrumentTrackConfiguration <highcharts_gantt.options.sonification.track_configurations.InstrumentTrackConfiguration>`
:class:`SpeechTrackConfiguration <highcharts_gantt.options.sonification.track_configurations.SpeechTrackConfiguration>`
:class:`ContextTrackConfiguration <highcharts_gantt.options.sonification.track_configurations.ContextTrackConfiguration>`
:class:`TrackConfigurationBase <highcharts_gantt.options.sonification.track_configurations.TrackConfigurationBase>`
:class:`ActiveWhen <highcharts_gantt.options.sonification.track_configurations.ActiveWhen>`
* - :mod:`.options.stock_tools <highcharts_gantt.options.stock_tools>`
- :class:`StockTools <highcharts_gantt.options.stock_tools.StockTools>`
:class:`StockToolsGUI <highcharts_gantt.options.stock_tools.StockToolsGUI>`
Expand Down
10 changes: 10 additions & 0 deletions docs/api/options/plot_options/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
oscillators/index
packedbubble
pareto
pictorial
pie
pivot_points
points
Expand All @@ -60,9 +61,11 @@
sankey
scatter
series
sonification
spline
sunburst
timeline
treegraph
treemap
vbp
vector
Expand Down Expand Up @@ -291,6 +294,8 @@ Sub-components
:class:`ParentNodeOptions <highcharts_gantt.options.plot_options.packedbubble.ParentNodeOptions>`
* - :mod:`.options.plot_options.pareto <highcharts_gantt.options.plot_options.pareto>`
- :class:`ParetoOptions <highcharts_gantt.options.plot_options.pareto.ParetoOptions>`
* - :mod:`.options.plot_options.pictorial <highcharts_gantt.options.plot_options.pictorial>`
- :class:`PictorialOptions <highcharts_gantt.options.plot_options.pictorial.PictorialOptions>`
* - :mod:`.options.plot_options.pie <highcharts_gantt.options.plot_options.pie>`
- :class:`PieOptions <highcharts_gantt.options.plot_options.pie.PieOptions>`
:class:`VariablePieOptions <highcharts_gantt.options.plot_options.pie.VariablePieOptions>`
Expand Down Expand Up @@ -320,12 +325,17 @@ Sub-components
:class:`Scatter3DOptions <highcharts_gantt.options.plot_options.scatter.Scatter3DOptions>`
* - :mod:`.options.plot_options.series <highcharts_gantt.options.plot_options.series>`
- :class:`SeriesOptions <highcharts_gantt.options.plot_options.series.SeriesOptions>`
* - :mod:`.options.plot_options.sonification <highcharts_gantt.options.plot_options.sonification>`
- :class:`SeriesSonification <highcharts_gantt.options.plot_options.sonification.SeriesSonification>`
* - :mod:`.options.plot_options.spline <highcharts_gantt.options.plot_options.spline>`
- :class:`SplineOptions <highcharts_gantt.options.plot_options.spline.SplineOptions>`
* - :mod:`.options.plot_options.sunburst <highcharts_gantt.options.plot_options.sunburst>`
- :class:`SunburstOptions <highcharts_gantt.options.plot_options.sunburst.SunburstOptions>`
* - :mod:`.options.plot_options.timeline <highcharts_gantt.options.plot_options.timeline>`
- :class:`TimelineOptions <highcharts_gantt.options.plot_options.timeline.TimelineOptions>`
* - :mod:`.options.plot_options.treegraph <highcharts_gantt.options.plot_options.treegraph>`
- :class:`TreegraphOptions <highcharts_gantt.options.plot_options.treegraph.TreegraphOptions>`
:class:`TreegraphEvents <highcharts_gantt.options.plot_options.treegraph.TreegraphEvents>`
* - :mod:`.options.plot_options.treemap <highcharts_gantt.options.plot_options.treemap>`
- :class:`TreemapOptions <highcharts_gantt.options.plot_options.treemap.TreemapOptions>`
* - :mod:`.options.plot_options.vbp <highcharts_gantt.options.plot_options.vbp>`
Expand Down
28 changes: 28 additions & 0 deletions docs/api/options/plot_options/pictorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
##########################################################################################
:mod:`.pictorial <highcharts_gantt.options.plot_options.pictorial>`
##########################################################################################

.. contents:: Module Contents
:local:
:depth: 3
:backlinks: entry

--------------

.. module:: highcharts_gantt.options.plot_options.pictorial

********************************************************************************************************************
class: :class:`PictorialOptions <highcharts_gantt.options.plot_options.pictorial.PictorialOptions>`
********************************************************************************************************************

.. autoclass:: PictorialOptions
:members:
:inherited-members:

.. collapse:: Class Inheritance

.. inheritance-diagram:: PictorialOptions
:top-classes: highcharts_core.metaclasses.HighchartsMeta, highcharts_gantt.metaclasses.HighchartsMeta
:parts: -1

|
28 changes: 28 additions & 0 deletions docs/api/options/plot_options/sonification.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
##########################################################################################
:mod:`.sonification <highcharts_gantt.options.plot_options.sonification>`
##########################################################################################

.. contents:: Module Contents
:local:
:depth: 3
:backlinks: entry

--------------

.. module:: highcharts_gantt.options.plot_options.sonification

********************************************************************************************************************
class: :class:`SeriesSonification <highcharts_gantt.options.plot_options.sonification.SeriesSonification>`
********************************************************************************************************************

.. autoclass:: SeriesSonification
:members:
:inherited-members:

.. collapse:: Class Inheritance

.. inheritance-diagram:: SeriesSonification
:top-classes: highcharts_core.metaclasses.HighchartsMeta, highcharts_gantt.metaclasses.HighchartsMeta
:parts: -1

|
47 changes: 47 additions & 0 deletions docs/api/options/plot_options/treegraph.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
##########################################################################################
:mod:`.treegraph <highcharts_gantt.options.plot_options.treegraph>`
##########################################################################################

.. contents:: Module Contents
:local:
:depth: 3
:backlinks: entry

--------------

.. module:: highcharts_gantt.options.plot_options.treegraph

********************************************************************************************************************
class: :class:`TreegraphOptions <highcharts_gantt.options.plot_options.treegraph.TreegraphOptions>`
********************************************************************************************************************

.. autoclass:: TreegraphOptions
:members:
:inherited-members:

.. collapse:: Class Inheritance

.. inheritance-diagram:: TreegraphOptions
:top-classes: highcharts_core.metaclasses.HighchartsMeta, highcharts_gantt.metaclasses.HighchartsMeta
:parts: -1

|


--------------

********************************************************************************************************************
class: :class:`TreegraphEvents <highcharts_gantt.options.plot_options.treegraph.TreegraphEvents>`
********************************************************************************************************************

.. autoclass:: TreegraphEvents
:members:
:inherited-members:

.. collapse:: Class Inheritance

.. inheritance-diagram:: TreegraphEvents
:top-classes: highcharts_core.metaclasses.HighchartsMeta, highcharts_gantt.metaclasses.HighchartsMeta
:parts: -1

|
Loading