matplotlib.github.com/3.3.4/api/spines_api.html at main · matplotlib/matplotlib.github.com

History

491 lines (449 loc) · 39.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

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

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

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

<head>

<title>matplotlib.spines — Matplotlib 3.3.4 documentation</title>

title="Search within Matplotlib 3.3.4 documentation"

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

</head><body>

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

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.3.4</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="style_api.html" title="matplotlib.style"

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

<a href="sphinxext_plot_directive_api.html" title="matplotlib.sphinxext.plot_directive"

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

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

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

</div>

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

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

<dd>Bases: <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal notranslate">matplotlib.patches.Patch</code></a>

An axis spine -- the line noting the data area boundaries.

Spines are the lines connecting the axis tick marks and noting the

boundaries of the data area. They can be placed at arbitrary

positions. See <a class="reference internal" href="#matplotlib.spines.Spine.set_position" title="matplotlib.spines.Spine.set_position"><code class="xref py py-obj docutils literal notranslate">set_position</code></a> for more information.

The default position is <code class="docutils literal notranslate">('outward', 0)</code>.

Spines are subclasses of <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-obj docutils literal notranslate">Patch</code></a>, and inherit much of their behavior.

Spines draw a line, a circle, or an arc depending if

<a class="reference internal" href="#matplotlib.spines.Spine.set_patch_line" title="matplotlib.spines.Spine.set_patch_line"><code class="xref py py-obj docutils literal notranslate">set_patch_line</code></a>, <a class="reference internal" href="#matplotlib.spines.Spine.set_patch_circle" title="matplotlib.spines.Spine.set_patch_circle"><code class="xref py py-obj docutils literal notranslate">set_patch_circle</code></a>, or

<a class="reference internal" href="#matplotlib.spines.Spine.set_patch_arc" title="matplotlib.spines.Spine.set_patch_arc"><code class="xref py py-obj docutils literal notranslate">set_patch_arc</code></a> has been called. Line-like is the default.

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

<dt>axes<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">Axes</code></a></dt><dd>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">Axes</code></a> instance containing the spine.

</dd>

<dt>spine_typestr</dt><dd>The spine type.

</dd>

<dt>path<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a></dt><dd>The <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> instance used to draw the spine.

</dd>

</dl>

</td>

</tr>

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

<dt>**kwargs</dt><dd>Valid keyword arguments are:

</colgroup>

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

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

</tr>

</thead>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate">agg_filter</code></a></td>

<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate">alpha</code></a></td>

<td>float or None</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate">animated</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_antialiased" title="matplotlib.patches.Patch.set_antialiased"><code class="xref py py-meth docutils literal notranslate">antialiased</code></a> or aa</td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_capstyle" title="matplotlib.patches.Patch.set_capstyle"><code class="xref py py-meth docutils literal notranslate">capstyle</code></a></td>

<td>{'butt', 'round', 'projecting'}</td>

</tr>

</tr>

</tr>

<td>Patch or (Path, Transform) or None</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_color" title="matplotlib.patches.Patch.set_color"><code class="xref py py-meth docutils literal notranslate">color</code></a></td>

<td>color</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate">contains</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_edgecolor" title="matplotlib.patches.Patch.set_edgecolor"><code class="xref py py-meth docutils literal notranslate">edgecolor</code></a> or ec</td>

<td>color or None or 'auto'</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_facecolor" title="matplotlib.patches.Patch.set_facecolor"><code class="xref py py-meth docutils literal notranslate">facecolor</code></a> or fc</td>

<td>color or None</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate">figure</code></a></td>

<td><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate">Figure</code></a></td>

</tr>

</tr>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_hatch" title="matplotlib.patches.Patch.set_hatch"><code class="xref py py-meth docutils literal notranslate">hatch</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_in_layout.html#matplotlib.artist.Artist.set_in_layout" title="matplotlib.artist.Artist.set_in_layout"><code class="xref py py-meth docutils literal notranslate">in_layout</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_joinstyle" title="matplotlib.patches.Patch.set_joinstyle"><code class="xref py py-meth docutils literal notranslate">joinstyle</code></a></td>

<td>{'miter', 'round', 'bevel'}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate">label</code></a></td>

<td>object</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_linestyle" title="matplotlib.patches.Patch.set_linestyle"><code class="xref py py-meth docutils literal notranslate">linestyle</code></a> or ls</td>

<td>{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_linewidth" title="matplotlib.patches.Patch.set_linewidth"><code class="xref py py-meth docutils literal notranslate">linewidth</code></a> or lw</td>

<td>float or None</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate">path_effects</code></a></td>

<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate">AbstractPathEffect</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate">picker</code></a></td>

<td>None or bool or callable</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate">rasterized</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate">sketch_params</code></a></td>

<td>(scale: float, length: float, randomness: float)</td>

</tr>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate">transform</code></a></td>

<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">Transform</code></a></td>

</tr>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate">visible</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate">zorder</code></a></td>

<td>float</td>

</tr>

</tbody>

</table>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

classmethod <code class="descname">arc_spine</code>(axes, spine_type, center, radius, theta1, theta2, **kwargs)<a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.arc_spine">[source]</a><a class="headerlink" href="#matplotlib.spines.Spine.arc_spine" title="Permalink to this definition">¶</a></dt>

<dd>Create and return an arc <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate">Spine</code></a>.

</dd></dl>

classmethod <code class="descname">circular_spine</code>(axes, center, radius, **kwargs)<a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.circular_spine">[source]</a><a class="headerlink" href="#matplotlib.spines.Spine.circular_spine" title="Permalink to this definition">¶</a></dt>

<dd>Create and return a circular <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate">Spine</code></a>.

</dd></dl>

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

<dd>Clear the current spine.

</dd></dl>

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

<dd>Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (<a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_visible.html#matplotlib.artist.Artist.get_visible" title="matplotlib.artist.Artist.get_visible"><code class="xref py py-obj docutils literal notranslate">Artist.get_visible</code></a>

returns False).

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

<dt>renderer<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate">RendererBase</code></a> subclass.</dt><dd></dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

This method is overridden in the Artist subclasses.

</dd></dl>

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

<dd>Get the bounds of the spine.

</dd></dl>

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

<dd>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">Transform</code></a> instance mapping patch coordinates

to data coordinates.

For example, one may define a patch of a circle which represents a

radius of 5 by providing coordinates for a unit circle, and a

transform which scales the coordinates (the patch coordinate) by 5.

</dd></dl>

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

<dd>Return the path of this patch.

</dd></dl>

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

<dd>Return the spine position.

</dd></dl>

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

<dd>[Deprecated] Return whether the spine has smart bounds.

Notes

Deprecated since version 3.2.

</div>

</dd></dl>

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

<dd>Return the spine transform.

</dd></dl>

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

<dd>Return the window extent of the spines in display space, including

padding for ticks (but not their labels)

See also

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

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

</dl>

</div>

</dd></dl>

classmethod <code class="descname">linear_spine</code>(axes, spine_type, **kwargs)<a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.linear_spine">[source]</a><a class="headerlink" href="#matplotlib.spines.Spine.linear_spine" title="Permalink to this definition">¶</a></dt>

<dd>Create and return a linear <a class="reference internal" href="#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate">Spine</code></a>.

</dd></dl>

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

<dd>Register an axis.

An axis should be registered with its corresponding spine from

the Axes instance. This allows the spine to clear any axis

properties when needed.

</dd></dl>

<code class="descname">set_bounds</code>(self, low=None, high=None)<a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_bounds">[source]</a><a class="headerlink" href="#matplotlib.spines.Spine.set_bounds" title="Permalink to this definition">¶</a></dt>

<dd>Set the spine bounds.

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

<dt>lowfloat or None, optional</dt><dd>The lower spine bound. Passing None leaves the limit unchanged.

The bounds may also be passed as the tuple (low, high) as the

first positional argument.

</dd>

<dt>highfloat or None, optional</dt><dd>The higher spine bound. Passing None leaves the limit unchanged.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

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

<dd>Set the edgecolor.

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

<dt>ccolor</dt><dd></dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

This method does not modify the facecolor (which defaults to "none"),

unlike the <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_color" title="matplotlib.patches.Patch.set_color"><code class="xref py py-obj docutils literal notranslate">Patch.set_color</code></a> method defined in the parent class. Use

<a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_facecolor" title="matplotlib.patches.Patch.set_facecolor"><code class="xref py py-obj docutils literal notranslate">Patch.set_facecolor</code></a> to set the facecolor.

</dd></dl>

<code class="descname">set_patch_arc</code>(self, center, radius, theta1, theta2)<a class="reference internal" href="../_modules/matplotlib/spines.html#Spine.set_patch_arc">[source]</a><a class="headerlink" href="#matplotlib.spines.Spine.set_patch_arc" title="Permalink to this definition">¶</a></dt>

<dd>Set the spine to be arc-like.

</dd></dl>

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

<dd>Set the spine to be circular.

</dd></dl>

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

<dd>Set the spine to be linear.

</dd></dl>

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

<dd>Set the position of the spine.

Spine position is specified by a 2 tuple of (position type,

amount). The position types are:

<li>'outward': place the spine out from the data area by the specified

number of points. (Negative values place the spine inwards.)</li>

<li>'axes': place the spine at the specified Axes coordinate (0 to 1).</li>

<li>'data': place the spine at the specified data coordinate.</li>

</ul>

Additionally, shorthand notations define a special positions:

<li>'center' -> ('axes', 0.5)</li>

</ul>

</dd></dl>

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

<dd>[Deprecated] Set the spine and associated axis to have smart bounds.

Notes

Deprecated since version 3.2.

</div>

</dd></dl>

</div>

</div>

Last updated on Jan 28, 2021.

Created using

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

Doc version v3.3.4.

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

spines_api.html

Latest commit

History

spines_api.html

File metadata and controls