diff --git a/CHANGES.rst b/CHANGES.rst index a443aebb..fcb9dbef 100644 --- a/CHANGES.rst +++ b/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). diff --git a/README.rst b/README.rst index cde01a07..ddadf5a8 100644 --- a/README.rst +++ b/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 ------------- diff --git a/docs/_static/flowmap-example.png b/docs/_static/flowmap-example.png new file mode 100644 index 00000000..75dfc83d Binary files /dev/null and b/docs/_static/flowmap-example.png differ diff --git a/docs/_static/geoheatmap-example.png b/docs/_static/geoheatmap-example.png new file mode 100644 index 00000000..1294d4ca Binary files /dev/null and b/docs/_static/geoheatmap-example.png differ diff --git a/docs/_static/pictorial-example.png b/docs/_static/pictorial-example.png new file mode 100644 index 00000000..ddc92386 Binary files /dev/null and b/docs/_static/pictorial-example.png differ diff --git a/docs/_static/treegraph-example.png b/docs/_static/treegraph-example.png new file mode 100644 index 00000000..1b588c32 Binary files /dev/null and b/docs/_static/treegraph-example.png differ diff --git a/docs/api.rst b/docs/api.rst index 18afb93a..a0022c2b 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -211,6 +211,7 @@ Core Components - :class:`XAxis ` * - :mod:`.options.axes.y_axis ` - :class:`YAxis ` + :class:`StackShadow ` * - :mod:`.options.axes.z_axis ` - :class:`ZAxis ` * - :mod:`.options.boost ` @@ -363,6 +364,8 @@ Core Components :class:`ParentNodeOptions ` * - :mod:`.options.plot_options.pareto ` - :class:`ParetoOptions ` + * - :mod:`.options.plot_options.pictorial ` + - :class:`PictorialOptions ` * - :mod:`.options.plot_options.pie ` - :class:`PieOptions ` :class:`VariablePieOptions ` @@ -382,12 +385,17 @@ Core Components :class:`Scatter3DOptions ` * - :mod:`.options.plot_options.series ` - :class:`SeriesOptions ` + * - :mod:`.options.plot_options.sonification ` + - :class:`SeriesSonification ` * - :mod:`.options.plot_options.spline ` - :class:`SplineOptions ` * - :mod:`.options.plot_options.sunburst ` - :class:`SunburstOptions ` * - :mod:`.options.plot_options.timeline ` - :class:`TimelineOptions ` + * - :mod:`.options.plot_options.treegraph ` + - :class:`TreegraphOptions ` + :class:`TreegraphEvents ` * - :mod:`.options.plot_options.treemap ` - :class:`TreemapOptions ` * - :mod:`.options.plot_options.vector ` @@ -475,6 +483,8 @@ Core Components :class:`SinglePointBase ` * - :mod:`.options.series.data.sunburst ` - :class:`SunburstData ` + * - :mod:`.options.series.data.treegraph ` + - :class:`TreegraphData ` * - :mod:`.options.series.data.treemap ` - :class:`TreemapData ` * - :mod:`.options.series.data.vector ` @@ -512,6 +522,9 @@ Core Components - :class:`PackedBubbleSeries ` * - :mod:`.options.series.pareto ` - :class:`ParetoSeries ` + * - :mod:`.options.series.pictorial ` + - :class:`PictorialSeries ` + :class:`PictorialPaths ` * - :mod:`.options.series.pie ` - :class:`PieSeries ` :class:`VariablePieSeries ` @@ -533,6 +546,8 @@ Core Components - :class:`SunburstSeries ` * - :mod:`.options.series.timeline ` - :class:`TimelineSeries ` + * - :mod:`.options.series.treegraph ` + - :class:`TreegraphSeries ` * - :mod:`.options.series.treemap ` - :class:`TreemapSeries ` * - :mod:`.options.series.vector ` @@ -541,6 +556,22 @@ Core Components - :class:`VennSeries ` * - :mod:`.options.series.wordcloud ` - :class:`WordcloudSeries ` + * - :mod:`.options.sonification ` + - :class:`SonificationOptions ` + * - :mod:`.options.sonification.grouping ` + - :class:`PointGrouping ` + * - :mod:`.options.sonification.mapping ` + - :class:`SonificationMapping ` + :class:`AudioParameter ` + :class:`AudioFilter ` + :class:`PitchParameter ` + :class:`TremoloEffect ` + * - :mod:`.options.sonification.track_configurations ` + - :class:`InstrumentTrackConfiguration ` + :class:`SpeechTrackConfiguration ` + :class:`ContextTrackConfiguration ` + :class:`TrackConfigurationBase ` + :class:`ActiveWhen ` * - :mod:`.options.subtitle ` - :class:`Subtitle ` * - :mod:`.options.time ` @@ -563,6 +594,7 @@ Core Components :class:`Separator ` * - :mod:`.utility_classes.buttons ` - :class:`ExportingButtons ` + :class:`CollapseButtonConfiguration ` :class:`ContextButtonConfiguration ` :class:`ButtonConfiguration ` :class:`ButtonTheme ` @@ -573,6 +605,8 @@ Core Components - :class:`DataGroupingOptions ` * - :mod:`.utility_classes.data_labels ` - :class:`DataLabel ` + :class:`SunburstDataLabel ` + :class:`OrganizationDataLabel ` :class:`NodeDataLabel ` :class:`Filter ` * - :mod:`.utility_classes.date_time_label_formats ` @@ -583,6 +617,7 @@ Core Components :class:`NavigationEvents ` :class:`PointEvents ` :class:`SeriesEvents ` + :class:`SimulationEvents ` :class:`ClusterEvents ` :class:`AxisEvents ` :class:`MouseEvents ` diff --git a/docs/api/options/axes/index.rst b/docs/api/options/axes/index.rst index 0160a3bf..0a4d5996 100644 --- a/docs/api/options/axes/index.rst +++ b/docs/api/options/axes/index.rst @@ -71,5 +71,6 @@ Sub-components - :class:`XAxis ` * - :mod:`.options.axes.y_axis ` - :class:`YAxis ` + :class:`StackShadow ` * - :mod:`.options.axes.z_axis ` - :class:`ZAxis ` diff --git a/docs/api/options/axes/y_axis.rst b/docs/api/options/axes/y_axis.rst index 49bc41ea..efc35ef3 100644 --- a/docs/api/options/axes/y_axis.rst +++ b/docs/api/options/axes/y_axis.rst @@ -26,3 +26,23 @@ class: :class:`YAxis ` :parts: -1 | + +-------------- + +.. module:: highcharts_core.options.axes.y_axis + +******************************************************************************************************************** +class: :class:`StackShadow ` +******************************************************************************************************************** + +.. autoclass:: StackShadow + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: StackShadow + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/index.rst b/docs/api/options/index.rst index a4b67e6c..9581d6c8 100644 --- a/docs/api/options/index.rst +++ b/docs/api/options/index.rst @@ -28,7 +28,8 @@ pane plot_options/index responsive - series/index + series/color_index + sonification/index subtitle time title @@ -139,6 +140,7 @@ Sub-components - :class:`XAxis ` * - :mod:`.options.axes.y_axis ` - :class:`YAxis ` + :class:`StackShadow ` * - :mod:`.options.axes.z_axis ` - :class:`ZAxis ` * - :mod:`.options.boost ` @@ -291,6 +293,8 @@ Sub-components :class:`ParentNodeOptions ` * - :mod:`.options.plot_options.pareto ` - :class:`ParetoOptions ` + * - :mod:`.options.plot_options.pictorial ` + - :class:`PictorialOptions ` * - :mod:`.options.plot_options.pie ` - :class:`PieOptions ` :class:`VariablePieOptions ` @@ -310,12 +314,16 @@ Sub-components :class:`Scatter3DOptions ` * - :mod:`.options.plot_options.series ` - :class:`SeriesOptions ` + * - :mod:`.options.plot_options.sonification ` + - :class:`SeriesSonification ` * - :mod:`.options.plot_options.spline ` - :class:`SplineOptions ` * - :mod:`.options.plot_options.sunburst ` - :class:`SunburstOptions ` * - :mod:`.options.plot_options.timeline ` - :class:`TimelineOptions ` + * - :mod:`.options.plot_options.treegraph ` + - :class:`TreegraphSeries ` * - :mod:`.options.plot_options.treemap ` - :class:`TreemapOptions ` * - :mod:`.options.plot_options.vector ` @@ -403,6 +411,8 @@ Sub-components :class:`SinglePointBase ` * - :mod:`.options.series.data.sunburst ` - :class:`SunburstData ` + * - :mod:`.options.series.data.treegraph ` + - :class:`TreegraphData ` * - :mod:`.options.series.data.treemap ` - :class:`TreemapData ` * - :mod:`.options.series.data.vector ` @@ -440,6 +450,9 @@ Sub-components - :class:`PackedBubbleSeries ` * - :mod:`.options.series.pareto ` - :class:`ParetoSeries ` + * - :mod:`.options.series.pictorial ` + - :class:`PictorialSeries ` + :class:`PictorialPaths ` * - :mod:`.options.series.pie ` - :class:`PieSeries ` :class:`VariablePieSeries ` @@ -461,6 +474,8 @@ Sub-components - :class:`SunburstSeries ` * - :mod:`.options.series.timeline ` - :class:`TimelineSeries ` + * - :mod:`.options.series.treegraph ` + - :class:`TreegraphSeries ` * - :mod:`.options.series.treemap ` - :class:`TreemapSeries ` * - :mod:`.options.series.vector ` @@ -469,6 +484,22 @@ Sub-components - :class:`VennSeries ` * - :mod:`.options.series.wordcloud ` - :class:`WordcloudSeries ` + * - :mod:`.options.sonification ` + - :class:`SonificationOptions ` + * - :mod:`.options.sonification.grouping ` + - :class:`PointGrouping ` + * - :mod:`.options.sonification.mapping ` + - :class:`SonificationMapping ` + :class:`AudioParameter ` + :class:`AudioFilter ` + :class:`PitchParameter ` + :class:`TremoloEffect ` + * - :mod:`.options.sonification.track_configurations ` + - :class:`InstrumentTrackConfiguration ` + :class:`SpeechTrackConfiguration ` + :class:`ContextTrackConfiguration ` + :class:`TrackConfigurationBase ` + :class:`ActiveWhen ` * - :mod:`.options.subtitle ` - :class:`Subtitle ` * - :mod:`.options.time ` diff --git a/docs/api/options/plot_options/index.rst b/docs/api/options/plot_options/index.rst index 0fb32b9f..5fc6b343 100644 --- a/docs/api/options/plot_options/index.rst +++ b/docs/api/options/plot_options/index.rst @@ -34,6 +34,7 @@ organization packedbubble pareto + pictorial pie points polygon @@ -41,9 +42,11 @@ sankey scatter series + sonification spline sunburst timeline + treegraph treemap vector venn @@ -165,6 +168,8 @@ Sub-components :class:`ParentNodeOptions ` * - :mod:`.options.plot_options.pareto ` - :class:`ParetoOptions ` + * - :mod:`.options.plot_options.pictorial ` + - :class:`PictorialOptions ` * - :mod:`.options.plot_options.pie ` - :class:`PieOptions ` :class:`VariablePieOptions ` @@ -184,12 +189,16 @@ Sub-components :class:`Scatter3DOptions ` * - :mod:`.options.plot_options.series ` - :class:`SeriesOptions ` + * - :mod:`.options.plot_options.sonification ` + - :class:`SeriesSonification ` * - :mod:`.options.plot_options.spline ` - :class:`SplineOptions ` * - :mod:`.options.plot_options.sunburst ` - :class:`SunburstOptions ` * - :mod:`.options.plot_options.timeline ` - :class:`TimelineOptions ` + * - :mod:`.options.series.treegraph ` + - :class:`TreegraphSeries ` * - :mod:`.options.plot_options.treemap ` - :class:`TreemapOptions ` * - :mod:`.options.plot_options.vector ` diff --git a/docs/api/options/plot_options/pictorial.rst b/docs/api/options/plot_options/pictorial.rst new file mode 100644 index 00000000..509c50bc --- /dev/null +++ b/docs/api/options/plot_options/pictorial.rst @@ -0,0 +1,28 @@ +########################################################################################## +:mod:`.pictorial ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.plot_options.pictorial + +******************************************************************************************************************** +class: :class:`PictorialOptions ` +******************************************************************************************************************** + +.. autoclass:: PictorialOptions + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: PictorialOptions + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/plot_options/sonification.rst b/docs/api/options/plot_options/sonification.rst new file mode 100644 index 00000000..dd6d2ec3 --- /dev/null +++ b/docs/api/options/plot_options/sonification.rst @@ -0,0 +1,28 @@ +########################################################################################## +:mod:`.sonification ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.plot_options.sonification + +******************************************************************************************************************** +class: :class:`SeriesSonification ` +******************************************************************************************************************** + +.. autoclass:: SeriesSonification + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: SeriesSonification + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/plot_options/treegraph.rst b/docs/api/options/plot_options/treegraph.rst new file mode 100644 index 00000000..dd2ad1d0 --- /dev/null +++ b/docs/api/options/plot_options/treegraph.rst @@ -0,0 +1,47 @@ +########################################################################################## +:mod:`.treegraph ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.plot_options.treegraph + +******************************************************************************************************************** +class: :class:`TreegraphOptions ` +******************************************************************************************************************** + +.. autoclass:: TreegraphOptions + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: TreegraphOptions + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + + +-------------- + +******************************************************************************************************************** +class: :class:`TreegraphEvents ` +******************************************************************************************************************** + +.. autoclass:: TreegraphEvents + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: TreegraphEvents + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/series/data/index.rst b/docs/api/options/series/data/index.rst index 8c04cefb..6850b91b 100644 --- a/docs/api/options/series/data/index.rst +++ b/docs/api/options/series/data/index.rst @@ -22,6 +22,7 @@ range single_point sunburst + treegraph treemap vector venn @@ -78,6 +79,8 @@ Sub-components :class:`LabeledSingleXData ` :class:`ConnectedSingleXData ` :class:`SinglePointBase ` + * - :mod:`.options.series.data.treegraph ` + - :class:`TreegraphData ` * - :mod:`.options.series.data.sunburst ` - :class:`SunburstData ` * - :mod:`.options.series.data.treemap ` diff --git a/docs/api/options/series/data/treegraph.rst b/docs/api/options/series/data/treegraph.rst new file mode 100644 index 00000000..f78541ea --- /dev/null +++ b/docs/api/options/series/data/treegraph.rst @@ -0,0 +1,28 @@ +########################################################################################## +:mod:`.treegraph ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.series.data.treegraph + +******************************************************************************************************************** +class: :class:`TreegraphData ` +******************************************************************************************************************** + +.. autoclass:: TreegraphData + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: TreegraphData + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/series/index.rst b/docs/api/options/series/index.rst index 45b93da0..70d19f8d 100644 --- a/docs/api/options/series/index.rst +++ b/docs/api/options/series/index.rst @@ -31,6 +31,7 @@ organization packedbubble pareto + pictorial pie points polygon @@ -41,6 +42,7 @@ spline sunburst timeline + treegraph treemap vector venn @@ -132,6 +134,8 @@ Sub-components :class:`SinglePointBase ` * - :mod:`.options.series.data.sunburst ` - :class:`SunburstData ` + * - :mod:`.options.series.data.treegraph ` + - :class:`TreegraphData ` * - :mod:`.options.series.data.treemap ` - :class:`TreemapData ` * - :mod:`.options.series.data.vector ` @@ -169,6 +173,9 @@ Sub-components - :class:`PackedBubbleSeries ` * - :mod:`.options.series.pareto ` - :class:`ParetoSeries ` + * - :mod:`.options.series.pictorial ` + - :class:`PictorialSeries ` + :class:`PictorialPaths ` * - :mod:`.options.series.pie ` - :class:`PieSeries ` :class:`VariablePieSeries ` @@ -190,6 +197,8 @@ Sub-components - :class:`SunburstSeries ` * - :mod:`.options.series.timeline ` - :class:`TimelineSeries ` + * - :mod:`.options.series.treegraph ` + - :class:`TreegraphSeries ` * - :mod:`.options.series.treemap ` - :class:`TreemapSeries ` * - :mod:`.options.series.vector ` diff --git a/docs/api/options/series/pictorial.rst b/docs/api/options/series/pictorial.rst new file mode 100644 index 00000000..dbd7ba4a --- /dev/null +++ b/docs/api/options/series/pictorial.rst @@ -0,0 +1,48 @@ +########################################################################################## +:mod:`.pictorial ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.series.pictorial + +******************************************************************************************************************** +class: :class:`PictorialSeries ` +******************************************************************************************************************** + +.. autoclass:: PictorialSeries + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: PictorialSeries + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +-------------- + +.. module:: highcharts_core.options.series.pictorial + +******************************************************************************************************************** +class: :class:`PictorialPaths ` +******************************************************************************************************************** + +.. autoclass:: PictorialPaths + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: PictorialPaths + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/series/treegraph.rst b/docs/api/options/series/treegraph.rst new file mode 100644 index 00000000..ee30a17c --- /dev/null +++ b/docs/api/options/series/treegraph.rst @@ -0,0 +1,28 @@ +########################################################################################## +:mod:`.treegraph ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.series.treegraph + +******************************************************************************************************************** +class: :class:`TreegraphSeries ` +******************************************************************************************************************** + +.. autoclass:: TreegraphSeries + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: TreegraphSeries + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/sonification/grouping.rst b/docs/api/options/sonification/grouping.rst new file mode 100644 index 00000000..6c9429c0 --- /dev/null +++ b/docs/api/options/sonification/grouping.rst @@ -0,0 +1,28 @@ +########################################################################################## +:mod:`.grouping ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.sonification.grouping + +******************************************************************************************************************** +class: :class:`SonificationGrouping ` +******************************************************************************************************************** + +.. autoclass:: SonificationGrouping + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: PointGrouping + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/options/sonification/index.rst b/docs/api/options/sonification/index.rst new file mode 100644 index 00000000..f819f926 --- /dev/null +++ b/docs/api/options/sonification/index.rst @@ -0,0 +1,54 @@ +####################################################################### +:mod:`.options.sonification ` +####################################################################### + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +.. toctree:: + :titlesonly: + + grouping + mapping + track_configurations + +-------------- + +.. module:: highcharts_core.options.sonification + +******************************************************************************************************* +class: :class:`SonificationOptions ` +******************************************************************************************************* + +.. autoclass:: SonificationOptions + :members: + :inherited-members: + +----------------------- + +*************************** +Sub-components +*************************** + +.. list-table:: + :widths: 60 40 + :header-rows: 1 + + * - Module + - Classes / Functions + * - :mod:`.options.sonification.grouping ` + - :class:`SonificationGrouping ` + * - :mod:`.options.sonification.mapping ` + - :class:`SonificationMapping ` + :class:`AudioParameter ` + :class:`AudioFilter ` + :class:`PitchParameter ` + :class:`TremoloEffect ` + * - :mod:`.options.sonification.track_configurations ` + - :class:`InstrumentTrackConfiguration ` + :class:`SpeechTrackConfiguration ` + :class:`ContextTrackConfiguration ` + :class:`TrackConfigurationBase ` + :class:`ActiveWhen ` diff --git a/docs/api/options/sonification/mapping.rst b/docs/api/options/sonification/mapping.rst new file mode 100644 index 00000000..1d345c17 --- /dev/null +++ b/docs/api/options/sonification/mapping.rst @@ -0,0 +1,101 @@ +########################################################################################## +:mod:`.mapping ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.sonification.mapping + +******************************************************************************************************************** +class: :class:`AudioParameter ` +******************************************************************************************************************** + +.. autoclass:: AudioParameter + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: AudioParameter + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +----------------------- + +******************************************************************************************************************** +class: :class:`AudioParameter ` +******************************************************************************************************************** + +.. autoclass:: AudioParameter + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: AudioParameter + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +----------------------- + +******************************************************************************************************************** +class: :class:`AudioFilter ` +******************************************************************************************************************** + +.. autoclass:: AudioFilter + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: AudioFilter + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +----------------------- + +******************************************************************************************************************** +class: :class:`PitchParameter ` +******************************************************************************************************************** + +.. autoclass:: PitchParameter + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: PitchParameter + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +----------------------- + +******************************************************************************************************************** +class: :class:`TremoloEffect ` +******************************************************************************************************************** + +.. autoclass:: TremoloEffect + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: TremoloEffect + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + diff --git a/docs/api/options/sonification/track_configurations.rst b/docs/api/options/sonification/track_configurations.rst new file mode 100644 index 00000000..177311ac --- /dev/null +++ b/docs/api/options/sonification/track_configurations.rst @@ -0,0 +1,100 @@ +########################################################################################## +:mod:`.track_configurations ` +########################################################################################## + +.. contents:: Module Contents + :local: + :depth: 3 + :backlinks: entry + +-------------- + +.. module:: highcharts_core.options.sonification.track_configurations + +*************************************************************************************************************************************************************** +class: :class:`InstrumentTrackConfiguration ` +*************************************************************************************************************************************************************** + +.. autoclass:: InstrumentTrackConfiguration + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: InstrumentTrackConfiguration + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +--------------------- + +*************************************************************************************************************************************************************** +class: :class:`SpeechTrackConfiguration ` +*************************************************************************************************************************************************************** + +.. autoclass:: SpeechTrackConfiguration + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: SpeechTrackConfiguration + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +--------------------- + +*************************************************************************************************************************************************************** +class: :class:`ContextTrackConfiguration ` +*************************************************************************************************************************************************************** + +.. autoclass:: ContextTrackConfiguration + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: ContextTrackConfiguration + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +--------------------- + +*************************************************************************************************************************************************************** +class: :class:`ActiveWhen ` +*************************************************************************************************************************************************************** + +.. autoclass:: ActiveWhen + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: ActiveWhen + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +--------------------- + +*************************************************************************************************************************************************************** +class: :class:`TrackConfigurationBase ` +*************************************************************************************************************************************************************** + +.. autoclass:: TrackConfigurationBase + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: TrackConfigurationBase + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | diff --git a/docs/api/utility_classes/buttons.rst b/docs/api/utility_classes/buttons.rst index b1874433..c80cce83 100644 --- a/docs/api/utility_classes/buttons.rst +++ b/docs/api/utility_classes/buttons.rst @@ -29,6 +29,24 @@ class: :class:`ExportingButtons ` +******************************************************************************************************************** + +.. autoclass:: CollapseButtonConfiguration + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: CollapseButtonConfiguration + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +-------------- + ******************************************************************************************************************** class: :class:`ContextButtonConfiguration ` ******************************************************************************************************************** diff --git a/docs/api/utility_classes/data_labels.rst b/docs/api/utility_classes/data_labels.rst index abb44dd1..7f110cf8 100644 --- a/docs/api/utility_classes/data_labels.rst +++ b/docs/api/utility_classes/data_labels.rst @@ -29,6 +29,42 @@ class: :class:`DataLabel ----------------- +******************************************************************************************************************** +class: :class:`OrganizationDataLabel ` +******************************************************************************************************************** + +.. autoclass:: OrganizationDataLabel + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: OrganizationDataLabel + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +----------------- + +******************************************************************************************************************** +class: :class:`SunburstDataLabel ` +******************************************************************************************************************** + +.. autoclass:: SunburstDataLabel + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: SunburstDataLabel + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +----------------- + ******************************************************************************************************************** class: :class:`NodeDataLabel ` ******************************************************************************************************************** diff --git a/docs/api/utility_classes/events.rst b/docs/api/utility_classes/events.rst index 8841c6d9..bb2a4de1 100644 --- a/docs/api/utility_classes/events.rst +++ b/docs/api/utility_classes/events.rst @@ -101,6 +101,24 @@ class: :class:`SeriesEvents ` +******************************************************************************************************************** + +.. autoclass:: SimulationEvents + :members: + :inherited-members: + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: SimulationEvents + :top-classes: highcharts_core.metaclasses.HighchartsMeta + :parts: -1 + + | + +------------------ + ******************************************************************************************************************** class: :class:`ClusterEvents ` ******************************************************************************************************************** diff --git a/docs/api/utility_classes/index.rst b/docs/api/utility_classes/index.rst index d81a2a15..ca472ef4 100644 --- a/docs/api/utility_classes/index.rst +++ b/docs/api/utility_classes/index.rst @@ -68,6 +68,8 @@ Sub-components - :class:`DataGroupingOptions ` * - :mod:`.utility_classes.data_labels ` - :class:`DataLabel ` + :class:`SunburstDataLabel ` + :class:`OrganizationDataLabel ` :class:`NodeDataLabel ` :class:`Filter ` * - :mod:`.utility_classes.date_time_label_formats ` @@ -78,6 +80,7 @@ Sub-components :class:`NavigationEvents ` :class:`PointEvents ` :class:`SeriesEvents ` + :class:`SimulationEvents ` :class:`ClusterEvents ` :class:`AxisEvents ` :class:`MouseEvents ` diff --git a/docs/errors.rst b/docs/errors.rst index 9e933b07..675d23c0 100644 --- a/docs/errors.rst +++ b/docs/errors.rst @@ -230,6 +230,18 @@ HighchartsUnsupportedProtocolError (from :class:`ValueError ` -------------- +HighchartsUnsupportedExportError (from :class:`ValueError `) +========================================================================================== + +.. autoexception:: HighchartsUnsupportedExportError + + .. collapse:: Class Inheritance + + .. inheritance-diagram:: HighchartsUnsupportedExportError + :parts: -1 + +-------------- + HighchartsUnsupportedExportTypeError (from :class:`ValueError `) ========================================================================================== diff --git a/docs/glossary.rst b/docs/glossary.rst index 3f196df2..247ef0b0 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -210,6 +210,9 @@ Glossary * :class:`GaugeSeries ` * :class:`SolidGaugeSeries ` + Highpass + A highpass audio filter lets high frequencies through, but stops low frequencies, making the sound thinner. + JavaScript Object Literal Notation A way of representing data in JavaScript as native JavaScript objects which is necessary to maximize value from `Highcharts JS `__. @@ -267,6 +270,9 @@ Glossary Typically, JSON can be converted to JavaScript object literal notation easily...but the opposite does not hold true. + Lowpass + A lowpass audio filter lets low frequencies through, but stops high frequencies, making the sound more dull. + Metaclass A Python class that is used to define properties and methods - including abstract properties or methods which are not implemented in the metaclass itself - which are @@ -499,6 +505,9 @@ Glossary * :doc:`Supported Visualizations ` > :ref:`Technical Indicators ` + Tremolo + An audio effect with repeated changes in volume over time. + Untrimmed .. note:: diff --git a/docs/index.rst b/docs/index.rst index f7143a20..dd34bf92 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -38,6 +38,8 @@ Highcharts Core for Python .. sidebar:: Version Compatibility + **Latest Highcharts (JS) version supported:** v.11.0.0 + **Highcharts Core for Python** is designed to be compatible with: * Python 3.10 or higher, diff --git a/docs/using.rst b/docs/using.rst index fc12224f..31543290 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -701,6 +701,14 @@ environment. The actual file itself is produced using a .. include:: using/download_visualizations/_using_custom.rst + +.. warning:: + + As of Highcharts for Python v.1.1.0, the Highcharts :term:`Export Server` does not yet fully + support all of the series types added in Highcharts (JS) v.11. Attempting to programmatically download + one of those new as-yet-unsupported visualizations will generate a + :exc:`HighchartsUnsupportedExportError `. + ----------------------------- .. target-notes:: diff --git a/docs/visualizations.rst b/docs/visualizations.rst index 4a8c8b16..cb0e0083 100644 --- a/docs/visualizations.rst +++ b/docs/visualizations.rst @@ -332,6 +332,14 @@ to visualize your data. :class:`highcharts_core.options.plot_options.pareto.ParetoOptions` :class:`highcharts_core.options.series.pareto.ParetoSeries` + * - **Pictorial** + - .. figure:: _static/pictorial-example.png + :alt: Pictorial Example Chart + :width: 100% + + :class:`highcharts_core.options.plot_options.pictorial.PictorialOptions` + + :class:`highcharts_core.options.series.pictorial.PictorialSeries` * - **Pie** - .. tabs:: @@ -478,6 +486,14 @@ to visualize your data. :class:`highcharts_core.options.plot_options.timeline.TimelineOptions` :class:`highcharts_core.options.series.timeline.TimelineSeries` + * - **Treegraph** + - .. figure:: _static/treegraph-example.png + :alt: Treegraph Example Chart + :width: 100% + + :class:`highcharts_core.options.plot_options.treegraph.TreegraphOptions` + + :class:`highcharts_core.options.series.treegraph.TreegraphSeries` * - **Treemap** - .. figure:: _static/treemap-example.png :alt: Treemap Example Chart @@ -636,6 +652,22 @@ to visualize your data. * - Series Type - Screenshot + Class Links + * - **Flowmap** + - .. figure:: _static/flowmap-example.png + :alt: Flowmap Example Chart + :width: 100% + + :class:`highcharts_maps.options.plot_options.flowmap.FlowmapOptions` + + :class:`highcharts_maps.options.series.flowmap.FlowmapSeries` + * - **GeoHeatmap** + - .. figure:: _static/geoheatmap-example.png + :alt: GeoHeatmap Example Chart + :width: 100% + + :class:`highcharts_maps.options.plot_options.flowmap.GeoHeatmapOptions` + + :class:`highcharts_maps.options.series.flowmap.GeoHeatmapSeries` * - **Map** - .. figure:: _static/map-example.png :alt: Map Example Chart diff --git a/highcharts_core/__version__.py b/highcharts_core/__version__.py index a6221b3d..6df8ed02 100644 --- a/highcharts_core/__version__.py +++ b/highcharts_core/__version__.py @@ -1 +1 @@ -__version__ = '1.0.2' +__version__ = '1.1.0' \ No newline at end of file diff --git a/highcharts_core/constants.py b/highcharts_core/constants.py index 86f95ace..75e68123 100644 --- a/highcharts_core/constants.py +++ b/highcharts_core/constants.py @@ -29,6 +29,7 @@ def __eq__(self, other): 'https://code.highcharts.com/highcharts.js', 'https://code.highcharts.com/highcharts-more.js', 'https://code.highcharts.com/highcharts-3d.js', + 'https://code.highcharts.com/modules/sonification.js', 'https://code.highcharts.com/modules/accessibility.js', 'https://code.highcharts.com/modules/annotations.js', 'https://code.highcharts.com/modules/annotations-advanced.js', @@ -60,6 +61,7 @@ def __eq__(self, other): 'https://code.highcharts.com/modules/organization.js', 'https://code.highcharts.com/modules/parallel-coordinates.js', 'https://code.highcharts.com/modules/pareto.js', + 'https://code.highcharts.com/modules/pictorial.js', 'https://code.highcharts.com/modules/pyramid3d.js', 'https://code.highcharts.com/modules/series-label.js', 'https://code.highcharts.com/modules/series-on-point.js', @@ -83,6 +85,7 @@ def __eq__(self, other):