blob: 76a9464a792488f84979450d5eabc055a894c525 [file] [log] [blame]
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>apache_beam.runners.interactive.display.pipeline_graph_renderer module &mdash; Apache Beam 2.67.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=959b4fbe"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.runners.interactive.messaging package" href="apache_beam.runners.interactive.messaging.html" />
<link rel="prev" title="apache_beam.runners.interactive.display.pipeline_graph module" href="apache_beam.runners.interactive.display.pipeline_graph.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Apache Beam
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dask.html">apache_beam.runners.dask package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="breadcrumb-item"><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a></li>
<li class="breadcrumb-item"><a href="apache_beam.runners.interactive.display.html">apache_beam.runners.interactive.display package</a></li>
<li class="breadcrumb-item active">apache_beam.runners.interactive.display.pipeline_graph_renderer module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.interactive.display.pipeline_graph_renderer.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-apache_beam.runners.interactive.display.pipeline_graph_renderer">
<span id="apache-beam-runners-interactive-display-pipeline-graph-renderer-module"></span><h1>apache_beam.runners.interactive.display.pipeline_graph_renderer module<a class="headerlink" href="#module-apache_beam.runners.interactive.display.pipeline_graph_renderer" title="Link to this heading"></a></h1>
<p>For rendering pipeline graph in HTML-compatible format.</p>
<p>This module is experimental. No backwards-compatibility guarantees.</p>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.interactive.display.pipeline_graph_renderer.</span></span><span class="sig-name descname"><span class="pre">PipelineGraphRenderer</span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#PipelineGraphRenderer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.utils.plugin.html#apache_beam.utils.plugin.BeamPlugin" title="apache_beam.utils.plugin.BeamPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">BeamPlugin</span></code></a></p>
<p>Abstract class for renderers, who decide how pipeline graphs are rendered.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer.option">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">option</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#PipelineGraphRenderer.option"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer.option" title="Link to this definition"></a></dt>
<dd><p>The corresponding rendering option for the renderer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer.render_pipeline_graph">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">render_pipeline_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline_graph</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.interactive.display.pipeline_graph.html#apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph" title="apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph"><span class="pre">PipelineGraph</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#PipelineGraphRenderer.render_pipeline_graph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer.render_pipeline_graph" title="Link to this definition"></a></dt>
<dd><p>Renders the pipeline graph in HTML-compatible format.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>pipeline_graph</strong> – (pipeline_graph.PipelineGraph) the graph to be rendererd.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>unicode, str or bytes that can be expressed as HTML.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.interactive.display.pipeline_graph_renderer.</span></span><span class="sig-name descname"><span class="pre">MuteRenderer</span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#MuteRenderer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer" title="apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineGraphRenderer</span></code></a></p>
<p>Use this renderer to mute the pipeline display.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer.option">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">option</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#MuteRenderer.option"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer.option" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer.render_pipeline_graph">
<span class="sig-name descname"><span class="pre">render_pipeline_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline_graph</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.interactive.display.pipeline_graph.html#apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph" title="apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph"><span class="pre">PipelineGraph</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#MuteRenderer.render_pipeline_graph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer.render_pipeline_graph" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.interactive.display.pipeline_graph_renderer.</span></span><span class="sig-name descname"><span class="pre">TextRenderer</span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#TextRenderer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer" title="apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineGraphRenderer</span></code></a></p>
<p>This renderer simply returns the dot representation in text format.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer.option">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">option</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#TextRenderer.option"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer.option" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer.render_pipeline_graph">
<span class="sig-name descname"><span class="pre">render_pipeline_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline_graph</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.interactive.display.pipeline_graph.html#apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph" title="apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph"><span class="pre">PipelineGraph</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#TextRenderer.render_pipeline_graph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer.render_pipeline_graph" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.interactive.display.pipeline_graph_renderer.</span></span><span class="sig-name descname"><span class="pre">PydotRenderer</span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#PydotRenderer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer" title="apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineGraphRenderer</span></code></a></p>
<p>This renderer renders the graph using pydot.</p>
<dl class="simple">
<dt>It depends on</dt><dd><ol class="arabic simple">
<li><p>The software Graphviz: <a class="reference external" href="https://www.graphviz.org/">https://www.graphviz.org/</a></p></li>
<li><p>The python module pydot: <a class="reference external" href="https://pypi.org/project/pydot/">https://pypi.org/project/pydot/</a></p></li>
</ol>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer.option">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">option</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#PydotRenderer.option"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer.option" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer.render_pipeline_graph">
<span class="sig-name descname"><span class="pre">render_pipeline_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline_graph</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.interactive.display.pipeline_graph.html#apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph" title="apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph"><span class="pre">PipelineGraph</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#PydotRenderer.render_pipeline_graph"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer.render_pipeline_graph" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apache_beam.runners.interactive.display.pipeline_graph_renderer.get_renderer">
<span class="sig-prename descclassname"><span class="pre">apache_beam.runners.interactive.display.pipeline_graph_renderer.</span></span><span class="sig-name descname"><span class="pre">get_renderer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Type" title="(in Python v3.13)"><span class="pre">Type</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer" title="apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer"><span class="pre">PipelineGraphRenderer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/runners/interactive/display/pipeline_graph_renderer.html#get_renderer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.interactive.display.pipeline_graph_renderer.get_renderer" title="Link to this definition"></a></dt>
<dd><p>Get an instance of PipelineGraphRenderer given rendering option.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>option</strong> – (str) the rendering option.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>(PipelineGraphRenderer)</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="apache_beam.runners.interactive.display.pipeline_graph.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.display.pipeline_graph module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="apache_beam.runners.interactive.messaging.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.messaging package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright %Y, Apache Beam.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>