matplotlib.github.com/1.4.0/api/tight_layout_api.html at main · matplotlib/matplotlib.github.com · GitHub

History

233 lines (204 loc) · 11.3 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

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

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

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

<head>

<title>tight_layout — Matplotlib 1.4.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.4.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.4.0 documentation"

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

</head>

<body>

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

</map>

</div>

<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="tri_api.html" title="triangular grids"

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

<a href="ticker_api.html" title="ticker"

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

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

<h3><a href="../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">tight_layout</a><ul>

<li><a class="reference internal" href="#module-matplotlib.tight_layout"><tt class="docutils literal"><span class="pre">matplotlib.tight_layout</span></tt></a></li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<p class="topless"><a href="ticker_api.html"

title="previous chapter">ticker</a></p>

<h4>Next topic</h4>

<p class="topless"><a href="tri_api.html"

title="next chapter">triangular grids</a></p>

<li><a href="../_sources/api/tight_layout_api.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</p>

</div>

</div>

<h1>tight_layout<a class="headerlink" href="#tight-layout" title="Permalink to this headline">¶</a></h1>

<span id="matplotlib-tight-layout"></span><h2><a class="reference internal" href="#module-matplotlib.tight_layout" title="matplotlib.tight_layout"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.tight_layout</span></tt></a><a class="headerlink" href="#module-matplotlib.tight_layout" title="Permalink to this headline">¶</a></h2>

<p>This module provides routines to adjust subplot params so that subplots are

nicely fit in the figure. In doing so, only axis labels, tick labels and axes

titles are currently considered.</p>

<p>Internally, it assumes that the margins (left_margin, etc.) which are

differences between ax.get_tightbbox and ax.bbox are independent of axes

position. This may fail if Axes.adjustable is datalim. Also, This will fail

for some cases (for example, left or right margin is affected by xlabel).</p>

<tt class="descclassname">matplotlib.tight_layout.</tt><tt class="descname">auto_adjust_subplotpars</tt><span class="sig-paren">(</span><em>fig</em>, <em>renderer</em>, <em>nrows_ncols</em>, <em>num1num2_list</em>, <em>subplot_list</em>, <em>ax_bbox_list=None</em>, <em>pad=1.08</em>, <em>h_pad=None</em>, <em>w_pad=None</em>, <em>rect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.tight_layout.auto_adjust_subplotpars" title="Permalink to this definition">¶</a></dt>

<dd><p>Return a dictionary of subplot parameters so that spacing between

subplots are adjusted. Note that this function ignore geometry

information of subplot itself, but uses what is given by

<em>nrows_ncols</em> and <em>num1num2_list</em> parameteres. Also, the results could be

incorrect if some subplots have <tt class="docutils literal"><span class="pre">adjustable=datalim</span></tt>.</p>

<p>Parameters:</p>

<dt>nrows_ncols</dt>

<dd>number of rows and number of columns of the grid.</dd>

<dd>list of numbers specifying the area occupied by the subplot</dd>

<dt>subplot_list</dt>

<dd>list of subplots that will be used to calcuate optimal subplot_params.</dd>

<dt>pad <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>

<dd>padding between the figure edge and the edges of subplots, as a fraction

of the font-size.</dd>

<dt>h_pad, w_pad <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>

<dt>padding (height/width) between edges of adjacent subplots.</dt>

<dd>Defaults to <tt class="xref py py-obj docutils literal"><span class="pre">pad_inches</span></tt>.</dd>

</dl>

</dd>

<dd>[left, bottom, right, top] in normalized (0, 1) figure coordinates.</dd>

</dl>

</dd></dl>

<tt class="descclassname">matplotlib.tight_layout.</tt><tt class="descname">get_renderer</tt><span class="sig-paren">(</span><em>fig</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.tight_layout.get_renderer" title="Permalink to this definition">¶</a></dt>

<tt class="descclassname">matplotlib.tight_layout.</tt><tt class="descname">get_subplotspec_list</tt><span class="sig-paren">(</span><em>axes_list</em>, <em>grid_spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.tight_layout.get_subplotspec_list" title="Permalink to this definition">¶</a></dt>

<dd><p>Return a list of subplotspec from the given list of axes. For an

instance of axes that does not support subplotspec, None is

inserted in the list.</p>

<p>If grid_spec is given, None is inserted for those not from

the given grid_spec.</p>

</dd></dl>

<tt class="descclassname">matplotlib.tight_layout.</tt><tt class="descname">get_tight_layout_figure</tt><span class="sig-paren">(</span><em>fig</em>, <em>axes_list</em>, <em>subplotspec_list</em>, <em>renderer</em>, <em>pad=1.08</em>, <em>h_pad=None</em>, <em>w_pad=None</em>, <em>rect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.tight_layout.get_tight_layout_figure" title="Permalink to this definition">¶</a></dt>

<dd><p>Return subplot parameters for tight-layouted-figure with specified

padding.</p>

<p>Parameters:</p>

<div><p><em>fig</em> : figure instance</p>

<dt><em>subplotspec_list</em> <span class="classifier-delimiter">:</span> <span class="classifier">a list of subplotspec associated with each</span></dt>

</dl>

<p><em>renderer</em> : renderer instance</p>

<dt><em>pad</em> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>

<dd>padding between the figure edge and the edges of subplots,

as a fraction of the font-size.</dd>

<dt><em>h_pad</em>, <em>w_pad</em> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>

<dd>padding (height/width) between edges of adjacent subplots.

Defaults to <tt class="xref py py-obj docutils literal"><span class="pre">pad_inches</span></tt>.</dd>

<dt><em>rect</em> <span class="classifier-delimiter">:</span> <span class="classifier">if rect is given, it is interpreted as a rectangle</span></dt>

<dd>(left, bottom, right, top) in the normalized figure

coordinate that the whole subplots area (including

labels) will fit into. Default is (0, 0, 1, 1).</dd>

</dl>

</div></blockquote>

</dd></dl>

</div>

</div>

Last updated on Sep 02, 2014.

Created using <a

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

</div>

</body>

</html>

matplotlib.github.com/1.4.0/api/tight_layout_api.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

tight_layout_api.html

Latest commit

History

Breadcrumbs

tight_layout_api.html

File metadata and controls