quickstart.rst

Quickstart: Patterns and Best Practices

Contents

• Installation
• Importing Highcharts for Python Objects
• Standardizing Your Charts
• Populating Series with Data
• Assembling Your Chart and Options
• Rendering Your Visualizations
• Downloading a Rendered Highcharts Visualization

---

Installation

---

Importing Highcharts for Python Objects

Standardizing Your Charts

.. tabs::

  .. tab:: Shared Options

    .. tabs::

      .. tab:: with JS Literal

         .. include:: using/shared_options/_with_js_literal.rst

      .. tab:: with JSON

         .. include:: using/shared_options/_with_json.rst

      .. tab:: with :class:`dict <python:dict>`

         .. include:: using/shared_options/_with_dict.rst

  .. tab:: Templates

    .. tabs::

      .. tab:: via JS Literal

        .. include:: using/templates/_with_js_literal.rst

      .. tab:: via ``.copy()``

        .. include:: using/templates/_with_copy.rst

      .. tab:: via :class:`dict <python:dict>`

        .. include:: using/templates/_with_dict.rst

---

Populating Series with Data

.. tabs::

  .. tab:: w/ ``.data``

    .. include:: using/populating_series_data/_with_data_property.rst

  .. tab:: from Array

    .. tabs::

      .. tab:: Create a New Series

        .. include:: using/populating_series_data/_new_from_array.rst

      .. tab:: Update an Existing Series

        .. include:: using/populating_series_data/_load_from_array.rst

  .. tab:: from CSV

    .. tabs::

      .. tab:: Create a New Series

        .. include:: using/populating_series_data/_new_from_csv.rst

      .. tab:: Update an Existing Series

        .. include:: using/populating_series_data/_load_from_csv.rst

  .. tab:: from Pandas

    .. tabs::

      .. tab:: Create a New Series

        .. include:: using/populating_series_data/_new_from_pandas.rst

      .. tab:: Update an Existing Series

        .. include:: using/populating_series_data/_load_from_pandas.rst

  .. tab:: from PySpark

    .. tabs::

      .. tab:: Create a New Series

        .. include:: using/populating_series_data/_new_from_pyspark.rst

      .. tab:: Update an Existing Series

        .. include:: using/populating_series_data/_load_from_pyspark.rst

---

Assembling Your Chart and Options

.. tabs::

  .. tabs:: Using Keyword Arguments

    .. include:: using/assembling_your_chart/_using_kwargs.rst

  .. tab:: Using ``.add_series()``

    .. include:: using/assembling_your_chart/_using_add_series.rst

  .. tab:: Using ``.from_series()``

    .. include:: using/assembling_your_chart/_using_from_series.rst

  .. tab:: Using ``.series``

    .. include:: using/assembling_your_chart/_using_series_property.rst

---

Rendering Your Visualizations

.. tabs::

  .. tab:: As Web Content

    .. include:: using/rendering_your_visualizations/_as_web_content.rst

  .. tab:: in Jupyter Labs or Jupyter Notebook

    .. include:: using/rendering_your_visualizations/_as_jupyter.rst

---

Downloading a Rendered Highcharts Visualization

.. tabs::

  .. tab:: Using Highsoft's Export Server

    .. include:: using/download_visualizations/_using_highsoft.rst

  .. tab:: Using a Custom Export Server

    .. include:: using/download_visualizations/_using_custom.rst