:orphan:

.. _chart_gallery.range:


===========
Range Plots
===========

.. Necessary Code Elements

.. ipython:: python
    :suppress:

    import vastorbit as vo

    N = 20 # Number of records

    data = vo.VastFrame({
        "date": [1990 + i for i in range(N)] * 5,
        "population1": [100 + i for i in range(N)] + [300 + i * 2 for i in range(N)] + [200 + i ** 2 - 3 * i for i in range(N)] + [50 + i ** 2 - 6 * i for i in range(N)] + [700 + i ** 2 - 10 * i for i in range(N)],
        "population2": [200 + i ** 2 - i for i in range(N)] + [1000 + i * 2 for i in range(N)] + [500 + i ** 2 - 5 * i for i in range(N)] + [900 + i ** 2 + 3 * i for i in range(N)] + [100 + i ** 2 - 0.5 * i for i in range(N)],
    })


General
-------

Let's begin by importing ``vastorbit``.

.. ipython:: python

    import vastorbit as vo

Let's generate a dataset using the following data.

.. code-block:: python
        
    N = 20 # Number of records

    data = vo.VastFrame({
        "date": [1990 + i for i in range(N)] * 5,
        "population1": [100 + i for i in range(N)] + [300 + i * 2 for i in range(N)] + [200 + i ** 2 - 3 * i for i in range(N)] + [50 + i ** 2 - 6 * i for i in range(N)] + [700 + i ** 2 - 10 * i for i in range(N)],
        "population2": [200 + i ** 2 - i for i in range(N)] + [1000 + i * 2 for i in range(N)] + [500 + i ** 2 - 5 * i for i in range(N)] + [900 + i ** 2 + 3 * i for i in range(N)] + [100 + i ** 2 - 0.5 * i for i in range(N)],
    })

In the context of data visualization, we have the flexibility to harness multiple plotting libraries to craft a wide range of graphical representations. vastorbit, as a versatile tool, provides support for several graphic libraries, such as Matplotlib and Plotly. Each of these libraries offers unique features and capabilities, allowing us to choose the most suitable one for our specific data visualization needs.

.. image:: ../../docs/source/_static/plotting_libs.png
   :width: 80%
   :align: center

.. note::
    
    To select the desired plotting library, we simply need to use the :py:func:`~vastorbit.set_option` function. vastorbit offers the flexibility to smoothly transition between different plotting libraries. In instances where a particular graphic is not supported by the chosen library or is not supported within the vastorbit framework, the tool will automatically generate a warning and then switch to an alternative library where the graphic can be created.

Please click on the tabs to view the various graphics generated by the different plotting libraries.

.. ipython:: python
    :suppress:

    import vastorbit as vo

.. tab:: Plotly

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "plotly")

    We can switch to using the ``plotly`` module.

    .. code-block:: python
        
        vo.set_option("plotting_lib", "plotly")

    In vastorbit, creating one or multiple range plots within a single graphic is a straightforward and flexible process. This feature enables you to efficiently visualize and compare multiple datasets or trends, providing you with a powerful tool for gaining insights from your data.
    
    .. tab:: Single

      .. code-block:: python
          
          data["population1"].range_plot(ts = "date")

      .. ipython:: python
          :suppress:
          :okwarning:
        
          fig = data["population1"].range_plot(ts = "date")
          fig.write_html("figures/plotting_plotly_range_single.html")

      .. raw:: html
          :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_single.html

    .. tab:: Multi

      .. code-block:: python
          
          data.range_plot(columns = ["population1", "population2"], ts = "date")

      .. ipython:: python
          :suppress:
          :okwarning:

          fig = data.range_plot(columns = ["population1", "population2"], ts = "date")
          fig.write_html("figures/plotting_plotly_range_multi.html")

      .. raw:: html
        :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_multi.html
        
.. tab:: Matplotlib

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "matplotlib")

    We can switch to using the ``matplotlib`` module.

    .. code-block:: python
        
        vo.set_option("plotting_lib", "matplotlib")

    In vastorbit, creating one or multiple range plots within a single graphic is a straightforward and flexible process. This feature enables you to efficiently visualize and compare multiple datasets or trends, providing you with a powerful tool for gaining insights from your data.

    .. tab:: Single

      .. ipython:: python
          :okwarning:

          @savefig plotting_matplotlib_range_single.png
          data["population1"].range_plot(ts = "date")
        
    .. tab:: Multi

      .. ipython:: python
          :okwarning:

          @savefig plotting_matplotlib_range_multi.png
          data.range_plot(columns = ["population1", "population2"], ts = "date")
        
_________________

Custom Parameters
-----------------

.. hint:: In vastorbit, you have a range of options for customizing your range plots. You can select custom quantiles for both the lower and upper bounds, allowing you to precisely define the range of data displayed in your range plot.

.. tab:: Plotly

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "plotly")

    **Quantiles**

    .. code-block:: python
        
        data["population1"].range_plot(ts = "date", q = (0.1, 0.9))

    .. ipython:: python
        :suppress:
        :okwarning:

        fig = data["population1"].range_plot(ts = "date", q = (0.1, 0.9))
        fig.write_html("figures/plotting_plotly_range_custom_q.html")

    .. raw:: html
        :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_custom_q.html

    .. note:: By selecting the tuple (0.1, 0.9), we are effectively utilizing the values corresponding to the first and ninth deciles of the data distribution.

.. tab:: Matplolib

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "matplotlib")

    **Quantiles**

    .. ipython:: python
        :okwarning:

        @savefig plotting_matplotlib_range_custom_q.png
        data["population1"].range_plot(ts = "date", q = (0.1, 0.9))

    .. note:: By selecting the tuple (0.1, 0.9), we are effectively utilizing the values corresponding to the first and ninth deciles of the data distribution.
        
___________________


Chart Customization
-------------------

vastorbit empowers users with a high degree of flexibility when it comes to tailoring the visual aspects of their plots. 
This customization extends to essential elements such as **color schemes**, **text labels**, and **plot sizes**, as well as a wide range of other attributes that can be fine-tuned to align with specific design preferences and analytical requirements. Whether you want to make your visualizations more visually appealing or need to convey specific insights with precision, vastorbit's customization options enable you to craft graphics that suit your exact needs.

.. Important:: Different customization parameters are available for Plotly and Matplotlib. 
    For a comprehensive list of customization features, please consult the documentation of the respective 
    libraries: `plotly <https://plotly.com/python-api-reference/>`__, `matplotlib <https://matplotlib.org/stable/api/matplotlib_configuration_api.html>`__.

Colors
~~~~~~

.. tab:: Plotly

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "plotly")

    **Custom colors**

    .. code-block:: python
        
        fig = data["population1"].range_plot(ts = "date", colors = ["red"])

    .. ipython:: python
        :suppress:
        :okwarning:

        fig = data["population1"].range_plot(ts = "date")
        fig.update_traces(marker = dict(color = "red"))
        fig.write_html("figures/plotting_plotly_range_custom_color_1.html")

    .. raw:: html
        :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_custom_color_1.html

    **Custom colors mapping for categories**

    .. note:: You can leverage all the capabilities of the Plotly object, including functions like `update_trace`.

    .. code-block:: python
        
        fig = data.range_plot(columns = ["population1", "population2"], ts = "date", colors = ["red", "orange","green"])

    .. ipython:: python
      :suppress:
      :okwarning:

      fig = data.range_plot(columns = ["population1", "population2"], ts = "date", colors = ["red", "orange","green"])                                          
      fig.write_html("figures/plotting_plotly_range_custom_color_2.html")

    .. raw:: html
        :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_custom_color_2.html

.. tab:: Matplolib

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "matplotlib")

    **Custom colors**

    .. ipython:: python
        :okwarning:

        @savefig plotting_matplotlib_range_custom_color_1.png
        data["population1"].range_plot(ts = "date", colors = ["red"])

    **Custom colors mapping for categories**

    .. ipython:: python
        :okwarning:

        @savefig plotting_matplotlib_range_custom_color_2.png
        data.range_plot(columns = ["population1", "population2"], ts = "date", colors = ["red", "orange", "green"])

____

Size
~~~~

.. tab:: Plotly

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "plotly")

    **Custom Width and Height**

    .. code-block:: python
        
        data["population1"].range_plot(ts = "date", width = 300, height = 300)

    .. ipython:: python
        :suppress:
        :okwarning:

        fig = data["population1"].range_plot(ts = "date", width = 300, height = 300)
        fig.write_html("figures/plotting_plotly_range_custom_size.html")

    .. raw:: html
        :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_custom_size.html

.. tab:: Matplolib

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "matplotlib")

    **Custom Width and Height**

    .. ipython:: python
        :okwarning:

        @savefig plotting_matplotlib_range_single_custom_size.png
        data["population1"].range_plot(ts = "date", width = 6, height = 3)

_____


Text
~~~~

.. tab:: Plotly

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "plotly")

    **Custom Title**

    .. code-block:: python
        
        data["population1"].range_plot(ts = "date").update_layout(title_text = "Custom Title")

    .. ipython:: python
        :suppress:
        :okwarning:

        fig = data["population1"].range_plot(ts = "date").update_layout(title_text = "Custom Title")
        fig.write_html("figures/plotting_plotly_range_custom_main_title.html")

    .. raw:: html
        :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_custom_main_title.html

    **Custom Legend Title Text**


    .. code-block:: python

        data.range_plot(columns = ["population1", "population2"], ts = "date", legend_title_text = "Custom Legend")

    .. ipython:: python
        :suppress:
        :okwarning:

        fig = data.range_plot(columns = ["population1", "population2"], ts = "date", legend_title_text = "Custom Legend")
        fig.write_html("figures/plotting_plotly_range_custom_legend_title.html")

    .. raw:: html
        :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_custom_legend_title.html

    **Custom Axis Titles**

    .. code-block:: python
        
        data["population1"].range_plot(ts = "date", yaxis_title = "Custom Y-Axis Title")

    .. ipython:: python
        :suppress:
        :okwarning:

        fig = data["population1"].range_plot(ts = "date", yaxis_title = "Custom Y-Axis Title")
        fig.write_html("figures/plotting_plotly_range_custom_y_title.html")

    .. raw:: html
        :file: /Users/badr.ouali/Documents/VastOrbit-master/docs/figures/plotting_plotly_range_custom_y_title.html

.. tab:: Matplolib

    .. ipython:: python
        :suppress:

        vo.set_option("plotting_lib", "matplotlib")

    **Custom Title Text**

    .. ipython:: python
        :okwarning:

        @savefig plotting_matplotlib_range_custom_title_label.png
        data["population1"].range_plot(ts = "date").set_title("Custom Title")

    **Custom Axis Titles**

    .. ipython:: python
        :okwarning:

        @savefig plotting_matplotlib_range_custom_yaxis_label.png
        data["population1"].range_plot(ts = "date").set_ylabel("Custom Y Axis")

.. ipython:: python
   :suppress:

   from vastorbit._utils._sql._sys import purge_memory
   purge_memory()