matplotlib.github.com/api/gridspec_api.html at master · phobson/matplotlib.github.com

History

499 lines (423 loc) · 23.7 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

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

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

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

<head>

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

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.0.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 2.0.0 documentation"

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

</head>

<body>

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

</a>

<br/>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<br/>

<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"><code class="docutils literal"><span class="pre">matplotlib.gridspec</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="font_manager_api.html" title="previous chapter">font_manager</a></li>

<li>Next: <a href="image_api.html" title="next chapter">image</a></li>

</ul></li>

</ul>

</div>

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</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"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.gridspec</span></code></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"><code class="xref py py-mod docutils literal"><span class="pre">gridspec</span></code></a> is a module which specifies the location

of the subplot in the figure.</p>

<dt><code class="docutils literal"><span class="pre">GridSpec</span></code></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><code class="docutils literal"><span class="pre">SubplotSpec</span></code></dt>

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

</dl>

</div></blockquote>

<em class="property">class </em><code class="descclassname">matplotlib.gridspec.</code><code class="descname">GridSpec</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><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"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.gridspec.GridSpecBase</span></code></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>

<code class="descname">get_subplot_params</code><span class="sig-paren">(</span><em>fig=None</em><span class="sig-paren">)</span><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>

<code class="descname">locally_modified_subplot_params</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpec.locally_modified_subplot_params" title="Permalink to this definition">¶</a></dt>

<code class="descname">tight_layout</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><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>

<span class="classifier-delimiter">:</span> <span class="classifier">float</span><dd>padding between the figure edge and the edges of subplots, as a fraction of the font-size.</dd>

<span class="classifier-delimiter">:</span> <span class="classifier">float</span><dd>padding (height/width) between edges of adjacent subplots.

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

<span class="classifier-delimiter">:</span> <span class="classifier">if rect is given, it is interpreted as a rectangle</span><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>

<code class="descname">update</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><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><code class="descclassname">matplotlib.gridspec.</code><code class="descname">GridSpecBase</code><span class="sig-paren">(</span><em>nrows</em>, <em>ncols</em>, <em>height_ratios=None</em>, <em>width_ratios=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></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>

<code class="descname">get_geometry</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>

<code class="descname">get_grid_positions</code><span class="sig-paren">(</span><em>fig</em><span class="sig-paren">)</span><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>

<code class="descname">get_height_ratios</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_height_ratios" title="Permalink to this definition">¶</a></dt>

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

<code class="descname">get_width_ratios</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_width_ratios" title="Permalink to this definition">¶</a></dt>

<code class="descname">new_subplotspec</code><span class="sig-paren">(</span><em>loc</em>, <em>rowspan=1</em>, <em>colspan=1</em><span class="sig-paren">)</span><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>

<code class="descname">set_height_ratios</code><span class="sig-paren">(</span><em>height_ratios</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.set_height_ratios" title="Permalink to this definition">¶</a></dt>

<code class="descname">set_width_ratios</code><span class="sig-paren">(</span><em>width_ratios</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.set_width_ratios" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<em class="property">class </em><code class="descclassname">matplotlib.gridspec.</code><code class="descname">GridSpecFromSubplotSpec</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><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>

<code class="descname">get_subplot_params</code><span class="sig-paren">(</span><em>fig=None</em><span class="sig-paren">)</span><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>

<code class="descname">get_topmost_subplotspec</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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><code class="descclassname">matplotlib.gridspec.</code><code class="descname">SubplotSpec</code><span class="sig-paren">(</span><em>gridspec</em>, <em>num1</em>, <em>num2=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></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>

<code class="descname">get_geometry</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>

<code class="descname">get_gridspec</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_gridspec" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_position</code><span class="sig-paren">(</span><em>fig</em>, <em>return_all=False</em><span class="sig-paren">)</span><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>

<code class="descname">get_topmost_subplotspec</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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 Jan 16, 2017.

Created using <a

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

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

function open_window(cause_id) {

var protocol=String(document.location.protocol);

var new_url;

if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){

new_url="https://www.flipcause.com/widget/"+cause_id

window.open(new_url);

}

else {

document.getElementById("fc-fade").style.display = "block";

document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";

document.getElementById("fc-fade").style.animation = "backfadesin 1s";

document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";

document.getElementById("fc-light").style.display = "block";

document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-light").style.animation = "fadesin 1.5s";

document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.display = "block";

document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.animation = "fadesin 1.5s";

document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.display = "block";

document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.animation = "fadesin 1.5s";

document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.display = "block";

document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;

}

function close_window() {

document.getElementById("fc-fade").style.display="none";

document.getElementById("fc-light").style.display="none";

document.getElementById("fc-main").style.display="none";

document.getElementById("fc-close").style.display="none";

document.getElementById("fc-myFrame").style.display="none";

}

</script>

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

gridspec_api.html

Latest commit

History

gridspec_api.html

File metadata and controls