matplotlib.github.com/3.0.3/api/category_api.html at main · u7228810/matplotlib.github.com · GitHub

History

366 lines (329 loc) · 20.5 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

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

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

<head>

<title>matplotlib.category — Matplotlib 3.0.3 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.0.3 documentation"

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

</head>

<body>

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

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.0.3</span></div>

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

</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="cbook_api.html" title="cbook"

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

<a href="blocking_input_api.html" title="blocking_input"

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

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

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

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<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="blocking_input_api.html" title="previous chapter">blocking_input</a></li>

<li>Next: <a href="cbook_api.html" title="next chapter">cbook</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/category_api.rst.txt"

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

</div>

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

<p>Module that allows plotting of string "category" data. i.e.

<code class="docutils literal notranslate"><span class="pre">plot(['d',</span> <span class="pre">'f',</span> <span class="pre">'a'],[1,</span> <span class="pre">2,</span> <span class="pre">3])</span></code> will plot three points with x-axis

values of 'd', 'f', 'a'.</p>

<p>See <a class="reference internal" href="../gallery/lines_bars_and_markers/categorical_variables.html"><span class="doc">Plotting categorical variables</span></a> for an

example.</p>

<p>The module uses Matplotlib's <a class="reference internal" href="units_api.html#module-matplotlib.units" title="matplotlib.units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.units</span></code></a> mechanism to convert from

strings to integers, provides a tick locator and formatter, and the

class:<a class="reference internal" href="#matplotlib.category.UnitData" title="matplotlib.category.UnitData"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnitData</span></code></a> that creates and stores the string-to-integer mapping.</p>

<em class="property">class </em><code class="descclassname">matplotlib.category.</code><code class="descname">StrCategoryConverter</code><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryConverter" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <a class="reference internal" href="units_api.html#matplotlib.units.ConversionInterface" title="matplotlib.units.ConversionInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.units.ConversionInterface</span></code></a></p>

<em class="property">static </em><code class="descname">axisinfo</code><span class="sig-paren">(</span><em>unit</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryConverter.axisinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryConverter.axisinfo" title="Permalink to this definition">¶</a></dt>

<dd><p>Sets the default axis ticks and labels</p>

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

<dt><strong>unit</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="#matplotlib.category.UnitData" title="matplotlib.category.UnitData"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnitData</span></code></a></span></dt>

<dd><p class="first last">object string unit information for value</p>

</dd>

<dd><p class="first last">axis for which information is being set</p>

</dd>

</dl>

</td>

</tr>

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

<dt><strong>axisinfo</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="units_api.html#matplotlib.units.AxisInfo" title="matplotlib.units.AxisInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AxisInfo</span></code></a></span></dt>

<dd><p class="first last">Information to support default tick labeling</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<em class="property">static </em><code class="descname">convert</code><span class="sig-paren">(</span><em>value</em>, <em>unit</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryConverter.convert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryConverter.convert" title="Permalink to this definition">¶</a></dt>

<dd><p>Converts strings in value to floats using

mapping information store in the unit object.</p>

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

<dt><strong>value</strong> <span class="classifier-delimiter">:</span> <span class="classifier">string or iterable</span></dt>

<dd><p class="first last">value or list of values to be converted</p>

</dd>

<dt><strong>unit</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="#matplotlib.category.UnitData" title="matplotlib.category.UnitData"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnitData</span></code></a></span></dt>

<dd><p class="first last">object string unit information for value</p>

</dd>

<dd><p class="first last">axis on which the converted value is plotted</p>

</dd>

</dl>

</td>

</tr>

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

<dt><strong>mapped_ value</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float or ndarray[float]</span></dt>

<dt><strong>.. note:: axis is not used in this function</strong></dt>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<em class="property">static </em><code class="descname">default_units</code><span class="sig-paren">(</span><em>data</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryConverter.default_units"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryConverter.default_units" title="Permalink to this definition">¶</a></dt>

<dd><p>Sets and updates the <code class="xref py py-class docutils literal notranslate"><span class="pre">axis</span></code> units.</p>

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

<dt><strong>data</strong> <span class="classifier-delimiter">:</span> <span class="classifier">string or iterable of strings</span></dt>

<dd><p class="first last">axis on which the data is plotted</p>

</dd>

</dl>

</td>

</tr>

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

<dt><strong>class:~.UnitData~</strong></dt>

<dd><p class="first last">object storing string to integer mapping</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

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

<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>

<p>String representation of the data at every tick</p>

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

<dt><strong>units_mapping</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Dict[Str, int]</span></dt>

<dd><p class="first last">string:integer mapping</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

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

<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>

<p>tick at every integer mapping of the string data</p>

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

<dt><strong>units_mapping</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Dict[str, int]</span></dt>

<dd><p class="first last">string:integer mapping</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/category.html#StrCategoryLocator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.category.StrCategoryLocator.tick_values" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the values of the located ticks given <strong>vmin</strong> and <strong>vmax</strong>.</p>

<p>To get tick locations with the vmin and vmax values defined

automatically for the associated <code class="xref py py-attr docutils literal notranslate"><span class="pre">axis</span></code> simply call

the Locator instance:</p>

<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">loc</span><span class="p">))</span>

<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">loc</span><span class="p">())</span>

</pre></div>

</div>

</dd></dl>

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

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>Create mapping between unique categorical values and integer ids.</p>

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

<dt><strong>data: iterable</strong></dt>

<dd><p class="first last">sequence of string values</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

<dd><p>Maps new values to integer identifiers.</p>

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

<dt><strong>data: iterable</strong></dt>

<dd><p class="first last">sequence of string values</p>

</dd>

</dl>

</td>

</tr>

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

<dt><strong>TypeError</strong></dt>

<dd><p class="first last">If the value in data is not a string, unicode, bytes type</p>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

</div>

<br />

Last updated on Feb 28, 2019.

Created using

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

Doc version v3.0.3-2-gfc177a9cd.

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

</footer>

</html>

matplotlib.github.com/3.0.3/api/category_api.html at main · u7228810/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

category_api.html

Latest commit

History

Breadcrumbs

category_api.html

File metadata and controls