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

History

511 lines (471 loc) · 35.4 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

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

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

<head>

<title>matplotlib — Matplotlib 3.2.1 documentation</title>

title="Search within Matplotlib 3.2.1 documentation"

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

</head><body>

John Hunter Excellence in Plotting Contest 2020

<a href="https://jhepc.github.io/about.html"> submissions are open!

</a>

Entries are due June 1, 2020.

</div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.2.1</div>

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

</div>

<ul>

<li><a href="../users/installing.html">Installation</a></li>

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

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

<li><a href="../tutorials/index.html">Tutorials</a></li>

<li><a href="../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<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="matplotlib.afm"

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

<a href="next_api_changes/README.html" title="Adding API change notes"

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

<li><a href="../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>

</ul>

</div>

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

<ul>

<li><a class="reference internal" href="#"><code class="docutils literal notranslate">matplotlib</code></a><ul>

<li><a class="reference internal" href="#backend-management">Backend management</a></li>

<li><a class="reference internal" href="#default-values-and-styling">Default values and styling</a></li>

<li><a class="reference internal" href="#logging">Logging</a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

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

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

<li>Previous: <a href="next_api_changes/README.html" title="previous chapter">Adding API change notes</a></li>

<li>Next: <a href="afm_api.html" title="next chapter"><code class="docutils literal notranslate">matplotlib.afm</code></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/matplotlib_configuration_api.rst.txt"

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

</div>

<h1><code class="docutils literal notranslate">matplotlib</code><a class="headerlink" href="#matplotlib" title="Permalink to this headline">¶</a></h1>

<h2>Backend management<a class="headerlink" href="#backend-management" title="Permalink to this headline">¶</a></h2>

<code class="descclassname">matplotlib.</code><code class="descname">use</code>(backend, warn=<deprecated parameter>, force=True)<a class="reference internal" href="../_modules/matplotlib.html#use">[source]</a><a class="headerlink" href="#matplotlib.use" title="Permalink to this definition">¶</a></dt>

<dd>Select the backend used for rendering and GUI integration.

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

<dt>backendstr</dt><dd>The backend to switch to. This can either be one of the standard

backend names, which are case-insensitive:

<li>interactive backends:

GTK3Agg, GTK3Cairo, MacOSX, nbAgg,

Qt4Agg, Qt4Cairo, Qt5Agg, Qt5Cairo,

TkAgg, TkCairo, WebAgg, WX, WXAgg, WXCairo</li>

<li>non-interactive backends:

agg, cairo, pdf, pgf, ps, svg, template</li>

</ul>

or a string of the form: <code class="docutils literal notranslate">module://my.module.name</code>.

</dd>

<dt>warnbool, optional, default: False</dt><dd>If True and not force, emit a warning if a failure-to-switch

<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ImportError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate">ImportError</code></a> has been suppressed. This parameter is deprecated.

</dd>

<dt>forcebool, optional, default: True</dt><dd>If True (the default), raise an <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ImportError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate">ImportError</code></a> if the backend cannot be

set up (either because it fails to import, or because an incompatible

GUI interactive framework is already running); if False, ignore the

failure.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

See also

<dt><a class="reference internal" href="../tutorials/introductory/usage.html#backends">Backends</a></dt><dd></dd>

<dt><a class="reference internal" href="#matplotlib.get_backend" title="matplotlib.get_backend"><code class="xref py py-obj docutils literal notranslate">matplotlib.get_backend</code></a></dt><dd></dd>

</dl>

</div>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">get_backend</code>()<a class="reference internal" href="../_modules/matplotlib.html#get_backend">[source]</a><a class="headerlink" href="#matplotlib.get_backend" title="Permalink to this definition">¶</a></dt>

<dd>Return the name of the current backend.

See also

<dt><a class="reference internal" href="#matplotlib.use" title="matplotlib.use"><code class="xref py py-obj docutils literal notranslate">matplotlib.use</code></a></dt><dd></dd>

</dl>

</div>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">interactive</code>(b)<a class="reference internal" href="../_modules/matplotlib.html#interactive">[source]</a><a class="headerlink" href="#matplotlib.interactive" title="Permalink to this definition">¶</a></dt>

<dd>Set whether to redraw after every plotting command (e.g. <a class="reference internal" href="_as_gen/matplotlib.pyplot.xlabel.html#matplotlib.pyplot.xlabel" title="matplotlib.pyplot.xlabel"><code class="xref py py-obj docutils literal notranslate">pyplot.xlabel</code></a>).

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">is_interactive</code>()<a class="reference internal" href="../_modules/matplotlib.html#is_interactive">[source]</a><a class="headerlink" href="#matplotlib.is_interactive" title="Permalink to this definition">¶</a></dt>

<dd>Return whether to redraw after every plotting command.

</dd></dl>

</div>

<h2>Default values and styling<a class="headerlink" href="#default-values-and-styling" title="Permalink to this headline">¶</a></h2>

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

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

</dd></dl>

class <code class="descclassname">matplotlib.</code><code class="descname">RcParams</code>(*args, **kwargs)<a class="reference internal" href="../_modules/matplotlib.html#RcParams">[source]</a><a class="headerlink" href="#matplotlib.RcParams" title="Permalink to this definition">¶</a></dt>

<dd>A dictionary object including validation.

Validating functions are defined and associated with rc parameters in

<a class="reference internal" href="rcsetup_api.html#module-matplotlib.rcsetup" title="matplotlib.rcsetup"><code class="xref py py-mod docutils literal notranslate">matplotlib.rcsetup</code></a>.

See also

<dt><a class="reference internal" href="../tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files">The matplotlibrc file</a></dt><dd></dd>

</dl>

</div>

<code class="descname">find_all</code>(self, pattern)<a class="reference internal" href="../_modules/matplotlib.html#RcParams.find_all">[source]</a><a class="headerlink" href="#matplotlib.RcParams.find_all" title="Permalink to this definition">¶</a></dt>

<dd>Return the subset of this RcParams dictionary whose keys match,

using <a class="reference external" href="https://docs.python.org/3/library/re.html#re.search" title="(in Python v3.8)"><code class="xref py py-func docutils literal notranslate">re.search()</code></a>, the given <code class="docutils literal notranslate">pattern</code>.

Note

Changes to the returned dictionary are not propagated to

the parent RcParams dictionary.

</div>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc_context</code>(rc=None, fname=None)<a class="reference internal" href="../_modules/matplotlib.html#rc_context">[source]</a><a class="headerlink" href="#matplotlib.rc_context" title="Permalink to this definition">¶</a></dt>

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

This allows one to do:

plt.plot(x, a) # uses 'screen.rc'

with mpl.rc_context(fname='print.rc'):

plt.plot(x, b) # uses 'print.rc'

plt.plot(x, c) # uses 'screen.rc'

</pre></div>

</div>

A dictionary can also be passed to the context manager:

<div class="highlight-default notranslate"><div class="highlight"><pre>with mpl.rc_context(rc={'text.usetex': True}, fname='screen.rc'):

plt.plot(x, a)

</pre></div>

</div>

The 'rc' dictionary takes precedence over the settings loaded from

'fname'. Passing a dictionary only is also valid. For example a

common usage is:

<div class="highlight-default notranslate"><div class="highlight"><pre>with mpl.rc_context(rc={'interactive': False}):

fig, ax = plt.subplots()

ax.plot(range(3), range(3))

fig.savefig('A.png', format='png')

plt.close(fig)

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc</code>(group, \*\*kwargs)<a class="reference internal" href="../_modules/matplotlib.html#rc">[source]</a><a class="headerlink" href="#matplotlib.rc" title="Permalink to this definition">¶</a></dt>

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

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

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

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

kwargs is a dictionary attribute name/value pairs, e.g.,:

<div class="highlight-default notranslate"><div class="highlight"><pre>rc('lines', linewidth=2, color='r')

</pre></div>

</div>

sets the current rc params and is equivalent to:

<div class="highlight-default notranslate"><div class="highlight"><pre>rcParams['lines.linewidth'] = 2

rcParams['lines.color'] = 'r'

</pre></div>

</div>

The following aliases are available to save typing for interactive users:

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

Thus you could abbreviate the above rc command as:

<div class="highlight-default notranslate"><div class="highlight"><pre>rc('lines', lw=2, c='r')

</pre></div>

</div>

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:

<div class="highlight-default notranslate"><div class="highlight"><pre>font = {'family' : 'monospace',

'weight' : 'bold',

'size' : 'larger'}

rc('font', **font) # pass in the font dict as kwargs

</pre></div>

</div>

This enables you to easily switch between several configurations. Use

<code class="docutils literal notranslate">matplotlib.style.use('default')</code> or <a class="reference internal" href="#matplotlib.rcdefaults" title="matplotlib.rcdefaults"><code class="xref py py-func docutils literal notranslate">rcdefaults()</code></a> to

restore the default rc params after changes.

Notes

Similar functionality is available by using the normal dict interface, i.e.

<code class="docutils literal notranslate">rcParams.update({"lines.linewidth": 2, ...})</code> (but <code class="docutils literal notranslate">rcParams.update</code>

does not support abbreviations or grouping).

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rcdefaults</code>()<a class="reference internal" href="../_modules/matplotlib.html#rcdefaults">[source]</a><a class="headerlink" href="#matplotlib.rcdefaults" title="Permalink to this definition">¶</a></dt>

<dd>Restore the rc params from Matplotlib's internal default style.

Style-blacklisted rc params (defined in

<code class="xref py py-obj docutils literal notranslate">matplotlib.style.core.STYLE_BLACKLIST</code>) are not updated.

See also

<dt><a class="reference internal" href="#matplotlib.rc_file_defaults" title="matplotlib.rc_file_defaults"><code class="xref py py-obj docutils literal notranslate">rc_file_defaults</code></a></dt><dd>Restore the rc params from the rc file originally loaded by Matplotlib.</dd>

<dt><a class="reference internal" href="style_api.html#matplotlib.style.use" title="matplotlib.style.use"><code class="xref py py-obj docutils literal notranslate">matplotlib.style.use</code></a></dt><dd>Use a specific style file. Call <code class="docutils literal notranslate">style.use('default')</code> to restore the default style.</dd>

</dl>

</div>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc_file_defaults</code>()<a class="reference internal" href="../_modules/matplotlib.html#rc_file_defaults">[source]</a><a class="headerlink" href="#matplotlib.rc_file_defaults" title="Permalink to this definition">¶</a></dt>

<dd>Restore the rc params from the original rc file loaded by Matplotlib.

Style-blacklisted rc params (defined in

<code class="xref py py-obj docutils literal notranslate">matplotlib.style.core.STYLE_BLACKLIST</code>) are not updated.

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc_file</code>(fname, \*, use_default_template=True)<a class="reference internal" href="../_modules/matplotlib.html#rc_file">[source]</a><a class="headerlink" href="#matplotlib.rc_file" title="Permalink to this definition">¶</a></dt>

<dd>Update rc params from file.

Style-blacklisted rc params (defined in

<code class="xref py py-obj docutils literal notranslate">matplotlib.style.core.STYLE_BLACKLIST</code>) are not updated.

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

<dt>fnamestr</dt><dd>Name of file parsed for matplotlib settings.

</dd>

<dt>use_default_templatebool</dt><dd>If True, initialize with default parameters before updating with those

in the given file. If False, the current configuration persists

and only the parameters specified in the file are updated.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc_params</code>(fail_on_error=False)<a class="reference internal" href="../_modules/matplotlib.html#rc_params">[source]</a><a class="headerlink" href="#matplotlib.rc_params" title="Permalink to this definition">¶</a></dt>

<dd>Construct a <a class="reference internal" href="#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-obj docutils literal notranslate">RcParams</code></a> instance from the default Matplotlib rc file.

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">rc_params_from_file</code>(fname, fail_on_error=False, use_default_template=True)<a class="reference internal" href="../_modules/matplotlib.html#rc_params_from_file">[source]</a><a class="headerlink" href="#matplotlib.rc_params_from_file" title="Permalink to this definition">¶</a></dt>

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

<dt>fnamestr or path-like</dt><dd>Name of file parsed for Matplotlib settings.

</dd>

<dt>fail_on_errorbool</dt><dd>If True, raise an error when the parser fails to convert a parameter.

</dd>

<dt>use_default_templatebool</dt><dd>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.)

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">matplotlib_fname</code>()<a class="reference internal" href="../_modules/matplotlib.html#matplotlib_fname">[source]</a><a class="headerlink" href="#matplotlib.matplotlib_fname" title="Permalink to this definition">¶</a></dt>

<dd>Get the location of the config file.

The file location is determined in the following order

<li><code class="docutils literal notranslate">$PWD/matplotlibrc</code></li>

<li><code class="docutils literal notranslate">$MATPLOTLIBRC</code> if it is not a directory</li>

<li><code class="docutils literal notranslate">$MATPLOTLIBRC/matplotlibrc</code></li>

<li><code class="docutils literal notranslate">$MPLCONFIGDIR/matplotlibrc</code></li>

<dt>On Linux,</dt><dd><ul>

<li><code class="docutils literal notranslate">$XDG_CONFIG_HOME/matplotlib/matplotlibrc</code> (if <code class="docutils literal notranslate">$XDG_CONFIG_HOME</code>

is defined)</li>

<li>or <code class="docutils literal notranslate">$HOME/.config/matplotlib/matplotlibrc</code> (if <code class="docutils literal notranslate">$XDG_CONFIG_HOME</code>

is not defined)</li>

</ul>

</dd>

</dl>

</li>

<li>On other platforms,

- <code class="docutils literal notranslate">$HOME/.matplotlib/matplotlibrc</code> if <code class="docutils literal notranslate">$HOME</code> is defined</li>

<li>Lastly, it looks in <code class="docutils literal notranslate">$MATPLOTLIBDATA/matplotlibrc</code>, which should always

exist.</li>

</ul>

</dd></dl>

<code class="descclassname">matplotlib.</code><code class="descname">get_data_path</code>(\*, _from_rc=None)<a class="reference internal" href="../_modules/matplotlib.html#get_data_path">[source]</a><a class="headerlink" href="#matplotlib.get_data_path" title="Permalink to this definition">¶</a></dt>

<dd>Return the path to Matplotlib data.

</dd></dl>

</div>

<h2>Logging<a class="headerlink" href="#logging" title="Permalink to this headline">¶</a></h2>

<code class="descclassname">matplotlib.</code><code class="descname">set_loglevel</code>(level)<a class="reference internal" href="../_modules/matplotlib.html#set_loglevel">[source]</a><a class="headerlink" href="#matplotlib.set_loglevel" title="Permalink to this definition">¶</a></dt>

<dd>Sets the Matplotlib's root logger and root logger handler level, creating

the handler if it does not exist yet.

Typically, one should call <code class="docutils literal notranslate">set_loglevel("info")</code> or

<code class="docutils literal notranslate">set_loglevel("debug")</code> to get additional debugging information.

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

<dt>level{"notset", "debug", "info", "warning", "error", "critical"}</dt><dd>The log level of the handler.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

The first time this function is called, an additional handler is attached

to Matplotlib's root handler; this handler is reused every time and this

function simply manipulates the logger and handler's level.

</dd></dl>

</div>

</div>

Last updated on Apr 08, 2020.

Created using

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

Doc version v3.2.1-13-g7a9bc5ebb-dirty.

</div>

</footer>

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

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