matplotlib.github.com/3.3.3/api/backend_mixed_api.html at main · matplotlib/matplotlib.github.com · GitHub

History

206 lines (182 loc) · 14 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.backends.backend_mixed — Matplotlib 3.3.3 documentation</title>

title="Search within Matplotlib 3.3.3 documentation"

href="../_static/opensearch.xml"/>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.3). For the latest version see <a href="https://matplotlib.org/stable/api/backend_mixed_api.html">https://matplotlib.org/stable/api/backend_mixed_api.html</a></div>

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.3</span></div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<ul>

<li><a href="../users/installing.html">Installation</a></li>

<li><a href="../contents.html">Documentation</a></li>

<li><a href="../gallery/index.html">Examples</a></li>

<li><a href="../tutorials/index.html">Tutorials</a></li>

<li><a href="../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="backend_template_api.html" title="matplotlib.backends.backend_template"

accesskey="N">next</a> |</li>

<a href="index_backend_api.html" title="matplotlib.backends"

accesskey="P">previous</a> |</li>

<li><a href="../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" >API Overview</a> »</li>

<li class="nav-item nav-item-2"><a href="index_backend_api.html" accesskey="U"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</span></code></a> »</li>

<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_mixed</span></code></a></li>

</ul>

</div>

<h3>Related Topics</h3>

<ul>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">API Overview</a><ul>

<li><a href="index_backend_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</span></code></a><ul>

<li>Previous: <a href="index_backend_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</span></code></a></li>

<li>Next: <a href="backend_template_api.html" title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_template</span></code></a></li>

</ul></li>

</ul>

</div>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/api/backend_mixed_api.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<span id="matplotlib-backends-backend-mixed"></span><h1><a class="reference internal" href="#module-matplotlib.backends.backend_mixed" title="matplotlib.backends.backend_mixed"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_mixed</span></code></a><a class="headerlink" href="#module-matplotlib.backends.backend_mixed" title="Permalink to this headline">¶</a></h1>

<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_mixed.</code><code class="descname">MixedModeRenderer</code><span class="sig-paren">(</span><em><span class="n">figure</span></em>, <em><span class="n">width</span></em>, <em><span class="n">height</span></em>, <em><span class="n">dpi</span></em>, <em><span class="n">vector_renderer</span></em>, <em><span class="n">raster_renderer_class</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">bbox_inches_restore</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_mixed.html#MixedModeRenderer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_mixed.MixedModeRenderer" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>A helper class to implement a renderer that switches between

vector and raster drawing. An example may be a PDF writer, where

most things are drawn with PDF vector commands, but some very

complex objects, such as quad meshes, are rasterised and then

output as images.</p>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt><strong>figure</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.figure.Figure</span></code></a></span></dt><dd><p>The figure instance.</p>

</dd>

<dt><strong>width</strong><span class="classifier">scalar</span></dt><dd><p>The width of the canvas in logical units</p>

</dd>

<dt><strong>height</strong><span class="classifier">scalar</span></dt><dd><p>The height of the canvas in logical units</p>

</dd>

<dt><strong>dpi</strong><span class="classifier">float</span></dt><dd><p>The dpi of the canvas</p>

</dd>

<dt><strong>vector_renderer</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_bases.RendererBase</span></code></a></span></dt><dd><p>An instance of a subclass of

<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererBase</span></code></a> that will be used for the

vector drawing.</p>

</dd>

<dt><strong>raster_renderer_class</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_bases.RendererBase</span></code></a></span></dt><dd><p>The renderer class to use for the raster drawing. If not provided,

this will use the Agg backend (which is currently the only viable

option anyway.)</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">start_rasterizing</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_mixed.html#MixedModeRenderer.start_rasterizing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_mixed.MixedModeRenderer.start_rasterizing" title="Permalink to this definition">¶</a></dt>

<dd><p>Enter "raster" mode. All subsequent drawing commands (until

<a class="reference internal" href="#matplotlib.backends.backend_mixed.MixedModeRenderer.stop_rasterizing" title="matplotlib.backends.backend_mixed.MixedModeRenderer.stop_rasterizing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stop_rasterizing</span></code></a> is called) will be drawn with the raster backend.</p>

</dd></dl>

<code class="descname">stop_rasterizing</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backends/backend_mixed.html#MixedModeRenderer.stop_rasterizing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backends.backend_mixed.MixedModeRenderer.stop_rasterizing" title="Permalink to this definition">¶</a></dt>

<dd><p>Exit "raster" mode. All of the drawing that was done since

the last <a class="reference internal" href="#matplotlib.backends.backend_mixed.MixedModeRenderer.start_rasterizing" title="matplotlib.backends.backend_mixed.MixedModeRenderer.start_rasterizing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">start_rasterizing</span></code></a> call will be copied to the

vector backend by calling draw_image.</p>

<p>If <a class="reference internal" href="#matplotlib.backends.backend_mixed.MixedModeRenderer.start_rasterizing" title="matplotlib.backends.backend_mixed.MixedModeRenderer.start_rasterizing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">start_rasterizing</span></code></a> has been called multiple times,

"raster" mode is exited.</p>

</dd></dl>

</div>

</div>

<br />

Last updated on Nov 12, 2020.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.

Doc version v3.3.3-2-g447bdbbf58.

</div>

</footer>

</body>

</html>

matplotlib.github.com/3.3.3/api/backend_mixed_api.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

backend_mixed_api.html

Latest commit

History

Breadcrumbs

backend_mixed_api.html

File metadata and controls