matplotlib.github.com/api/matplotlib_configuration_api.html at master · gepcel/matplotlib.github.com

History

526 lines (460 loc) · 25.2 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

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

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

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

<head>

<title>The top level matplotlib module — Matplotlib 1.5.3 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.5.3',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.5.3 documentation"

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

</head>

<body>

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

<h2>Matplotlib 2.0.0rc2 is available</h2>

<p><a href="../style_changes.html"

style="font-weight: bold;

color: #11557C;">Install the release candidate now!</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="afm_api.html" title="afm (Adobe Font Metrics interface)"

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

<a href="api_changes.html" title="API Changes"

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>

<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="api_changes.html" title="previous chapter">API Changes</a></li>

<li>Next: <a href="afm_api.html" title="next chapter">afm (Adobe Font Metrics interface)</a></li>

</ul></li>

</ul>

</div>

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<h1>The top level <code class="xref py py-mod docutils literal"><span class="pre">matplotlib</span></code> module<a class="headerlink" href="#the-top-level-matplotlib-module" title="Permalink to this headline">¶</a></h1>

<code class="descclassname">matplotlib.</code><code class="descname">use</code><span class="sig-paren">(</span><em>arg</em>, <em>warn=True</em>, <em>force=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.use" title="Permalink to this definition">¶</a></dt>

<dd><p>Set the matplotlib backend to one of the known backends.</p>

<p>The argument is case-insensitive. <em>warn</em> specifies whether a

warning should be issued if a backend has already been set up.

<em>force</em> is an <strong>experimental</strong> flag that tells matplotlib to

attempt to initialize a new backend by reloading the backend

module.</p>

<p class="last">This function must be called <em>before</em> importing pyplot for

the first time; or, if you are not using pyplot, it must be called

before importing matplotlib.backends. If warn is True, a warning

is issued if you try and call this after pylab or pyplot have been

loaded. In certain black magic use cases, e.g.

<a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.switch_backend" title="matplotlib.pyplot.switch_backend"><code class="xref py py-func docutils literal"><span class="pre">pyplot.switch_backend()</span></code></a>, we are doing the reloading necessary to

make the backend switch work (in some cases, e.g., pure image

backends) so one can set warn=False to suppress the warnings.</p>

</div>

<p>To find out which backend is currently set, see

<a class="reference internal" href="#matplotlib.get_backend" title="matplotlib.get_backend"><code class="xref py py-func docutils literal"><span class="pre">matplotlib.get_backend()</span></code></a>.</p>

</dd></dl>

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

<dd><p>Return the name of the current backend.</p>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rcParams</code><a class="headerlink" href="#matplotlib.rcParams" title="Permalink to this definition">¶</a></dt>

<dd><p>An instance of <a class="reference internal" href="#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-class docutils literal"><span class="pre">RcParams</span></code></a> for handling default matplotlib values.</p>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc</code><span class="sig-paren">(</span><em>group</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rc" title="Permalink to this definition">¶</a></dt>

<dd><p>Set the current rc params. Group is the grouping for the rc, e.g.,

for <code class="docutils literal"><span class="pre">lines.linewidth</span></code> the group is <code class="docutils literal"><span class="pre">lines</span></code>, for

<code class="docutils literal"><span class="pre">axes.facecolor</span></code>, the group is <code class="docutils literal"><span class="pre">axes</span></code>, and so on. Group may

also be a list or tuple of group names, e.g., (<em>xtick</em>, <em>ytick</em>).

<em>kwargs</em> is a dictionary attribute name/value pairs, e.g.,:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">rc</span><span class="p">(</span><span class="s1">'lines'</span><span class="p">,</span> <span class="n">linewidth</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'r'</span><span class="p">)</span>

</pre></div>

</div>

<p>sets the current rc params and is equivalent to:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'lines.linewidth'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">2</span>

<span class="n">rcParams</span><span class="p">[</span><span class="s1">'lines.color'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'r'</span>

</pre></div>

</div>

<p>The following aliases are available to save typing for interactive

users:</p>

</colgroup>

<tr class="row-odd"><th class="head">Alias</th>

<th class="head">Property</th>

</tr>

</thead>

<td>‘linewidth’</td>

</tr>

<td>‘linestyle’</td>

</tr>

<td>‘color’</td>

</tr>

<td>‘facecolor’</td>

</tr>

<td>‘edgecolor’</td>

</tr>

<td>‘markeredgewidth’</td>

</tr>

<td>‘antialiased’</td>

</tr>

</tbody>

</table>

<p>Thus you could abbreviate the above rc command as:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">rc</span><span class="p">(</span><span class="s1">'lines'</span><span class="p">,</span> <span class="n">lw</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="s1">'r'</span><span class="p">)</span>

</pre></div>

</div>

<p>Note you can use python’s kwargs dictionary facility to store

dictionaries of default parameters. e.g., you can customize the

font rc as follows:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">font</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'family'</span> <span class="p">:</span> <span class="s1">'monospace'</span><span class="p">,</span>

<span class="s1">'weight'</span> <span class="p">:</span> <span class="s1">'bold'</span><span class="p">,</span>

<span class="s1">'size'</span> <span class="p">:</span> <span class="s1">'larger'</span><span class="p">}</span>

<span class="n">rc</span><span class="p">(</span><span class="s1">'font'</span><span class="p">,</span> <span class="o">**</span><span class="n">font</span><span class="p">)</span> <span class="c1"># pass in the font dict as kwargs</span>

</pre></div>

</div>

<p>This enables you to easily switch between several configurations.

Use <a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.rcdefaults" title="matplotlib.pyplot.rcdefaults"><code class="xref py py-func docutils literal"><span class="pre">rcdefaults()</span></code></a> to restore the default

rc params after changes.</p>

</dd></dl>

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

<dd><p>Get the location of the config file.</p>

<p>The file location is determined in the following order</p>

<ul>

<li><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">$PWD/matplotlibrc</span></code></p>

</li>

<li><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">$MATPLOTLIBRC/matplotlibrc</span></code></p>

</li>

<li><p class="first"><code class="xref py py-obj docutils literal"><span class="pre">$MPLCONFIGDIR/matplotlibrc</span></code></p>

</li>

<li><p class="first">On Linux,</p>

<li><code class="xref py py-obj docutils literal"><span class="pre">$HOME/.matplotlib/matplotlibrc</span></code>, if it exists</li>

<li>or <code class="xref py py-obj docutils literal"><span class="pre">$XDG_CONFIG_HOME/matplotlib/matplotlibrc</span></code> (if

$XDG_CONFIG_HOME is defined)</li>

<li>or <code class="xref py py-obj docutils literal"><span class="pre">$HOME/.config/matplotlib/matplotlibrc</span></code> (if

$XDG_CONFIG_HOME is not defined)</li>

</ul>

</div></blockquote>

</li>

<li><p class="first">On other platforms,</p>

<li><code class="xref py py-obj docutils literal"><span class="pre">$HOME/.matplotlib/matplotlibrc</span></code> if <code class="xref py py-obj docutils literal"><span class="pre">$HOME</span></code> is defined.</li>

</ul>

</div></blockquote>

</li>

<li><p class="first">Lastly, it looks in <code class="xref py py-obj docutils literal"><span class="pre">$MATPLOTLIBDATA/matplotlibrc</span></code> for a

system-defined copy.</p>

</li>

</ul>

</dd></dl>

<em class="property">class </em><code class="descclassname">matplotlib.</code><code class="descname">RcParams</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.RcParams" title="Permalink to this definition">¶</a></dt>

<dd><p>A dictionary object including validation</p>

<p>validating functions are defined and associated with rc parameters in

<code class="xref py py-mod docutils literal"><span class="pre">matplotlib.rcsetup</span></code></p>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc_params</code><span class="sig-paren">(</span><em>fail_on_error=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rc_params" title="Permalink to this definition">¶</a></dt>

<dd><p>Return a <a class="reference internal" href="#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.RcParams</span></code></a> instance from the

default matplotlib rc file.</p>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc_params_from_file</code><span class="sig-paren">(</span><em>fname</em>, <em>fail_on_error=False</em>, <em>use_default_template=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rc_params_from_file" title="Permalink to this definition">¶</a></dt>

<dd><p>Return <a class="reference internal" href="#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.RcParams</span></code></a> from the contents of the given file.</p>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>fname</strong> : str</p>

<div><p>Name of file parsed for matplotlib settings.</p>

</div></blockquote>

<p><strong>fail_on_error</strong> : bool</p>

<div><p>If True, raise an error when the parser fails to convert a parameter.</p>

</div></blockquote>

<p><strong>use_default_template</strong> : bool</p>

<div><p>If True, initialize with default parameters before updating with those

in the given file. If False, the configuration class only contains the

parameters specified in the file. (Useful for updating dicts.)</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<em class="property">class </em><code class="descclassname">matplotlib.</code><code class="descname">rc_context</code><span class="sig-paren">(</span><em>rc=None</em>, <em>fname=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.rc_context" title="Permalink to this definition">¶</a></dt>

<dd><p>Return a context manager for managing rc settings.</p>

<p>This allows one to do:</p>

<span class="k">with</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rc_context</span><span class="p">(</span><span class="n">fname</span><span class="o">=</span><span class="s1">'print.rc'</span><span class="p">):</span>

</pre></div>

</div>

<p>The ‘a’ vs ‘x’ and ‘c’ vs ‘x’ plots would have settings from

‘screen.rc’, while the ‘b’ vs ‘x’ plot would have settings from

‘print.rc’.</p>

<p>A dictionary can also be passed to the context manager:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rc_context</span><span class="p">(</span><span class="n">rc</span><span class="o">=</span><span class="p">{</span><span class="s1">'text.usetex'</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span> <span class="n">fname</span><span class="o">=</span><span class="s1">'screen.rc'</span><span class="p">):</span>

</pre></div>

</div>

<p>The ‘rc’ dictionary takes precedence over the settings loaded from

‘fname’. Passing a dictionary only is also valid.</p>

</dd></dl>

</div>

</div>

Last updated on Dec 19, 2016.

Created using <a

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

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

matplotlib_configuration_api.html

Latest commit

History

matplotlib_configuration_api.html

File metadata and controls