matplotlib.github.com/2.2.4/api/tight_layout_api.html at master · aitikgupta/matplotlib.github.com · GitHub

History

373 lines (323 loc) · 16.9 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

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

<!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 2.2.4 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.2.4',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.2.4 documentation"

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

</head>

<body>

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

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

</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="transformations.html" title="Working with transformations"

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

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

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

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

<li><a href="../tutorials/index.html">tutorials</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>Quick search</h3>

</form>

</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"><code class="docutils literal notranslate"><span class="pre">matplotlib.tight_layout</span></code></a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

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

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

<li>Previous: <a href="ticker_api.html" title="previous chapter">ticker</a></li>

<li>Next: <a href="transformations.html" title="next chapter">Working with transformations</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/tight_layout_api.rst.txt"

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

</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"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.tight_layout</span></code></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, axes

titles and offsetboxes that are anchored to axes 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>

<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">auto_adjust_subplotpars</code><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="reference internal" href="../_modules/matplotlib/tight_layout.html#auto_adjust_subplotpars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.tight_layout.auto_adjust_subplotpars" title="Permalink to this definition">¶</a></dt>

<dd><p>Return a dict of subplot parameters to adjust spacing between subplots.</p>

<p>Note that this function ignores geometry information of subplot

itself, but uses what is given by the <em>nrows_ncols</em> and <em>num1num2_list</em>

parameters. Also, the results could be incorrect if some subplots have

<code class="docutils literal notranslate"><span class="pre">adjustable=datalim</span></code>.</p>

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

<dt><strong>nrows_ncols</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Tuple[int, int]</span></dt>

<dd><p class="first last">Number of rows and number of columns of the grid.</p>

</dd>

<dd><p class="first last">List of numbers specifying the area occupied by the subplot</p>

</dd>

<dt><strong>subplot_list</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of subplots</span></dt>

<dd><p class="first last">List of subplots that will be used to calculate optimal subplot_params.</p>

</dd>

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

<dd><p class="first last">Padding between the figure edge and the edges of subplots, as a

fraction of the font size.</p>

</dd>

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

<dd><p class="first last">Padding (height/width) between edges of adjacent subplots, as a

fraction of the font size. Defaults to <em>pad</em>.</p>

</dd>

<dt><strong>rect</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Tuple[float, float, float, float]</span></dt>

<dd><p class="first last">[left, bottom, right, top] in normalized (0, 1) figure coordinates.</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_renderer</code><span class="sig-paren">(</span><em>fig</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/tight_layout.html#get_renderer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.tight_layout.get_renderer" title="Permalink to this definition">¶</a></dt>

<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_subplotspec_list</code><span class="sig-paren">(</span><em>axes_list</em>, <em>grid_spec=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/tight_layout.html#get_subplotspec_list"><span class="viewcode-link">[source]</span></a><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.</p>

<p>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>

<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_tight_layout_figure</code><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="reference internal" href="../_modules/matplotlib/tight_layout.html#get_tight_layout_figure"><span class="viewcode-link">[source]</span></a><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>

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

<dt><strong>fig</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Figure</span></dt>

<dt><strong>subplotspec_list</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of <a class="reference internal" href="_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec" title="matplotlib.gridspec.SubplotSpec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubplotSpec</span></code></a></span></dt>

<dd><p class="first last">The subplotspecs of each axes.</p>

</dd>

<dt><strong>renderer</strong> <span class="classifier-delimiter">:</span> <span class="classifier">renderer</span></dt>

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

<dd><p class="first last">Padding between the figure edge and the edges of subplots, as a

fraction of the font size.</p>

</dd>

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

<dd><p class="first last">Padding (height/width) between edges of adjacent subplots. Defaults to

<em>pad_inches</em>.</p>

</dd>

<dt><strong>rect</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Tuple[float, float, float, float], optional</span></dt>

<dd><p class="first last">(left, bottom, right, top) rectangle in normalized figure coordinates

that the whole subplots area (including labels) will fit into.

Defaults to using the entire figure.</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

</div>

<br />

Last updated on Feb 28, 2019.

Created using

<ahref="http://sphinx-doc.org/">Sphinx</a> 1.8.4.

Doc version v2.2.4-2-g38a93e9a0-dirty.

</div>

(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','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

<!--Flipcause Integration v3.0// Flipcause Integration Instructions:

Install the following code block once in the website Header (after <head> tag) -->

<style>

.fc-black_overlay{

display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;

background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;

}

.fc-white_content {

opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;

position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;

}

.fc-main-box{

opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;

}

.fc-widget_close{

opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);

position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;

}

.floating_button{

display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;

position:fixed; z-index:999999; overflow: auto;

}

@keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-moz-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-webkit-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-o-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-ms-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; transform: translateY(20px);}

100% {opacity: 1; transform: translateY(0);}

}

@-moz-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -moz-transform: translateY(20px);}

100% {opacity: 1; -moz-transform: translateY(0);}

}

@-webkit-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -webkit-transform: translateY(20px);}

100% {opacity: 1; -webkit-transform: translateY(0);}

}

@-o-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -o-transform: translateY(20px);}

100% {opacity: 1; -o-transform: translateY(0);}

}

@-ms-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -ms-transform: translateY(20px);}

100% {opacity: 1; -ms-transform: translateY(0);}

}

</style>

</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;

border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>

</div>

</footer>

</html>

matplotlib.github.com/2.2.4/api/tight_layout_api.html at master · aitikgupta/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

tight_layout_api.html

Latest commit

History

Breadcrumbs

tight_layout_api.html

File metadata and controls