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

.. only:: html

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

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

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

.. _sphx_glr_recipes_heatmap_chart_plot_heatmap_chart.py:


Basic Heatmap Chart
---------------------------

Generate a heatmap chart across two categorical dimensions with a ``z_axis`` representing the value at each category pair.
The heatmap chart will be a table-like visualization where each table cell maps to a category pair and is colored based on a ``colorscale``

- The ``data`` must have one categorical column (``category_column_name``) that represents one dimension of categories and every other column of the data is a separate category on the other dimension to be compared against.
- The ``z_axis`` is required to customize how values are displayed in the heatmap
- The ``colorscale`` can be changed to format cells with a different set of colors.

.. GENERATED FROM PYTHON SOURCE LINES 13-25





.. 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="8d3fabf5-5c12-4109-a0b1-db2044f161ab" class="plotly-graph-div" style="height:610px; width:100%;"></div>            <script type="text/javascript">                window.PLOTLYENV=window.PLOTLYENV || {};                                if (document.getElementById("8d3fabf5-5c12-4109-a0b1-db2044f161ab")) {                    Plotly.newPlot(                        "8d3fabf5-5c12-4109-a0b1-db2044f161ab",                        [{"colorbar":{"tickformat":",.0f"},"colorscale":[[0.0,"#ffffff"],[0.1,"#dcf5f9"],[0.2,"#b8eaf4"],[0.3,"#95e0ee"],[0.4,"#72d5e9"],[0.5,"#2bc0de"],[0.6,"#1ea7c2"],[0.7,"#19889f"],[0.8,"#19889f"],[0.9,"#136a7c"],[1.0,"#0d4753"]],"text":[["52,740","90,878","80,690","5,902","39,960","101,096"],["60,725","117,407","91,229","6,443","47,812","116,883"],["65,850","93,979","94,533","7,879","59,558","124,944"],["56,883","82,531","81,134","7,396","49,779","112,351"],["55,578","76,388","85,110","6,904","45,951","104,823"],["60,351","86,212","91,534","6,740","49,680","112,769"],["60,202","79,003","79,137","7,443","47,575","99,937"],["58,119","87,664","79,981","6,754","46,881","98,685"],["54,547","78,128","83,906","7,343","45,640","101,032"],["56,644","82,150","90,264","7,696","48,321","109,184"],["55,652","77,063","79,617","7,994","47,608","100,877"],["57,116","84,357","82,836","8,041","49,721","101,427"],["61,497","85,032","90,278","9,751","52,000","108,192"],["59,750","82,223","86,095","9,435","51,735","102,906"],["58,370","76,136","81,401","9,889","53,411","100,102"],["59,649","83,646","86,637","9,792","56,684","102,446"],["57,870","83,954","85,854","10,521","54,214","96,938"],["61,095","86,914","87,623","11,060","56,886","97,997"],["61,544","83,216","82,019","11,209","56,394","93,998"],["62,902","83,374","90,732","11,522","59,293","97,671"]],"texttemplate":"%{text}","x":["asia_ex_china","china","europe","india","other","ucan"],"y":["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"],"z":[[52739.7,90878.3,80690.2,5902.2,39959.9,101095.9],[60724.9,117407.4,91228.6,6442.7,47812.3,116883.3],[65850.2,93978.6,94533.3,7878.6,59558.4,124943.5],[56883.3,82530.8,81134.4,7395.9,49779.0,112351.2],[55578.5,76388.5,85110.5,6903.5,45950.8,104823.3],[60350.9,86211.9,91534.2,6739.7,49679.6,112769.2],[60201.6,79002.6,79136.9,7442.7,47574.8,99937.2],[58118.9,87664.0,79981.4,6754.2,46881.4,98685.1],[54547.4,78127.7,83905.5,7342.8,45639.6,101032.1],[56644.4,82149.9,90264.4,7696.1,48320.6,109183.8],[55652.0,77063.0,79616.7,7993.8,47607.9,100877.4],[57116.2,84357.1,82835.6,8041.0,49721.3,101427.0],[61496.9,85032.1,90278.0,9750.7,51999.9,108191.7],[59749.6,82222.9,86095.1,9434.8,51734.6,102906.4],[58370.4,76136.4,81401.2,9888.7,53410.7,100102.0],[59648.7,83645.7,86637.2,9792.3,56683.8,102446.5],[57869.9,83954.3,85854.3,10521.2,54213.7,96937.6],[61094.9,86914.0,87622.7,11060.4,56886.4,97997.4],[61544.4,83216.4,82019.4,11208.7,56393.7,93998.4],[62902.4,83374.1,90731.9,11522.0,59293.4,97670.7]],"type":"heatmap"}],                        {"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"}}}},                        {"responsive": true}                    )                };            </script>        </div>
    </div>
    <br />
    <br />

.. code-block:: Python

    import pandas as pd

    from visualization_toolkit.helpers.plotly import heatmap_chart, axis, series


    fig = heatmap_chart(
        pdf,
        category_column_name="fiscal_qy",
        z_axis=axis(label="Downloads", axis_type="number"),
    )

    fig


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

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


.. _sphx_glr_download_recipes_heatmap_chart_plot_heatmap_chart.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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