This repository has been archived by the owner on Jul 15, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
6 lines (6 loc) · 15.5 KB
/
index.html
1
2
3
4
5
6
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Makie Plotting Ecosystem</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script><link href="assets/favicon.ico" rel="icon" type="image/x-icon"/><link href="assets/syntaxtheme.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="index.html"><img src="assets/logo.png" alt="Makie Plotting Ecosystem logo"/></a><div class="docs-package-name"><span class="docs-autofit">Makie Plotting Ecosystem</span></div><form class="docs-search" action="search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href="index.html">Home</a><ul class="internal"><li><a class="tocitem" href="#Welcome-to-Makie!"><span>Welcome to Makie!</span></a></li><li><a class="tocitem" href="#Installation-and-Import"><span>Installation and Import</span></a></li><li><a class="tocitem" href="#First-Steps"><span>First Steps</span></a></li><li><a class="tocitem" href="#Makie-Ecosystem"><span>Makie Ecosystem</span></a></li><li><a class="tocitem" href="#Getting-Help"><span>Getting Help</span></a></li></ul></li><li><span class="tocitem">Basics</span><ul><li><a class="tocitem" href="basic-tutorial.html">Basic Tutorial</a></li><li><a class="tocitem" href="makielayout/tutorial.html">Layout Tutorial</a></li><li><a class="tocitem" href="animation.html">Animations</a></li><li><a class="tocitem" href="interaction.html">Observables & Interaction</a></li><li><input class="collapse-toggle" id="menuitem-2-5" type="checkbox"/><label class="tocitem" for="menuitem-2-5"><span class="docs-label">Plotting Functions</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="plotting_functions/arrows.html">arrows</a></li><li><a class="tocitem" href="plotting_functions/band.html">band</a></li><li><a class="tocitem" href="plotting_functions/barplot.html">barplot</a></li><li><a class="tocitem" href="plotting_functions/contour.html">contour</a></li><li><a class="tocitem" href="plotting_functions/contourf.html">contourf</a></li><li><a class="tocitem" href="plotting_functions/density.html">density</a></li><li><a class="tocitem" href="plotting_functions/errorbars.html">errorbars</a></li><li><a class="tocitem" href="plotting_functions/heatmap.html">heatmap</a></li><li><a class="tocitem" href="plotting_functions/hist.html">hist</a></li><li><a class="tocitem" href="plotting_functions/image.html">image</a></li><li><a class="tocitem" href="plotting_functions/lines.html">lines</a></li><li><a class="tocitem" href="plotting_functions/linesegments.html">linesegments</a></li><li><a class="tocitem" href="plotting_functions/mesh.html">mesh</a></li><li><a class="tocitem" href="plotting_functions/meshscatter.html">meshscatter</a></li><li><a class="tocitem" href="plotting_functions/poly.html">poly</a></li><li><a class="tocitem" href="plotting_functions/rangebars.html">rangebars</a></li><li><a class="tocitem" href="plotting_functions/scatter.html">scatter</a></li><li><a class="tocitem" href="plotting_functions/scatterlines.html">scatterlines</a></li><li><a class="tocitem" href="plotting_functions/stem.html">stem</a></li><li><a class="tocitem" href="plotting_functions/surface.html">surface</a></li><li><a class="tocitem" href="plotting_functions/text.html">text</a></li><li><a class="tocitem" href="plotting_functions/volume.html">volume</a></li></ul></li><li><a class="tocitem" href="theming.html">Theming</a></li></ul></li><li><span class="tocitem">Documentation</span><ul><li><a class="tocitem" href="plot_method_signatures.html">Plot Method Signatures</a></li><li><a class="tocitem" href="figure.html">Figure</a></li><li><input class="collapse-toggle" id="menuitem-3-3" type="checkbox"/><label class="tocitem" for="menuitem-3-3"><span class="docs-label">Layoutables & Widgets</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="makielayout/layoutables.html">Layoutables</a></li><li><a class="tocitem" href="makielayout/axis.html">Axis</a></li><li><a class="tocitem" href="makielayout/box.html">Box</a></li><li><a class="tocitem" href="makielayout/button.html">Button</a></li><li><a class="tocitem" href="makielayout/colorbar.html">Colorbar</a></li><li><a class="tocitem" href="makielayout/gridlayout.html">GridLayout</a></li><li><a class="tocitem" href="makielayout/label.html">Label</a></li><li><a class="tocitem" href="makielayout/legend.html">Legend</a></li><li><a class="tocitem" href="makielayout/lscene.html">LScene</a></li><li><a class="tocitem" href="makielayout/menu.html">Menu</a></li><li><a class="tocitem" href="makielayout/slider.html">Slider</a></li><li><a class="tocitem" href="makielayout/toggle.html">Toggle</a></li></ul></li><li><a class="tocitem" href="makielayout/layouting.html">How layouts work</a></li><li><a class="tocitem" href="generated/colors.html">Colors</a></li><li><a class="tocitem" href="generated/plot-attributes.html">Plot attributes</a></li><li><a class="tocitem" href="recipes.html">Plot Recipes</a></li><li><a class="tocitem" href="backends_and_output.html">Backends & Output</a></li><li><a class="tocitem" href="scenes.html">Scenes</a></li><li><a class="tocitem" href="lighting.html">Lighting</a></li><li><a class="tocitem" href="cameras.html">Cameras</a></li><li><a class="tocitem" href="faq.html">Frequently Asked Questions</a></li><li><a class="tocitem" href="abstractplotting_api.html">API Reference AbstractPlotting</a></li><li><a class="tocitem" href="makielayout/reference.html">API Reference MakieLayout</a></li><li><a class="tocitem" href="generated/axis.html">Integrated Axes (Axis2D / Axis3D)</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="index.html">Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaPlots/AbstractPlotting.jl/blob/master/docs/src/index.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><p><img src="assets/logo.png" alt="Makie"/></p><h2 id="Welcome-to-Makie!"><a class="docs-heading-anchor" href="#Welcome-to-Makie!">Welcome to Makie!</a><a id="Welcome-to-Makie!-1"></a><a class="docs-heading-anchor-permalink" href="#Welcome-to-Makie!" title="Permalink"></a></h2><p>Makie is a high-performance, extendable, and multi-platform plotting ecosystem for the <a href="https://julialang.org/">Julia</a> programming language.</p><h2 id="Installation-and-Import"><a class="docs-heading-anchor" href="#Installation-and-Import">Installation and Import</a><a id="Installation-and-Import-1"></a><a class="docs-heading-anchor-permalink" href="#Installation-and-Import" title="Permalink"></a></h2><p>Add one or more of the Makie backend packages <a href="https://github.com/JuliaPlots/GLMakie.jl"><code>GLMakie.jl</code></a> (OpenGL), <a href="https://github.com/JuliaPlots/CairoMakie.jl"><code>CairoMakie.jl</code></a> (Cairo), or <a href="https://github.com/JuliaPlots/WGLMakie.jl"><code>WGLMakie.jl</code></a> (WebGL).</p><pre><code class="language-julia">]add GLMakie
using GLMakie</code></pre><p>If you want to switch to a different backend in a running session, call that backend's <code>activate!</code> function.</p><pre><code class="language-julia">]add CairoMakie
using CairoMakie
# if, for example, GLMakie is activated already
CairoMakie.activate!()</code></pre><h2 id="First-Steps"><a class="docs-heading-anchor" href="#First-Steps">First Steps</a><a id="First-Steps-1"></a><a class="docs-heading-anchor-permalink" href="#First-Steps" title="Permalink"></a></h2><ul><li>Learn the basics of plotting with Makie in the <a href="basic-tutorial.html#Basic-Tutorial">Basic Tutorial</a></li><li>Check out how to make more complex plots and layouts in the <a href="makielayout/tutorial.html#Layout-Tutorial">Layout Tutorial</a></li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>These docs were autogenerated using:</p><ul><li>AbstractPlotting: v0.15.27</li><li>GLMakie: v0.1.30</li><li>CairoMakie: v0.3.19</li></ul><p>If you encounter errors with the code examples, check first that your installed versions are appropriate.</p></div></div><h2 id="Makie-Ecosystem"><a class="docs-heading-anchor" href="#Makie-Ecosystem">Makie Ecosystem</a><a id="Makie-Ecosystem-1"></a><a class="docs-heading-anchor-permalink" href="#Makie-Ecosystem" title="Permalink"></a></h2><table><tr><th style="text-align: left">Package</th><th style="text-align: left">Description</th></tr><tr><td style="text-align: left"><a href="https://github.com/JuliaPlots/AbstractPlotting.jl"><code>AbstractPlotting.jl</code></a></td><td style="text-align: left">Defines all infrastructure objects which can be visualized using one of the three backend packages.</td></tr><tr><td style="text-align: left"><a href="https://github.com/JuliaPlots/GLMakie.jl"><code>GLMakie.jl</code></a></td><td style="text-align: left">GPU-powered, interactive 2D and 3D plotting in standalone <code>GLFW.jl</code> windows.</td></tr><tr><td style="text-align: left"><a href="https://github.com/JuliaPlots/CairoMakie.jl"><code>CairoMakie.jl</code></a></td><td style="text-align: left"><code>Cairo.jl</code> based, non-interactive 2D backend for publication-quality vector graphics.</td></tr><tr><td style="text-align: left"><a href="https://github.com/JuliaPlots/WGLMakie.jl"><code>WGLMakie.jl</code></a></td><td style="text-align: left">WebGL-based interactive 2D and 3D plotting that runs within browsers.</td></tr></table><p>The differences between backends are explained in more details under <a href="backends_and_output.html#Backends-and-Output">Backends & Output</a>.</p><h3 id="Extension-Packages"><a class="docs-heading-anchor" href="#Extension-Packages">Extension Packages</a><a id="Extension-Packages-1"></a><a class="docs-heading-anchor-permalink" href="#Extension-Packages" title="Permalink"></a></h3><p>These packages are maintained by third parties. If you install them, keep an eye on version conflicts or downgrades as the Makie ecosystem is developing quickly so things break occasionally.</p><table><tr><th style="text-align: left">Package</th><th style="text-align: left">Description</th></tr><tr><td style="text-align: left"><a href="https://github.com/JuliaPlots/AlgebraOfGraphics.jl/"><code>AlgebraOfGraphics.jl</code></a></td><td style="text-align: left">Grammar-of-graphics style plotting, inspired by ggplot2.</td></tr><tr><td style="text-align: left"><a href="https://github.com/JuliaPlots/GeoMakie.jl"><code>GeoMakie.jl</code></a></td><td style="text-align: left">Geographic plotting utilities. Currently not maintained.</td></tr></table><h2 id="Getting-Help"><a class="docs-heading-anchor" href="#Getting-Help">Getting Help</a><a id="Getting-Help-1"></a><a class="docs-heading-anchor-permalink" href="#Getting-Help" title="Permalink"></a></h2><ol><li>Use the REPL <code>?</code> help mode.</li><li>Click this link to open a preformatted topic on the <a href="https://discourse.julialang.org/new-topic?title=Makie%20-%20Your%20question%20here&category=domain/viz&tags=Makie&body=You%20can%20write%20your%20question%20in%20this%20space.%0A%0ABefore%20asking%2C%20please%20take%20a%20minute%20to%20make%20sure%20that%20you%20have%20installed%20the%20latest%20available%20versions%20and%20have%20looked%20at%20%5Bthe%20most%20recent%20documentation%5D(http%3A%2Fmakie.juliaplots.org%2Fstable%2F)%20%3Ainnocent%3A">Julia Discourse Page</a>. If you do this manually, please use the category Domain/Visualization and tag questions with <code>Makie</code> to increase their visibility.</li><li>For casual conversation about Makie and its development, have a look at the <code>#makie</code> channel in the <a href="https://julialang.org/slack/">Julia Slack group</a>. Please direct your usage questions to <a href="https://discourse.julialang.org/new-topic?title=Makie%20-%20Your%20question%20here&category=domain/viz&tags=Makie&body=You%20can%20write%20your%20question%20in%20this%20space.%0A%0ABefore%20asking%2C%20please%20take%20a%20minute%20to%20make%20sure%20that%20you%20have%20installed%20the%20latest%20available%20versions%20and%20have%20looked%20at%20%5Bthe%20most%20recent%20documentation%5D(http%3A%2Fmakie.juliaplots.org%2Fstable%2F)%20%3Ainnocent%3A">Discourse</a> and not to Slack, to make questions and answers accessible to everybody.</li><li>For technical issues and bug reports, open an issue in the <a href="https://github.com/JuliaPlots/Makie.jl">Makie.jl</a> repository which serves as the central hub for AbstractPlotting and backend issues.</li></ol></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="basic-tutorial.html">Basic Tutorial »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Friday 19 March 2021 14:22">Friday 19 March 2021</span>. Using Julia version 1.5.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>