matplotlib-matplotlib.github.com/1.4.3/api/gridspec_api.html at main · spsforks/matplotlib-matplotlib.github.com · GitHub

History

335 lines (286 loc) · 17.8 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

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

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

<head>

<title>gridspec — Matplotlib 1.4.3 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.4.3',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.4.3 documentation"

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

</head>

<body>

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

<div class="alert" style="background-color: #FEA46C; padding: 10px 0;

<h3>We're updating the default styles for Matplotlib 2.0</h3>

<p>Learn what to expect in the <a href="/style_changes.html" style="font-weight: bold;

color: #11557C;">new updates</a></p>

</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="image_api.html" title="image"

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

<a href="font_manager_api.html" title="font_manager"

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="#">gridspec</a><ul>

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

</ul>

</li>

</ul>

<h4>Previous topic</h4>

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

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

<h4>Next topic</h4>

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

title="next chapter">image</a></p>

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

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

</ul>

<h3>Quick search</h3>

</form>

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

</p>

</div>

</div>

<h1>gridspec<a class="headerlink" href="#gridspec" title="Permalink to this headline">¶</a></h1>

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

<p><a class="reference internal" href="#module-matplotlib.gridspec" title="matplotlib.gridspec"><tt class="xref py py-mod docutils literal"><span class="pre">gridspec</span></tt></a> is a module which specifies the location

of the subplot in the figure.</p>

<dt><tt class="docutils literal"><span class="pre">GridSpec</span></tt></dt>

<dd>specifies the geometry of the grid that a subplot will be

placed. The number of rows and number of columns of the grid

need to be set. Optionally, the subplot layout parameters

(e.g., left, right, etc.) can be tuned.</dd>

<dt><tt class="docutils literal"><span class="pre">SubplotSpec</span></tt></dt>

<dd>specifies the location of the subplot in the given <em>GridSpec</em>.</dd>

</dl>

</div></blockquote>

<em class="property">class </em><tt class="descclassname">matplotlib.gridspec.</tt><tt class="descname">GridSpec</tt><big>(</big><em>nrows</em>, <em>ncols</em>, <em>left=None</em>, <em>bottom=None</em>, <em>right=None</em>, <em>top=None</em>, <em>wspace=None</em>, <em>hspace=None</em>, <em>width_ratios=None</em>, <em>height_ratios=None</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpec" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <a class="reference internal" href="#matplotlib.gridspec.GridSpecBase" title="matplotlib.gridspec.GridSpecBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.gridspec.GridSpecBase</span></tt></a></p>

<p>A class that specifies the geometry of the grid that a subplot

will be placed. The location of grid is determined by similar way

as the SubplotParams.</p>

<p>The number of rows and number of columns of the

grid need to be set. Optionally, the subplot layout parameters

(e.g., left, right, etc.) can be tuned.</p>

<tt class="descname">get_subplot_params</tt><big>(</big><em>fig=None</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpec.get_subplot_params" title="Permalink to this definition">¶</a></dt>

<dd><p>return a dictionary of subplot layout parameters. The default

parameters are from rcParams unless a figure attribute is set.</p>

</dd></dl>

<tt class="descname">locally_modified_subplot_params</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpec.locally_modified_subplot_params" title="Permalink to this definition">¶</a></dt>

<tt class="descname">tight_layout</tt><big>(</big><em>fig</em>, <em>renderer=None</em>, <em>pad=1.08</em>, <em>h_pad=None</em>, <em>w_pad=None</em>, <em>rect=None</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpec.tight_layout" title="Permalink to this definition">¶</a></dt>

<dd><p>Adjust subplot parameters to give specified padding.</p>

<p>Parameters:</p>

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

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

</dd></dl>

<tt class="descname">update</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpec.update" title="Permalink to this definition">¶</a></dt>

<dd><p>Update the current values. If any kwarg is None, default to

the current value, if set, otherwise to rc.</p>

</dd></dl>

<em class="property">class </em><tt class="descclassname">matplotlib.gridspec.</tt><tt class="descname">GridSpecBase</tt><big>(</big><em>nrows</em>, <em>ncols</em>, <em>height_ratios=None</em>, <em>width_ratios=None</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

<p>A base class of GridSpec that specifies the geometry of the grid

that a subplot will be placed.</p>

<p>The number of rows and number of columns of the grid need to

be set. Optionally, the ratio of heights and widths of rows and

columns can be specified.</p>

<tt class="descname">get_geometry</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_geometry" title="Permalink to this definition">¶</a></dt>

<dd><p>get the geometry of the grid, e.g., 2,3</p>

</dd></dl>

<tt class="descname">get_grid_positions</tt><big>(</big><em>fig</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_grid_positions" title="Permalink to this definition">¶</a></dt>

<dd><p>return lists of bottom and top position of rows, left and

right positions of columns.</p>

</dd></dl>

<tt class="descname">get_height_ratios</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_height_ratios" title="Permalink to this definition">¶</a></dt>

<tt class="descname">get_subplot_params</tt><big>(</big><em>fig=None</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_subplot_params" title="Permalink to this definition">¶</a></dt>

<tt class="descname">get_width_ratios</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_width_ratios" title="Permalink to this definition">¶</a></dt>

<tt class="descname">new_subplotspec</tt><big>(</big><em>loc</em>, <em>rowspan=1</em>, <em>colspan=1</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.new_subplotspec" title="Permalink to this definition">¶</a></dt>

<dd><p>create and return a SuplotSpec instance.</p>

</dd></dl>

<tt class="descname">set_height_ratios</tt><big>(</big><em>height_ratios</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.set_height_ratios" title="Permalink to this definition">¶</a></dt>

<tt class="descname">set_width_ratios</tt><big>(</big><em>width_ratios</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.set_width_ratios" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<em class="property">class </em><tt class="descclassname">matplotlib.gridspec.</tt><tt class="descname">GridSpecFromSubplotSpec</tt><big>(</big><em>nrows</em>, <em>ncols</em>, <em>subplot_spec</em>, <em>wspace=None</em>, <em>hspace=None</em>, <em>height_ratios=None</em>, <em>width_ratios=None</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecFromSubplotSpec" title="Permalink to this definition">¶</a></dt>

<p>GridSpec whose subplot layout parameters are inherited from the

location specified by a given SubplotSpec.</p>

<p>The number of rows and number of columns of the grid need to

be set. An instance of SubplotSpec is also needed to be set

from which the layout parameters will be inherited. The wspace

and hspace of the layout can be optionally specified or the

default values (from the figure or rcParams) will be used.</p>

<tt class="descname">get_subplot_params</tt><big>(</big><em>fig=None</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecFromSubplotSpec.get_subplot_params" title="Permalink to this definition">¶</a></dt>

<dd><p>return a dictionary of subplot layout parameters.</p>

</dd></dl>

<tt class="descname">get_topmost_subplotspec</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.gridspec.GridSpecFromSubplotSpec.get_topmost_subplotspec" title="Permalink to this definition">¶</a></dt>

<dd><p>get the topmost SubplotSpec instance associated with the subplot</p>

</dd></dl>

<em class="property">class </em><tt class="descclassname">matplotlib.gridspec.</tt><tt class="descname">SubplotSpec</tt><big>(</big><em>gridspec</em>, <em>num1</em>, <em>num2=None</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>

<p>specifies the location of the subplot in the given <em>GridSpec</em>.</p>

<p>The subplot will occupy the num1-th cell of the given

gridspec. If num2 is provided, the subplot will span between

num1-th cell and num2-th cell.</p>

<p>The index stars from 0.</p>

<tt class="descname">get_geometry</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_geometry" title="Permalink to this definition">¶</a></dt>

<dd><p>get the subplot geometry, e.g., 2,2,3. Unlike SuplorParams,

index is 0-based</p>

</dd></dl>

<tt class="descname">get_gridspec</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_gridspec" title="Permalink to this definition">¶</a></dt>

<tt class="descname">get_position</tt><big>(</big><em>fig</em>, <em>return_all=False</em><big>)</big><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_position" title="Permalink to this definition">¶</a></dt>

<dd><p>update the subplot position from fig.subplotpars</p>

</dd></dl>

<tt class="descname">get_topmost_subplotspec</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_topmost_subplotspec" title="Permalink to this definition">¶</a></dt>

<dd><p>get the topmost SubplotSpec instance associated with the subplot</p>

</dd></dl>

</div>

</div>

Last updated on Jul 14, 2015.

Created using <a

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

</div>

</body>

</html>

matplotlib-matplotlib.github.com/1.4.3/api/gridspec_api.html at main · spsforks/matplotlib-matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

gridspec_api.html

Latest commit

History

Breadcrumbs

gridspec_api.html

File metadata and controls