matplotlib.github.com/3.3.3/api/style_api.html at main · matplotlib/matplotlib.github.com · GitHub

History

266 lines (240 loc) · 14.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

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

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

<head>

<title>matplotlib.style — Matplotlib 3.3.3 documentation</title>

title="Search within Matplotlib 3.3.3 documentation"

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

</head><body>

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

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.3</span></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="table_api.html" title="matplotlib.table"

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

<a href="spines_api.html" title="matplotlib.spines"

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>

<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.style</span></code></a></li>

</ul>

</div>

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

<li>Next: <a href="table_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.table</span></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/style_api.rst.txt"

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

</div>

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

<p>Styles are predefined sets of <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a> that define the visual appearance of

a plot.</p>

<p><a class="reference internal" href="../tutorials/introductory/customizing.html"><span class="doc">Customizing Matplotlib with style sheets and rcParams</span></a> describes the mechanism and usage

of styles.</p>

<p>The <a class="reference internal" href="../gallery/style_sheets/style_sheets_reference.html"><span class="doc">Style sheets reference</span></a> gives an overview of

the builtin styles.</p>

<code class="descclassname">matplotlib.style.</code><code class="descname">context</code><span class="sig-paren">(</span><em><span class="n">style</span></em>, <em><span class="n">after_reset</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/style/core.html#context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.style.context" title="Permalink to this definition">¶</a></dt>

<dd><p>Context manager for using style settings temporarily.</p>

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

<dt><strong>style</strong><span class="classifier">str, dict, Path or list</span></dt><dd><p>A style specification. Valid options are:</p>

</colgroup>

<td>The name of a style or a path/URL to a style file. For a

list of available style names, see <code class="xref py py-obj docutils literal notranslate"><span class="pre">style.available</span></code>.</td>

</tr>

<td>Dictionary with valid key/value pairs for

<a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.rcParams</span></code></a>.</td>

</tr>

<td>A path-like object which is a path to a style file.</td>

</tr>

<td>A list of style specifiers (str, Path or dict) applied from

first to last in the list.</td>

</tr>

</tbody>

</table>

</dd>

<dt><strong>after_reset</strong><span class="classifier">bool</span></dt><dd><p>If True, apply style after resetting settings to their defaults;

otherwise, apply style on top of the current settings.</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">matplotlib.style.</code><code class="descname">reload_library</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/style/core.html#reload_library"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.style.reload_library" title="Permalink to this definition">¶</a></dt>

<dd><p>Reload the style library.</p>

</dd></dl>

<code class="descclassname">matplotlib.style.</code><code class="descname">use</code><span class="sig-paren">(</span><em><span class="n">style</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/style/core.html#use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.style.use" title="Permalink to this definition">¶</a></dt>

<dd><p>Use Matplotlib style settings from a style specification.</p>

<p>The style name of 'default' is reserved for reverting back to

the default style settings.</p>

<p class="last">This updates the <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a> with the settings from the style.

</div>

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

<dt><strong>style</strong><span class="classifier">str, dict, Path or list</span></dt><dd><p>A style specification. Valid options are:</p>

</colgroup>

<td>The name of a style or a path/URL to a style file. For a

list of available style names, see <code class="xref py py-obj docutils literal notranslate"><span class="pre">style.available</span></code>.</td>

</tr>

<td>Dictionary with valid key/value pairs for

</tr>

<td>A path-like object which is a path to a style file.</td>

</tr>

<td>A list of style specifiers (str, Path or dict) applied from

first to last in the list.</td>

</tr>

</tbody>

</table>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

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

<dd><p>A dict mapping from style name to <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.RcParams" title="matplotlib.RcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RcParams</span></code></a> defining that style.</p>

<p>This is meant to be read-only. Use <a class="reference internal" href="#matplotlib.style.reload_library" title="matplotlib.style.reload_library"><code class="xref py py-obj docutils literal notranslate"><span class="pre">reload_library</span></code></a> to update.</p>

</dd></dl>

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

<dd><p>List of the names of the available styles.</p>

</dd></dl>

</div>

</div>

<br />

Last updated on Nov 12, 2020.

Created using

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

Doc version v3.3.3-2-g447bdbbf58.

</div>

</footer>

</body>

</html>

matplotlib.github.com/3.3.3/api/style_api.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

style_api.html

Latest commit

History

Breadcrumbs

style_api.html

File metadata and controls