|
|
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Diagrams · Diagrams</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="`Diagram` is a primary object representing a diagram."/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Diagrams · Diagrams"/><meta property="og:type" content="website"/><meta property="og:url" content="https://diagrams.mingrammer.com/"/><meta property="og:description" content="`Diagram` is a primary object representing a diagram."/><meta property="og:image" content="https://diagrams.mingrammer.com/img/diagrams.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://diagrams.mingrammer.com/img/diagrams.png"/><link rel="shortcut icon" href="/img/diagrams.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script>
|
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
|
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
|
|
|
|
|
ga('create', 'UA-84081627-3', 'auto');
|
|
|
ga('send', 'pageview');
|
|
|
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/diagrams.ico" alt="Diagrams"/><h2 class="headerTitleWithLogo">Diagrams</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/getting-started/installation" target="_self">Docs</a></li><li class="siteNavGroupActive siteNavItemActive"><a href="/docs/guides/diagram" target="_self">Guides</a></li><li class="siteNavGroupActive"><a href="/docs/nodes/aws" target="_self">Nodes</a></li><li class=""><a href="https://github.com/mingrammer/diagrams" target="_self">GitHub</a></li><li class=""><a href="https://www.buymeacoffee.com/mingrammer" target="_self">Sponsoring</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Guides</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/getting-started/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/getting-started/examples">Examples</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Guides</h3><ul class=""><li class="navListItem navListItemActive"><a class="navItem" href="/docs/guides/diagram">Diagrams</a></li><li class="navListItem"><a class="navItem" href="/docs/guides/node">Nodes</a></li><li class="navListItem"><a class="navItem" href="/docs/guides/cluster">Clusters</a></li><li class="navListItem"><a class="navItem" href="/docs/guides/edge">Edges</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Nodes</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/nodes/onprem">OnPrem</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/aws">AWS</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/azure">Azure</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/gcp">GCP</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/ibm">IBM</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/k8s">K8S</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/alibabacloud">AlibabaCloud</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/oci">OCI</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/openstack">OpenStack</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/firebase">Firebase</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/digitalocean">DigitalOcean</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/elastic">Elastic</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/outscale">Outscale</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/generic">Generic</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/programming">Programming</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/saas">Saas</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/c4">C4</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/custom">Custom</a></li><li class="navListItem"><a class="navItem" href="/docs/nodes/gis">GIS</a></li></ul></div></div></section></div><script>
|
|
|
var coll = document.getElementsByClassName('collapsible');
|
|
|
var checkActiveCategory = true;
|
|
|
for (var i = 0; i < coll.length; i++) {
|
|
|
var links = coll[i].nextElementSibling.getElementsByTagName('*');
|
|
|
if (checkActiveCategory){
|
|
|
for (var j = 0; j < links.length; j++) {
|
|
|
if (links[j].classList.contains('navListItemActive')){
|
|
|
coll[i].nextElementSibling.classList.toggle('hide');
|
|
|
coll[i].childNodes[1].classList.toggle('rotate');
|
|
|
checkActiveCategory = false;
|
|
|
break;
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
|
|
|
coll[i].addEventListener('click', function() {
|
|
|
var arrow = this.childNodes[1];
|
|
|
arrow.classList.toggle('rotate');
|
|
|
var content = this.nextElementSibling;
|
|
|
content.classList.toggle('hide');
|
|
|
});
|
|
|
}
|
|
|
|
|
|
document.addEventListener('DOMContentLoaded', function() {
|
|
|
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
|
|
createToggler('#tocToggler', 'body', 'tocActive');
|
|
|
|
|
|
var headings = document.querySelector('.toc-headings');
|
|
|
headings && headings.addEventListener('click', function(event) {
|
|
|
var el = event.target;
|
|
|
while(el !== headings){
|
|
|
if (el.tagName === 'A') {
|
|
|
document.body.classList.remove('tocActive');
|
|
|
break;
|
|
|
} else{
|
|
|
el = el.parentNode;
|
|
|
}
|
|
|
}
|
|
|
}, false);
|
|
|
|
|
|
function createToggler(togglerSelector, targetSelector, className) {
|
|
|
var toggler = document.querySelector(togglerSelector);
|
|
|
var target = document.querySelector(targetSelector);
|
|
|
|
|
|
if (!toggler) {
|
|
|
return;
|
|
|
}
|
|
|
|
|
|
toggler.onclick = function(event) {
|
|
|
event.preventDefault();
|
|
|
|
|
|
target.classList.toggle(className);
|
|
|
};
|
|
|
}
|
|
|
});
|
|
|
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Diagrams</h1></header><article><div><span><p><code>Diagram</code> is a primary object representing a diagram.</p>
|
|
|
<h2><a class="anchor" aria-hidden="true" id="basic"></a><a href="#basic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Basic</h2>
|
|
|
<p><code>Diagram</code> represents a global diagram context.</p>
|
|
|
<p>You can create a diagram context with the <code>Diagram</code> class. The first parameter of the <code>Diagram</code> constructor will be used to generate the output filename.</p>
|
|
|
<pre><code class="hljs css language-python"><span class="hljs-keyword">from</span> diagrams <span class="hljs-keyword">import</span> Diagram
|
|
|
<span class="hljs-keyword">from</span> diagrams.aws.compute <span class="hljs-keyword">import</span> EC2
|
|
|
|
|
|
<span class="hljs-keyword">with</span> Diagram(<span class="hljs-string">"Simple Diagram"</span>):
|
|
|
EC2(<span class="hljs-string">"web"</span>)
|
|
|
</code></pre>
|
|
|
<p>If you run the above script with the command below,</p>
|
|
|
<pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> python diagram.py</span>
|
|
|
</code></pre>
|
|
|
<p>it will generate an image file with single <code>EC2</code> node drawn as <code>simple_diagram.png</code> in your working directory and open that created image file immediately.</p>
|
|
|
<h2><a class="anchor" aria-hidden="true" id="jupyter-notebooks"></a><a href="#jupyter-notebooks" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Jupyter Notebooks</h2>
|
|
|
<p>Diagrams can also be rendered directly inside Jupyter notebooks like this:</p>
|
|
|
<pre><code class="hljs css language-python"><span class="hljs-keyword">from</span> diagrams <span class="hljs-keyword">import</span> Diagram
|
|
|
<span class="hljs-keyword">from</span> diagrams.aws.compute <span class="hljs-keyword">import</span> EC2
|
|
|
|
|
|
<span class="hljs-keyword">with</span> Diagram(<span class="hljs-string">"Simple Diagram"</span>) <span class="hljs-keyword">as</span> diag:
|
|
|
EC2(<span class="hljs-string">"web"</span>)
|
|
|
diag
|
|
|
</code></pre>
|
|
|
<h2><a class="anchor" aria-hidden="true" id="options"></a><a href="#options" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Options</h2>
|
|
|
<p>You can specify the output file format with the <code>outformat</code> parameter. The default is <strong>png</strong>.</p>
|
|
|
<blockquote>
|
|
|
<p>Allowed formats are: png, jpg, svg, pdf, and dot</p>
|
|
|
</blockquote>
|
|
|
<pre><code class="hljs css language-python"><span class="hljs-keyword">from</span> diagrams <span class="hljs-keyword">import</span> Diagram
|
|
|
<span class="hljs-keyword">from</span> diagrams.aws.compute <span class="hljs-keyword">import</span> EC2
|
|
|
|
|
|
<span class="hljs-keyword">with</span> Diagram(<span class="hljs-string">"Simple Diagram"</span>, outformat=<span class="hljs-string">"jpg"</span>):
|
|
|
EC2(<span class="hljs-string">"web"</span>)
|
|
|
</code></pre>
|
|
|
<p>The <code>outformat</code> parameter also supports a list to output all the defined outputs in one call:</p>
|
|
|
<pre><code class="hljs css language-python"><span class="hljs-keyword">from</span> diagrams <span class="hljs-keyword">import</span> Diagram
|
|
|
<span class="hljs-keyword">from</span> diagrams.aws.compute <span class="hljs-keyword">import</span> EC2
|
|
|
|
|
|
<span class="hljs-keyword">with</span> Diagram(<span class="hljs-string">"Simple Diagram Multi Output"</span>, outformat=[<span class="hljs-string">"jpg"</span>, <span class="hljs-string">"png"</span>, <span class="hljs-string">"dot"</span>]):
|
|
|
EC2(<span class="hljs-string">"web"</span>)
|
|
|
</code></pre>
|
|
|
<p>You can specify the output filename with the <code>filename</code> parameter. The extension shouldn't be included, it's determined by the <code>outformat</code> parameter.</p>
|
|
|
<pre><code class="hljs css language-python"><span class="hljs-keyword">from</span> diagrams <span class="hljs-keyword">import</span> Diagram
|
|
|
<span class="hljs-keyword">from</span> diagrams.aws.compute <span class="hljs-keyword">import</span> EC2
|
|
|
|
|
|
<span class="hljs-keyword">with</span> Diagram(<span class="hljs-string">"Simple Diagram"</span>, filename=<span class="hljs-string">"my_diagram"</span>):
|
|
|
EC2(<span class="hljs-string">"web"</span>)
|
|
|
</code></pre>
|
|
|
<p>You can also disable the automatic file opening by setting the <code>show</code> parameter to <strong>false</strong>. The default is <strong>true</strong>.</p>
|
|
|
<pre><code class="hljs css language-python"><span class="hljs-keyword">from</span> diagrams <span class="hljs-keyword">import</span> Diagram
|
|
|
<span class="hljs-keyword">from</span> diagrams.aws.compute <span class="hljs-keyword">import</span> EC2
|
|
|
|
|
|
<span class="hljs-keyword">with</span> Diagram(<span class="hljs-string">"Simple Diagram"</span>, show=<span class="hljs-literal">False</span>):
|
|
|
EC2(<span class="hljs-string">"web"</span>)
|
|
|
</code></pre>
|
|
|
<p>Diagrams also allow custom Graphviz dot attributes options.</p>
|
|
|
<blockquote>
|
|
|
<p><code>graph_attr</code>, <code>node_attr</code> and <code>edge_attr</code> are supported. Here is a <a href="https://www.graphviz.org/doc/info/attrs.html">reference link</a>.</p>
|
|
|
</blockquote>
|
|
|
<pre><code class="hljs css language-python"><span class="hljs-keyword">from</span> diagrams <span class="hljs-keyword">import</span> Diagram
|
|
|
<span class="hljs-keyword">from</span> diagrams.aws.compute <span class="hljs-keyword">import</span> EC2
|
|
|
|
|
|
graph_attr = {
|
|
|
<span class="hljs-string">"fontsize"</span>: <span class="hljs-string">"45"</span>,
|
|
|
<span class="hljs-string">"bgcolor"</span>: <span class="hljs-string">"transparent"</span>
|
|
|
}
|
|
|
|
|
|
<span class="hljs-keyword">with</span> Diagram(<span class="hljs-string">"Simple Diagram"</span>, show=<span class="hljs-literal">False</span>, graph_attr=graph_attr):
|
|
|
EC2(<span class="hljs-string">"web"</span>)
|
|
|
</code></pre>
|
|
|
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 4/13/2024</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/getting-started/examples"><span class="arrow-prev">← </span><span>Examples</span></a><a class="docs-next button" href="/docs/guides/node"><span>Nodes</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#basic">Basic</a></li><li><a href="#jupyter-notebooks">Jupyter Notebooks</a></li><li><a href="#options">Options</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/diagrams.ico" alt="Diagrams" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/getting-started/installation">Getting Started</a><a href="/docs/guides/diagram">Guides</a><a href="/docs/nodes/aws">Nodes</a></div><div><h5>More</h5><iframe src="https://ghbtns.com/github-btn.html?user=mingrammer&repo=diagrams&type=star&count=true&size=large" frameBorder="0" scrolling="0" width="170" height="30" title="Star mingrammer/diagrams on GitHub"></iframe></div></section><section class="copyright">Copyright © 2025 mingrammer</section></footer></div></body></html> |
