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

Repository navigation

History

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

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

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.3.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.3.0 documentation"

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

</head>

<body>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");

document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

}

</script>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

piwik_action_name = '';

piwik_idsite = 1;

piwik_url = pkBaseURL + "piwik.php";

piwik_log(piwik_action_name, piwik_idsite, piwik_url);

document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));

}

</script>

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

<h4>Previous topic</h4>

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

title="previous chapter">API Changes</a></p>

<h4>Next topic</h4>

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

title="next chapter">afm (Adobe Font Metrics interface)</a></p>

<li><a href="../_sources/api/matplotlib_configuration_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>The top level <tt class="xref py py-mod docutils literal"><span class="pre">matplotlib</span></tt> module<a class="headerlink" href="#the-top-level-matplotlib-module" title="Permalink to this headline">¶</a></h1>

<tt class="descclassname">matplotlib.</tt><tt class="descname">use</tt><big>(</big><em>arg</em>, <em>warn=True</em>, <em>force=False</em><big>)</big><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"><tt class="xref py py-func docutils literal"><span class="pre">pyplot.switch_backend()</span></tt></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"><tt class="xref py py-func docutils literal"><span class="pre">matplotlib.get_backend()</span></tt></a>.</p>

</dd></dl>

<tt class="descclassname">matplotlib.</tt><tt class="descname">get_backend</tt><big>(</big><big>)</big><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>

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

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

</dd></dl>

<tt class="descclassname">matplotlib.</tt><tt class="descname">rc</tt><big>(</big><em>group</em>, <em>**kwargs</em><big>)</big><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 <tt class="docutils literal"><span class="pre">lines.linewidth</span></tt> the group is <tt class="docutils literal"><span class="pre">lines</span></tt>, for

<tt class="docutils literal"><span class="pre">axes.facecolor</span></tt>, the group is <tt class="docutils literal"><span class="pre">axes</span></tt>, 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, eg:</p>

<div class="highlight-python"><div class="highlight"><pre><span class="n">rc</span><span class="p">(</span><span class="s">'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="s">'r'</span><span class="p">)</span>

</pre></div>

</div>

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

<div class="highlight-python"><div class="highlight"><pre><span class="n">rcParams</span><span class="p">[</span><span class="s">'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="s">'lines.color'</span><span class="p">]</span> <span class="o">=</span> <span class="s">'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-python"><div class="highlight"><pre><span class="n">rc</span><span class="p">(</span><span class="s">'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="s">'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-python"><div class="highlight"><pre><span class="n">font</span> <span class="o">=</span> <span class="p">{</span><span class="s">'family'</span> <span class="p">:</span> <span class="s">'monospace'</span><span class="p">,</span>

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

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

<span class="n">rc</span><span class="p">(</span><span class="s">'font'</span><span class="p">,</span> <span class="o">**</span><span class="n">font</span><span class="p">)</span> <span class="c"># 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"><tt class="xref py py-func docutils literal"><span class="pre">rcdefaults()</span></tt></a> to restore the default

rc params after changes.</p>

</dd></dl>

<tt class="descclassname">matplotlib.</tt><tt class="descname">matplotlib_fname</tt><big>(</big><big>)</big><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"><tt class="xref py py-obj docutils literal"><span class="pre">$PWD/matplotlibrc</span></tt></p>

</li>

<li><p class="first">environment variable <tt class="xref py py-obj docutils literal"><span class="pre">MATPLOTLIBRC</span></tt></p>

</li>

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

</li>

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

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

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

$XDG_CONFIG_HOME is defined)</li>

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

$XDG_CONFIG_HOME is not defined)</li>

</ul>

</div></blockquote>

</li>

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

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

</ul>

</div></blockquote>

</li>

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

system-defined copy.</p>

</li>

</ul>

</dd></dl>

<em class="property">class </em><tt class="descclassname">matplotlib.</tt><tt class="descname">RcParams</tt><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

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

</dd></dl>

<tt class="descclassname">matplotlib.</tt><tt class="descname">rc_params</tt><big>(</big><em>fail_on_error=False</em><big>)</big><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"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.RcParams</span></tt></a> instance from the

default matplotlib rc file.</p>

</dd></dl>

<tt class="descclassname">matplotlib.</tt><tt class="descname">rc_params_from_file</tt><big>(</big><em>fname</em>, <em>fail_on_error=False</em><big>)</big><a class="headerlink" href="#matplotlib.rc_params_from_file" title="Permalink to this definition">¶</a></dt>

contents of the given filename.</p>

</dd></dl>

<em class="property">class </em><tt class="descclassname">matplotlib.</tt><tt class="descname">rc_context</tt><big>(</big><em>rc=None</em>, <em>fname=None</em><big>)</big><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="s">'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-python"><div class="highlight"><pre><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="s">'text.usetex'</span><span class="p">:</span> <span class="bp">True</span><span class="p">},</span> <span class="n">fname</span><span class="o">=</span><span class="s">'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>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

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

>next</a> |</li>

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

>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" >The Matplotlib API</a> »</li>

</ul>

</div>

Last updated on Jul 31, 2013.

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.

</div>

</body>

</html>

FilesExpand file tree

matplotlib_configuration_api.html

Latest commit

History

matplotlib_configuration_api.html

File metadata and controls