.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "recipes/line_chart/plot_line_chart_with_shaded_bounds.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_recipes_line_chart_plot_line_chart_with_shaded_bounds.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_recipes_line_chart_plot_line_chart_with_shaded_bounds.py:


Line Chart with Shaded Bounds
--------------------------------

Generate a line chart with adding shaded area around the line series through the ``shade_series`` function.
The shaded region will appear as a single entity on the legend but when hovering over data points, the lower and upper boundary data values are shown.

- The function ``shade_series`` is called and passed into the corresponding argument for the parent ``series`` object. This indicates the shading belongs to that series.
- The ``boundary_column_names`` argument defines which columns of the input dataset contain the data for the lower and upper bounds of the shaded region.
- The ``label`` can be set for the shaded area to name it on the legend and when hovering over data points.
- The ``color`` and ``opacity`` can optionally be set to control the style of the shaded region

.. GENERATED FROM PYTHON SOURCE LINES 14-45





.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>            <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_SVG"></script><script type="text/javascript">if (window.MathJax && window.MathJax.Hub && window.MathJax.Hub.Config) {window.MathJax.Hub.Config({SVG: {font: "STIX-Web"}});}</script>                <script type="text/javascript">window.PlotlyConfig = {MathJaxConfig: 'local'};</script>
            <script charset="utf-8" src="https://cdn.plot.ly/plotly-3.0.1.min.js"></script>                <div id="81c8e4da-e781-435a-bb20-b283ba49bc43" class="plotly-graph-div" style="height:610px; width:100%;"></div>            <script type="text/javascript">                window.PLOTLYENV=window.PLOTLYENV || {};                                if (document.getElementById("81c8e4da-e781-435a-bb20-b283ba49bc43")) {                    Plotly.newPlot(                        "81c8e4da-e781-435a-bb20-b283ba49bc43",                        [{"hovertemplate":"%{y:.1%}","line":{"color":"rgba(255,255,255,0)","width":3},"mode":"lines","name":"Margin of Error Lower Bound","showlegend":false,"x":["2020-FQ1","2020-FQ2","2020-FQ3","2020-FQ4","2021-FQ1","2021-FQ2","2021-FQ3","2021-FQ4","2022-FQ1","2022-FQ2","2022-FQ3","2022-FQ4","2023-FQ1","2023-FQ2","2023-FQ3","2023-FQ4","2024-FQ1","2024-FQ2","2024-FQ3","2024-FQ4"],"y":{"dtype":"f8","bdata":"AAAAAAAA+H8AAAAAAAD4fwAAAAAAAPh\u002fAAAAAAAA+H9FaW\u002fwhcmkvyKOdXEbDcC\u002f4Ln3cMlxy79eonprYKu0vyo6kst\u002fSK+\u002flBPtKqT8tL\u002fGVWXfFcGvv2oYPiKmRKK\u002fmA0yychZqD8M6lvmdFmsv7MRiNf1C5a\u002fFDElkuhlhL+PxwxUxr+3vxkmUwWjkpq\u002fo5dRLLe0mr\u002fCqKROQBOhvw=="},"yaxis":"y","type":"scatter"},{"fill":"tonexty","fillcolor":"rgba(171, 208, 217, 0.3)","hovertemplate":"%{y:.1%}","line":{"color":"rgba(255,255,255,0)","width":3},"mode":"lines","name":"Margin of Error Upper Bound","showlegend":false,"x":["2020-FQ1","2020-FQ2","2020-FQ3","2020-FQ4","2021-FQ1","2021-FQ2","2021-FQ3","2021-FQ4","2022-FQ1","2022-FQ2","2022-FQ3","2022-FQ4","2023-FQ1","2023-FQ2","2023-FQ3","2023-FQ4","2024-FQ1","2024-FQ2","2024-FQ3","2024-FQ4"],"y":{"dtype":"f8","bdata":"AAAAAAAA+H8AAAAAAAD4fwAAAAAAAPh\u002fAAAAAAAA+H\u002fvycNCrWmuP6QKRiV1Apq\u002fJ9pVSPlJvb\u002fx3Hu45LiTPwr5oGez6qM\u002fFhiyutVzkj9u3c1THXKjP2WNeohGd7A\u002fM1AZ\u002fz7jwj8oSddMvtmmPy2VtyOcFrQ\u002fePNUh9wMtz+wIM1YNJ19PxTQRNjw9LI\u002fsTOFzmvssj85RUdy+Q+xPw=="},"yaxis":"y","type":"scatter"},{"fill":"tonexty","fillcolor":"rgba(171, 208, 217, 0.3)","hoverinfo":"skip","hovertemplate":"%{y:.1%}","line":{"color":"rgba(255,255,255,0)","width":3},"mode":"lines","name":"Margin of Error","showlegend":true,"x":[null],"y":[null],"yaxis":"y","type":"scatter"},{"hovertemplate":"%{y:.1%}","line":{"color":"#0d4753","width":3},"mode":"lines","name":"Y\u002fY Growth","showlegend":true,"x":["2020-FQ1","2020-FQ2","2020-FQ3","2020-FQ4","2021-FQ1","2021-FQ2","2021-FQ3","2021-FQ4","2022-FQ1","2022-FQ2","2022-FQ3","2022-FQ4","2023-FQ1","2023-FQ2","2023-FQ3","2023-FQ4","2024-FQ1","2024-FQ2","2024-FQ3","2024-FQ4"],"y":{"dtype":"f8","bdata":"AAAAAAAA+H8AAAAAAAD4fwAAAAAAAPh\u002fAAAAAAAA+H9VwaikTkCDP3ZPHhZqTbO\u002felORCmMLxb9DVrd6Tnqfv0GC4seYu4a\u002fj41AvK5foL+u8C4X8Z2Iv8AEbt3NU40\u002fmdNlMbH5uD+QgxJm2v51v4Ehq1s9J50\u002fVU0QdR+ApD+E9X8O8+WlvxsN4C2QoJg\u002fkZvhBnx+mD+x4emVsgyRPw=="},"yaxis":"y","type":"scatter"}],                        {"template":{"data":{"histogram2dcontour":[{"type":"histogram2dcontour","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"choropleth":[{"type":"choropleth","colorbar":{"outlinewidth":0,"ticks":""}}],"histogram2d":[{"type":"histogram2d","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"heatmap":[{"type":"heatmap","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"contourcarpet":[{"type":"contourcarpet","colorbar":{"outlinewidth":0,"ticks":""}}],"contour":[{"type":"contour","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"surface":[{"type":"surface","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"mesh3d":[{"type":"mesh3d","colorbar":{"outlinewidth":0,"ticks":""}}],"scatter":[{"fillpattern":{"fillmode":"overlay","size":10,"solidity":0.2},"type":"scatter"}],"parcoords":[{"type":"parcoords","line":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterpolargl":[{"type":"scatterpolargl","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"bar":[{"error_x":{"color":"#2a3f5f"},"error_y":{"color":"#2a3f5f"},"marker":{"line":{"color":"#E5ECF6","width":0.5},"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"bar"}],"scattergeo":[{"type":"scattergeo","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterpolar":[{"type":"scatterpolar","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"histogram":[{"marker":{"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"histogram"}],"scattergl":[{"type":"scattergl","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatter3d":[{"type":"scatter3d","line":{"colorbar":{"outlinewidth":0,"ticks":""}},"marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scattermap":[{"type":"scattermap","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scattermapbox":[{"type":"scattermapbox","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterternary":[{"type":"scatterternary","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scattercarpet":[{"type":"scattercarpet","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"carpet":[{"aaxis":{"endlinecolor":"#2a3f5f","gridcolor":"white","linecolor":"white","minorgridcolor":"white","startlinecolor":"#2a3f5f"},"baxis":{"endlinecolor":"#2a3f5f","gridcolor":"white","linecolor":"white","minorgridcolor":"white","startlinecolor":"#2a3f5f"},"type":"carpet"}],"table":[{"cells":{"fill":{"color":"#EBF0F8"},"line":{"color":"white"}},"header":{"fill":{"color":"#C8D4E3"},"line":{"color":"white"}},"type":"table"}],"barpolar":[{"marker":{"line":{"color":"#E5ECF6","width":0.5},"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"barpolar"}],"pie":[{"automargin":true,"type":"pie"}]},"layout":{"annotations":[{"align":"left","arrowcolor":"#444444","arrowhead":0,"arrowsize":0.5,"arrowwidth":1,"bgcolor":"rgba(255,255,255,0)","bordercolor":"rgba(255,255,255,0)","borderwidth":0,"font":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"showarrow":false,"valign":"middle"}],"colorway":["#0d4753","#abd0d9","#f48d5c","#288b6f","#f4bb01","#e9514e","#19889F","#f8bca0","#61d1b1","#fedd71","#ef8280","#daeff2","#000000","#999999"],"font":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"height":610,"hoverlabel":{"align":"left","bgcolor":"rgba(255,255,255,1)","bordercolor":"#F5F5F5","font":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16}},"legend":{"bordercolor":"rgba(255,255,255,0)","font":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"grouptitlefont":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"orientation":"h","title":{"font":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"side":"top","text":""},"x":0.5,"xanchor":"center","xref":"container","y":0,"yanchor":"bottom","yref":"container"},"margin":{"b":80,"l":64,"r":64,"t":64},"paper_bgcolor":"rgba(255,255,255,0)","plot_bgcolor":"rgba(255,255,255,0)","separators":".,","shapes":[{"line":{"color":"#444444","dash":"dot","width":1},"type":"line"}],"title":{"font":{"size":18}},"xaxis":{"automargin":true,"color":"#999999","gridcolor":"#f3f3f3","linecolor":"#ebebeb","showline":true,"tickfont":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"title":{"font":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"standoff":24}},"yaxis":{"automargin":true,"color":"#999999","gridcolor":"#f3f3f3","linecolor":"#ebebeb","showline":true,"tickfont":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"title":{"font":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"standoff":24},"zerolinecolor":"#bfbfbf"},"yaxis2":{"automargin":true,"color":"#999999","gridcolor":"rgba(255,255,255,0)","linecolor":"#ebebeb","overlaying":"y","showline":true,"tickfont":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"title":{"font":{"color":"#444444","family":"Roboto,system-ui,sans-serif","size":16},"standoff":24},"zerolinecolor":"#bfbfbf"}}},"legend":{"title":{"text":""},"y":0},"xaxis":{"title":{"text":"Fiscal Quarter"},"tickmode":"array","tickangle":-45,"spikecolor":"#636363","spikethickness":1},"yaxis":{"title":{"text":"Downloads Growth Rate"},"tickmode":"array","tickvals":[-0.25,-0.2,-0.15,-0.1,-0.05,0.0,0.05,0.1,0.15,0.2],"tickformat":".1%","range":[-0.25,0.2]},"hoverlabel":{"bgcolor":"rgba(255,255,255,1)","bordercolor":"#F5F5F5"},"hovermode":"x unified"},                        {"responsive": true}                    )                };            </script>        </div>
    </div>
    <br />
    <br />

.. code-block:: Python

    import pandas as pd

    from visualization_toolkit.helpers.plotly import chart, axis, series, shade_series


    # For this example, we are simulating a margin of error by adding two columns to a dataframe
    # that add +/- bounds of 5% from the base y/y growth column
    # In production, these columns should come from the input dataframe
    pdf["lower_bound"] = pdf["yy"] - 0.05
    pdf["upper_bound"] = pdf["yy"] + 0.05

    fig = chart(
        pdf,
        x_axis=axis(column_name="fiscal_qy", label="Fiscal Quarter"),
        y1_axis=axis(label="Downloads Growth Rate", axis_type="percent"),
        chart_series=[
            series(
                column_name="yy",
                label="Y/Y Growth",
                color="dark-blue",
                shade_series=shade_series(
                    boundary_column_names=("lower_bound", "upper_bound"),
                    label="Margin of Error",
                    color="light-blue",
                    opacity=0.3,
                ),
            ),
        ],
    )

    fig


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.023 seconds)


.. _sphx_glr_download_recipes_line_chart_plot_line_chart_with_shaded_bounds.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_line_chart_with_shaded_bounds.ipynb <plot_line_chart_with_shaded_bounds.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_line_chart_with_shaded_bounds.py <plot_line_chart_with_shaded_bounds.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_line_chart_with_shaded_bounds.zip <plot_line_chart_with_shaded_bounds.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_