matplotlib.github.com/3.1.1/api/markers_api.html at main · matplotlib/matplotlib.github.com

History

425 lines (397 loc) · 22.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

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

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

<head>

<title>matplotlib.markers — Matplotlib 3.1.2 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.2 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.1.1). For the latest version see <a href="https://matplotlib.org/stable/api/markers_api.html">https://matplotlib.org/stable/api/markers_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.1.2</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>

</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="_as_gen/matplotlib.markers.MarkerStyle.html" title="matplotlib.markers.MarkerStyle"

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

<a href="_as_gen/matplotlib.lines.segment_hits.html" title="matplotlib.lines.segment_hits"

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

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

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

<ul>

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

<li><a class="reference internal" href="#classes">Classes</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="_as_gen/matplotlib.lines.segment_hits.html" title="previous chapter">matplotlib.lines.segment_hits</a></li>

<li>Next: <a href="_as_gen/matplotlib.markers.MarkerStyle.html" title="next chapter">matplotlib.markers.MarkerStyle</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/markers_api.rst.txt"

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

</div>

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

<p>This module contains functions to handle markers. Used by both the

marker functionality of <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot</span></code></a> and

<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scatter</span></code></a>.</p>

<p>All possible markers are defined here:</p>

</colgroup>

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

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

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

</tr>

</thead>

<td>point</td>

</tr>

<td>pixel</td>

</tr>

<td>circle</td>

</tr>

<td>triangle_down</td>

</tr>

<td>triangle_up</td>

</tr>

<td>triangle_left</td>

</tr>

<td>triangle_right</td>

</tr>

</tr>

</tr>

</tr>

<td>tri_right</td>

</tr>

<td>octagon</td>

</tr>

<td>square</td>

</tr>

<td>pentagon</td>

</tr>

<td>plus (filled)</td>

</tr>

</tr>

<td>hexagon1</td>

</tr>

<td>hexagon2</td>

</tr>

</tr>

</tr>

<td>x (filled)</td>

</tr>

<td>diamond</td>

</tr>

<td>thin_diamond</td>

</tr>

<td>vline</td>

</tr>

<td>hline</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">0</span></code> (<code class="docutils literal notranslate"><span class="pre">TICKLEFT</span></code>)</td>

<td>tickleft</td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">1</span></code> (<code class="docutils literal notranslate"><span class="pre">TICKRIGHT</span></code>)</td>

<td>tickright</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">2</span></code> (<code class="docutils literal notranslate"><span class="pre">TICKUP</span></code>)</td>

<td>tickup</td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">3</span></code> (<code class="docutils literal notranslate"><span class="pre">TICKDOWN</span></code>)</td>

<td>tickdown</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">4</span></code> (<code class="docutils literal notranslate"><span class="pre">CARETLEFT</span></code>)</td>

<td>caretleft</td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">5</span></code> (<code class="docutils literal notranslate"><span class="pre">CARETRIGHT</span></code>)</td>

<td>caretright</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">6</span></code> (<code class="docutils literal notranslate"><span class="pre">CARETUP</span></code>)</td>

<td>caretup</td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">7</span></code> (<code class="docutils literal notranslate"><span class="pre">CARETDOWN</span></code>)</td>

<td>caretdown</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">8</span></code> (<code class="docutils literal notranslate"><span class="pre">CARETLEFTBASE</span></code>)</td>

<td>caretleft (centered at base)</td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">9</span></code> (<code class="docutils literal notranslate"><span class="pre">CARETRIGHTBASE</span></code>)</td>

<td>caretright (centered at base)</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">10</span></code> (<code class="docutils literal notranslate"><span class="pre">CARETUPBASE</span></code>)</td>

<td>caretup (centered at base)</td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">11</span></code> (<code class="docutils literal notranslate"><span class="pre">CARETDOWNBASE</span></code>)</td>

<td>caretdown (centered at base)</td>

</tr>

<td>nothing</td>

</tr>

<td>Render the string using mathtext.

E.g <code class="docutils literal notranslate"><span class="pre">"$f$"</span></code> for marker showing the

letter <code class="docutils literal notranslate"><span class="pre">f</span></code>.</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">verts</span></code></td>

<td>A list of (x, y) pairs used for Path

vertices. The center of the marker is

located at (0,0) and the size is

normalized, such that the created path

is encapsulated inside the unit cell.</td>

</tr>

<td>A <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a> instance.</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">(numsides,</span> <span class="pre">style,</span> <span class="pre">angle)</span></code></td>

<td><p class="first">The marker can also be a tuple

<code class="docutils literal notranslate"><span class="pre">(numsides,</span> <span class="pre">style,</span> <span class="pre">angle)</span></code>, which

will create a custom, regular symbol.</p>

<dt><code class="docutils literal notranslate"><span class="pre">numsides</span></code>:</dt>

<dd>the number of sides</dd>

<dt><code class="docutils literal notranslate"><span class="pre">style</span></code>:</dt>

<dd><p class="first">the style of the regular symbol:</p>

<li>0: a regular polygon</li>

<li>1: a star-like symbol</li>

<li>2: an asterisk</li>

<li>3: a circle (<code class="docutils literal notranslate"><span class="pre">numsides</span></code> and

<code class="docutils literal notranslate"><span class="pre">angle</span></code> is ignored);

deprecated.</li>

</ul>

</dd>

<dt><code class="docutils literal notranslate"><span class="pre">angle</span></code>:</dt>

<dd>the angle of rotation of the symbol</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<p>For backward compatibility, the form <code class="docutils literal notranslate"><span class="pre">(verts,</span> <span class="pre">0)</span></code> is also accepted, but it is

deprecated and equivalent to just <code class="docutils literal notranslate"><span class="pre">verts</span></code> for giving a raw set of vertices

that define the shape.</p>

<p><code class="docutils literal notranslate"><span class="pre">None</span></code> is the default which means 'nothing', however this table is

referred to from other docs for the valid inputs from marker inputs and in

those cases <code class="docutils literal notranslate"><span class="pre">None</span></code> still means 'default'.</p>

<p>Note that special symbols can be defined via the

<a class="reference internal" href="../tutorials/text/mathtext.html"><span class="doc">STIX math font</span></a>,

e.g. <code class="docutils literal notranslate"><span class="pre">"$♫$"</span></code>. For an overview over the STIX font symbols refer to the

<a class="reference external" href="http://www.stixfonts.org/allGlyphs.html">STIX font table</a>.

Also see the <a class="reference internal" href="../gallery/text_labels_and_annotations/stix_fonts_demo.html"><span class="doc">STIX Fonts Demo</span></a>.</p>

<p>Integer numbers from <code class="docutils literal notranslate"><span class="pre">0</span></code> to <code class="docutils literal notranslate"><span class="pre">11</span></code> create lines and triangles. Those are

equally accessible via capitalized variables, like <code class="docutils literal notranslate"><span class="pre">CARETDOWNBASE</span></code>.

Hence the following are equivalent:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">marker</span><span class="o">=</span><span class="mi">11</span><span class="p">)</span>

<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">marker</span><span class="o">=</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">markers</span><span class="o">.</span><span class="n">CARETDOWNBASE</span><span class="p">)</span>

</pre></div>

</div>

<p>Examples showing the use of markers:</p>

<li><a class="reference internal" href="../gallery/lines_bars_and_markers/marker_reference.html"><span class="doc">Marker Reference</span></a></li>

<li><a class="reference internal" href="../gallery/lines_bars_and_markers/marker_fillstyle_reference.html"><span class="doc">Marker filling-styles</span></a></li>

<li><a class="reference internal" href="../gallery/shapes_and_collections/marker_path.html"><span class="doc">Marker Path</span></a></li>

</ul>

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

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.markers.MarkerStyle.html#matplotlib.markers.MarkerStyle" title="matplotlib.markers.MarkerStyle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MarkerStyle</span></code></a>([marker, fillstyle])</td>

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

</tr>

</tbody>

</table>

</td>

</tr>

</tbody>

</table>

</div>

</div>

<br />

Last updated on Jan 05, 2020.

Created using

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

Doc version v3.1.1-79-g90d53b526.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

markers_api.html

Latest commit

History

markers_api.html

File metadata and controls