CINXE.COM
Vega-Altair: Declarative Visualization in Python — Vega-Altair 5.5.0 documentation
<!DOCTYPE html> <html lang="en" data-content_root="./" data-theme="light"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>Vega-Altair: Declarative Visualization in Python — Vega-Altair 5.5.0 documentation</title> <script data-cfasync="false"> document.documentElement.dataset.mode = localStorage.getItem("mode") || "light"; document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; </script> <!-- this give us a css class that will be invisible only if js is disabled --> <noscript> <style> .pst-js-only { display: none !important; } </style> </noscript> <!-- Loaded before other Sphinx assets --> <link href="_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" /> <link href="_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="_static/altair-plot.css?v=a673d9d3" /> <link rel="stylesheet" type="text/css" href="_static/altair-gallery.css?v=1975c9e6" /> <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=9736ff9e" /> <link rel="stylesheet" type="text/css" href="_static/custom.css?v=7c07b56e" /> <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" /> <!-- So that users can add custom icons --> <script src="_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script> <!-- Pre-loaded scripts that we'll load fully later --> <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" /> <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" /> <script src="_static/documentation_options.js?v=a385a3de"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script defer="defer" type="module" src="https://pyscript.net/releases/2024.10.1/core.js"></script> <script src="_static/clipboard.min.js?v=a7894cd8"></script> <script src="_static/copybutton.js?v=f281be69"></script> <script src="https://cdn.jsdelivr.net/npm/vega@5"></script> <script src="https://cdn.jsdelivr.net/npm/vega-lite@5.20.1"></script> <script src="https://cdn.jsdelivr.net/npm/vega-embed@6"></script> <script src="_static/design-tabs.js?v=f930bc37"></script> <script data-domain="altair-viz.github.io" defer="defer" src="https://views.scientific-python.org/js/script.js"></script> <script>DOCUMENTATION_OPTIONS.pagename = 'index';</script> <link rel="icon" href="_static/favicon.ico"/> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Overview" href="getting_started/overview.html" /> <meta name="viewport" content="width=device-width, initial-scale=1"/> <meta name="docsearch:language" content="en"/> <meta name="docsearch:version" content="5.5.0" /> </head> <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="light"> <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div> <div id="pst-scroll-pixel-helper"></div> <button type="button" class="btn rounded-pill" id="pst-back-to-top"> <i class="fa-solid fa-arrow-up"></i>Back to top</button> <dialog id="pst-search-dialog"> <form class="bd-search d-flex align-items-center" action="search.html" method="get"> <i class="fa-solid fa-magnifying-glass"></i> <input type="search" class="form-control" name="q" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> </form> </dialog> <div class="pst-async-banner-revealer d-none"> <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside> </div> <aside class="bd-header-announcement" aria-label="Announcement"> <div class="bd-header-announcement__content">This website is for version 5. You can find the documentation for version 4 <a href='https://altair-viz.github.io/altair-viz-v4/'>here</a>.</div> </aside> <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none"> <div class="bd-header__inner bd-page-width"> <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation"> <span class="fa-solid fa-bars"></span> </button> <div class="col-lg-3 navbar-header-items__start"> <div class="navbar-item"> <a class="navbar-brand logo" href="#"> <img src="_static/altair-logo-light.png" class="logo__image only-light" alt="Vega-Altair 5.5.0 documentation - Home"/> <img src="_static/altair-logo-light.png" class="logo__image only-dark pst-js-only" alt="Vega-Altair 5.5.0 documentation - Home"/> </a></div> <div class="navbar-item"><a class="navbar-brand" href="#"> <p class="title">Vega-Altair</p> </a> </div> </div> <div class="col-lg-9 navbar-header-items"> <div class="me-auto navbar-header-items__center"> <div class="navbar-item"> <nav> <ul class="bd-navbar-elements navbar-nav"> <li class="nav-item "> <a class="nav-link nav-internal" href="getting_started/overview.html"> Getting Started </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="user_guide/data.html"> User Guide </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="gallery/index.html"> Examples </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="user_guide/api.html"> API </a> </li> <li class="nav-item dropdown"> <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> More </button> <ul id="pst-nav-more-links" class="dropdown-menu"> <li class=" "> <a class="nav-link dropdown-item nav-external" href="https://github.com/vega/altair/releases"> Release Notes </a> </li> <li class=" "> <a class="nav-link dropdown-item nav-internal" href="about/roadmap.html"> About </a> </li> </ul> </li> </ul> </nav></div> </div> <div class="navbar-header-items__end"> <div class="navbar-item navbar-persistent--container"> <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="fa-solid fa-magnifying-glass"></i> <span class="search-button__default-text">Search</span> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> </button> </div> <div class="navbar-item"> <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> </button></div> <div class="navbar-item"><ul class="navbar-icon-links" aria-label="Icon Links"> <li class="nav-item"> <a href="https://github.com/vega/altair" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-github fa-lg fa-lg" aria-hidden="true"></i> <span class="sr-only">GitHub</span></a> </li> <li class="nav-item"> <a href="https://stackoverflow.com/tags/altair" title="StackOverflow" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-stack-overflow fa-xl fa-lg" aria-hidden="true"></i> <span class="sr-only">StackOverflow</span></a> </li> </ul></div> </div> </div> <div class="navbar-persistent--mobile"> <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="fa-solid fa-magnifying-glass"></i> <span class="search-button__default-text">Search</span> <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> </button> </div> </div> </header> <div class="bd-container"> <div class="bd-container__inner bd-page-width"> <dialog id="pst-primary-sidebar-modal"></dialog> <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide"> <div class="sidebar-header-items sidebar-primary__section"> <div class="sidebar-header-items__center"> <div class="navbar-item"> <nav> <ul class="bd-navbar-elements navbar-nav"> <li class="nav-item "> <a class="nav-link nav-internal" href="getting_started/overview.html"> Getting Started </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="user_guide/data.html"> User Guide </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="gallery/index.html"> Examples </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="user_guide/api.html"> API </a> </li> <li class="nav-item "> <a class="nav-link nav-external" href="https://github.com/vega/altair/releases"> Release Notes </a> </li> <li class="nav-item "> <a class="nav-link nav-internal" href="about/roadmap.html"> About </a> </li> </ul> </nav></div> </div> <div class="sidebar-header-items__end"> <div class="navbar-item"> <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip"> <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> </button></div> <div class="navbar-item"><ul class="navbar-icon-links" aria-label="Icon Links"> <li class="nav-item"> <a href="https://github.com/vega/altair" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-github fa-lg fa-lg" aria-hidden="true"></i> <span class="sr-only">GitHub</span></a> </li> <li class="nav-item"> <a href="https://stackoverflow.com/tags/altair" title="StackOverflow" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-stack-overflow fa-xl fa-lg" aria-hidden="true"></i> <span class="sr-only">StackOverflow</span></a> </li> </ul></div> </div> </div> <div class="sidebar-primary-items__end sidebar-primary__section"> </div> <div id="rtd-footer-container"></div> </div> <main id="main-content" class="bd-main" role="main"> <div class="bd-content"> <div class="bd-article-container"> <div class="bd-header-article d-print-none"></div> <div id="searchbox"></div> <article class="bd-article"> <section id="vega-altair-declarative-visualization-in-python"> <h1>Vega-Altair: Declarative Visualization in Python<a class="headerlink" href="#vega-altair-declarative-visualization-in-python" title="Link to this heading">#</a></h1> <div id="showcase"> <div class="examples"> <a class="preview" href="gallery/one_dot_per_zipcode.html" style="background-image: url(./_static/one_dot_per_zipcode-thumb.png)" ></a> <a class="preview" href="gallery/horizon_graph.html" style="background-image: url(./_static/horizon_graph-thumb.png)" ></a> <a class="preview" href="gallery/world_projections.html" style="background-image: url(./_static/world_projections-thumb.png)" ></a> <a class="preview" href="gallery/candlestick_chart.html" style="background-image: url(./_static/candlestick_chart-thumb.png)" ></a> <a class="preview" href="gallery/falkensee.html" style="background-image: url(./_static/falkensee-thumb.png)" ></a> <a class="preview" href="gallery/errorbars_with_ci.html" style="background-image: url(./_static/errorbars_with_ci-thumb.png)" ></a> <a class="preview" href="gallery/scatter_linked_brush.html" style="background-image: url(./_static/scatter_linked_brush-thumb.png)" ></a> <a class="preview" href="gallery/line_with_ci.html" style="background-image: url(./_static/line_with_ci-thumb.png)" ></a> <a class="preview" href="gallery/natural_disasters.html" style="background-image: url(./_static/natural_disasters-thumb.png)" ></a> <a class="preview" href="gallery/bar_rounded.html" style="background-image: url(./_static/bar_rounded-thumb.png)" ></a> <a class="preview" href="gallery/streamgraph.html" style="background-image: url(./_static/streamgraph-thumb.png)" ></a> <a class="preview" href="gallery/multiline_tooltip.html" style="background-image: url(./_static/multiline_tooltip-thumb.png)" ></a> <a class="preview" href="gallery/choropleth.html" style="background-image: url(./_static/choropleth-thumb.png)" ></a> <a class="preview" href="gallery/select_detail.html" style="background-image: url(./_static/select_detail-thumb.png)" ></a> <a class="preview" href="gallery/interactive_cross_highlight.html" style="background-image: url(./_static/interactive_cross_highlight-thumb.png)" ></a> <a class="preview" href="gallery/seattle_weather_interactive.html" style="background-image: url(./_static/seattle_weather_interactive-thumb.png)" ></a> <a class="preview" href="gallery/london_tube.html" style="background-image: url(./_static/london_tube-thumb.png)" ></a> <a class="preview" href="gallery/ridgeline_plot.html" style="background-image: url(./_static/ridgeline_plot-thumb.png)" ></a> <a class="preview" href="gallery/violin_plot.html" style="background-image: url(./_static/violin_plot-thumb.png)" ></a> <a class="preview" href="gallery/strip_plot.html" style="background-image: url(./_static/strip_plot-thumb.png)" ></a> <a class="preview" href="gallery/table_bubble_plot_github.html" style="background-image: url(./_static/table_bubble_plot_github-thumb.png)" ></a> <a class="preview" href="gallery/radial_chart.html" style="background-image: url(./_static/radial_chart-thumb.png)" ></a> <a class="preview" href="gallery/boxplot.html" style="background-image: url(./_static/boxplot-thumb.png)" ></a> <a class="preview" href="gallery/mosaic_with_labels.html" style="background-image: url(./_static/mosaic_with_labels-thumb.png)" ></a> </div> </div><p class="lead"><strong>Vega-Altair</strong> is a declarative visualization library for Python. Its simple, friendly and consistent API, built on top of the powerful <a class="reference external" href="http://vega.github.io/vega-lite">Vega-Lite</a> grammar, empowers you to spend less time writing code and more time exploring your data.</p> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-pt-0 sd-pb-2 sd-pl-3 sd-pr-5 startpage-grid docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-2 sd-g-xs-2 sd-g-sm-2 sd-g-md-3 sd-g-lg-3 docutils"> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Getting Started</div> <p class="sd-card-text">In the Getting Started section you can find installation instructions and a high-level overview of the main concepts.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference internal" href="getting_started/overview.html#overview"><span class="std std-ref">Getting started</span></a></div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> User Guide</div> <p class="sd-card-text">Check out the User Guides for in-depth information on the key concepts of Vega-Altair.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference internal" href="user_guide/data.html#user-guide-data"><span class="std std-ref">User guide</span></a></div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> Examples</div> <p class="sd-card-text">The Examples gallery contains a selection of different visualizations which you can create with Vega-Altair.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference internal" href="gallery/index.html#example-gallery"><span class="std std-ref">Examples</span></a></div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> API</div> <p class="sd-card-text">The API reference guide contains detailed information on all of Vega-Altair鈥檚 methods and classes.</p> </div> <a class="sd-stretched-link sd-hide-link-text reference internal" href="user_guide/api.html#api"><span class="std std-ref">api</span></a></div> </div> </div> </div> <p><em>The Vega-Altair open-source project is not affiliated with Altair Engineering, Inc.</em></p> <div class="toctree-wrapper compound"> </div> </section> </article> <footer class="prev-next-footer d-print-none"> <div class="prev-next-area"> <a class="right-next" href="getting_started/overview.html" title="next page"> <div class="prev-next-info"> <p class="prev-next-subtitle">next</p> <p class="prev-next-title">Overview</p> </div> <i class="fa-solid fa-angle-right"></i> </a> </div> </footer> </div> </div> <footer class="bd-footer-content"> </footer> </main> </div> </div> <!-- Scripts loaded after <body> so the DOM is not blocked --> <script defer src="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script> <script defer src="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script> <footer class="bd-footer"> <div class="bd-footer__inner bd-page-width"> <div class="footer-items__start"> <div class="footer-item"> <p class="copyright"> 漏 Copyright 2016-2024, Vega-Altair Developers. <br/> </p> </div> <div class="footer-item"> <p class="sphinx-version"> Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3. <br/> </p> </div> </div> <div class="footer-items__end"> <div class="footer-item"> <p class="theme-version"> Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.0. </p></div> </div> </div> </footer> </body> </html>