Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 5.3 KB

toolkit.rst

File metadata and controls

105 lines (81 loc) · 5.3 KB
Raw

Toolkit Components and Product Roadmap

The Toolkit's Contents

The Highcharts for Python toolkit features a number of separate Python libraries which extend the core Highcharts Core for Python (highcharts-core) library. This pattern maps quite naturally to the Highcharts JS design, where multiple other modules extend the core Highcharts JS library.

The Highcharts for Python toolkit includes two categories of tools:

.. tabs::

  .. tab:: Core Visualization Libraries

    These libraries correspond to each of the major Highcharts
    `products <https://www.highcharts.com/products/>`__:

    * **Highcharts Core for Python**: This is the foundational Python library, and is required
      by all other components in the toolkit. It provides the fundamental Python classes
      that are used throughout the toolkit, and importantly provides 100% coverage for the
      functionality in the
      `Highcharts Core <https://www.highcharts.com/products/highcharts>`__ JavaScript
      library. For more details, please see the relevant `Highcharts Core for Python documentation <https://core-docs.highchartspython.com>`__.
    * **Highcharts Stock for Python**: This is the Python wrapper for the
      `Highcharts Stock <https://www.highcharts.com/products/stock>`__
      JavaScript library, which provides extensive visualizations for time series and
      stock price visualizations. For more details, please see the relevant
      `Highcharts Stock for Python documentation <https://stock-docs.highchartspython.com>`__
    * **Highcharts Maps for Python**: This is the Python wrapper for the
      `Highcharts Maps <https://www.highcharts.com/products/maps>`__
      JavaScript library, which provides extensive geographic data visualization options
      with rich interactive maps. For more details, please see the relevant
      `Highcharts Maps for Python documentation <https://maps-docs.highchartspython.com>`__
    * **Highcharts Gantt for Python**: This is the Python wrapper for the
      `Highcharts Gantt <https://www.highcharts.com/products/gantt>`__
      JavaScript library, which provides rich visualizations for resource allocation over
      time. For more details, please see the relevant
      `Highcharts Gantt for Python documentation <https://gantt-docs.highchartspython.com>`__


  .. tab:: Extensions

    These libraries serve as extensions to the core visualization libraries, providing
    specialized functionality to simplify usage of **Highcharts for Python** in various
    applications:

    .. note::

      A number of extension libraries are in progress, but have not yet been released. Watch this space for news soon!

    .. note::

      All extensions to **Highcharts for Python** support visualizations produced in any
      of the core libraries. For more information, please see
      :doc:`Supported Visualizations <visualizations>`.

The Toolkit's Roadmap

There are a number of features (and in some cases complete components) slated for development. While detailed write-ups of each feature can be found in the respective project project repo, the lists below provides some high-level information.

.. tabs::

  .. tab:: Core Visualization Libraries

    * Needed Script Tags ( :issue:`4` ). It would be helpful for **Highcharts Stock for Python**
      to support the production of the relevant ``<script/>`` tags needed to include the
      Highcharts JS modules that are needed to render a specific chart (and to *not*
      include the modules that are not needed).
    * Support for Explicit Defaults ( :issue:`5` ). Currently, Highcharts default values
      are always presented as :obj:`None <python:None>` in outputs within Python, and are
      stripped from the serialized JSON or JS literal representation of all objects
      (because that way the Highcharts JS library applies its default). While this is
      valuable to minimize irrelevant data and shrink content passed along the wire, it
      does force developers to track / remember / understand the Highcharts defaults
      (which are called out in the docs, obviously - but still...it's a pain). So in the
      Zen of Python spirit that "explicit is better than implicit", there needs to be a
      mechanism for users of the library to *explicitly* request that default values are
      accessible in Python and shown when serializing the chart configuration.
    * Styled Mode Configuration ( :issue:`6` ). While :term:`styled mode` can currently be
      enabled in **Highcharts Stock for Python**, the library does not provide for the actual
      definition or configuration of Highcharts CSS. It would be good if it did, so that
      all Highcharts-related configuration could be handled within the library.

  .. tab:: Extensions

    * Watch this space...we'll be announcing some new extensions soon.

Additional Tools Needed?

Are you looking for additional tools that are not already part of the Highcharts for Python toolkit? Drop us a note with a feature request in our Github Issues Page.