matplotlib.github.com/3.1.0/api/widgets_api.html at gh-pages · matplotlib/matplotlib.github.com

History

1473 lines (1350 loc) · 122 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

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

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

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

<head>

<title>matplotlib.widgets — Matplotlib 3.1.0 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.0 documentation"

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

</head>

<body>

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

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

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

<a href="units_api.html" title="matplotlib.units"

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="../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">matplotlib.widgets</code></a><ul>

<li><a class="reference internal" href="#gui-neutral-widgets">GUI neutral widgets</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="units_api.html" title="previous chapter"><code class="docutils literal notranslate">matplotlib.units</code></a></li>

<li>Next: <a href="toolkits/index.html" title="next chapter">Toolkits</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/widgets_api.rst.txt"

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

</div>

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

</map><div class="section" id="gui-neutral-widgets">

<h2>GUI neutral widgets<a class="headerlink" href="#gui-neutral-widgets" title="Permalink to this headline">¶</a></h2>

Widgets that are designed to work for any of the GUI backends.

All of these widgets require you to predefine a <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate">matplotlib.axes.Axes</code></a>

instance and pass that as the first arg. matplotlib doesn't try to

be too smart with respect to layout -- you will have to figure out how

wide and tall you want your Axes to be to accommodate your widget.

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">AxesWidget</code>(ax)<a class="reference internal" href="../_modules/matplotlib/widgets.html#AxesWidget">[source]</a><a class="headerlink" href="#matplotlib.widgets.AxesWidget" title="Permalink to this definition">¶</a></dt>

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

Widget that is connected to a single

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

To guarantee that the widget remains responsive and not garbage-collected,

a reference to the object should be maintained by the user.

This is necessary because the callback registry

maintains only weak-refs to the functions, which are member

functions of the widget. If there are no references to the widget

object it may be garbage collected which will disconnect the

callbacks.

Attributes:

<dd>The parent axes for the widget</dd>

<dt>canvas : <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.FigureCanvasBase" title="matplotlib.backend_bases.FigureCanvasBase"><code class="xref py py-class docutils literal notranslate">FigureCanvasBase</code></a> subclass</dt>

<dd>The parent figure canvas for the widget.</dd>

<dt>active : bool</dt>

<dd>If False, the widget does not respond to events.</dd>

</dl>

<code class="descname">connect_event</code>(self, event, callback)<a class="reference internal" href="../_modules/matplotlib/widgets.html#AxesWidget.connect_event">[source]</a><a class="headerlink" href="#matplotlib.widgets.AxesWidget.connect_event" title="Permalink to this definition">¶</a></dt>

<dd>Connect callback with an event.

This should be used in lieu of <code class="xref py py-obj docutils literal notranslate">figure.canvas.mpl_connect</code> since this

function stores callback ids for later clean up.

</dd></dl>

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

<dd>Disconnect all events created by this widget.

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">Button</code>(ax, label, image=None, color='0.85', hovercolor='0.95')<a class="reference internal" href="../_modules/matplotlib/widgets.html#Button">[source]</a><a class="headerlink" href="#matplotlib.widgets.Button" title="Permalink to this definition">¶</a></dt>

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

A GUI neutral button.

For the button to remain responsive you must keep a reference to it.

Call <a class="reference internal" href="#matplotlib.widgets.Button.on_clicked" title="matplotlib.widgets.Button.on_clicked"><code class="xref py py-meth docutils literal notranslate">on_clicked()</code></a> to connect to the button.

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

<dd>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate">matplotlib.axes.Axes</code></a> the button renders into.

</dd>

<dt>label</dt>

<dd>A <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate">matplotlib.text.Text</code></a> instance.

</dd>

<dt>color</dt>

<dd>The color of the button when not hovering.

</dd>

<dt>hovercolor</dt>

<dd>The color of the button when hovering.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

<dt>ax : matplotlib.axes.Axes</dt>

will be placed into.

</dd>

<dt>label : str</dt>

<dd>The button text. Accepts string.

</dd>

<dt>image : array, mpl image, Pillow Image</dt>

<dd>The image to place in the button, if not None.

Can be any legal arg to imshow (numpy array,

matplotlib Image instance, or Pillow Image).

</dd>

<dt>color : color</dt>

<dd>The color of the button when not activated

</dd>

<dt>hovercolor : color</dt>

<dd>The color of the button when the mouse is over it

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

<dd>Remove the callback function with connection id cid.

</dd></dl>

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

<dd>Connect the callback function func to button click events.

Returns a connection id, which can be used to disconnect the callback.

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">CheckButtons</code>(ax, labels, actives=None)<a class="reference internal" href="../_modules/matplotlib/widgets.html#CheckButtons">[source]</a><a class="headerlink" href="#matplotlib.widgets.CheckButtons" title="Permalink to this definition">¶</a></dt>

A GUI neutral set of check buttons.

For the check buttons to remain responsive you must keep a

reference to this object.

The following attributes are exposed

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

located in</dd>

<dt>labels</dt>

<dd>List of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate">matplotlib.text.Text</code></a> instances</dd>

<dt>lines</dt>

<dd>List of (line1, line2) tuples for the x's in the check boxes.

These lines exist for each box, but have <code class="docutils literal notranslate">set_visible(False)</code>

when its box is not checked.</dd>

<dt>rectangles</dt>

<dd>List of <a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate">matplotlib.patches.Rectangle</code></a> instances</dd>

</dl>

</div></blockquote>

Connect to the CheckButtons with the <a class="reference internal" href="#matplotlib.widgets.CheckButtons.on_clicked" title="matplotlib.widgets.CheckButtons.on_clicked"><code class="xref py py-meth docutils literal notranslate">on_clicked()</code></a> method

Add check buttons to <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate">matplotlib.axes.Axes</code></a> instance ax

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

<dd>The parent axes for the widget.

</dd>

<dt>labels : List[str]</dt>

<dd>The labels of the check buttons.

</dd>

<dt>actives : List[bool], optional</dt>

<dd>The initial check states of the buttons. The list must have the

same length as labels. If not given, all buttons are unchecked.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

<dd>remove the observer with connection id cid

</dd></dl>

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

<dd>returns a tuple of the status (True/False) of all of the check buttons

</dd></dl>

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

<dd>Connect the callback function func to button click events.

Returns a connection id, which can be used to disconnect the callback.

</dd></dl>

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

<dd>Directly (de)activate a check button by index.

<dt>index is an index into the original label list</dt>

<dd>that this object was constructed with.

Raises ValueError if index is invalid.</dd>

</dl>

Callbacks will be triggered if <code class="xref py py-attr docutils literal notranslate">eventson</code> is True.

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">Cursor</code>(ax, horizOn=True, vertOn=True, useblit=False, **lineprops)<a class="reference internal" href="../_modules/matplotlib/widgets.html#Cursor">[source]</a><a class="headerlink" href="#matplotlib.widgets.Cursor" title="Permalink to this definition">¶</a></dt>

A crosshair cursor that spans the axes and moves with mouse cursor.

For the cursor to remain responsive you must keep a reference to it.

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

<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> to attach the cursor to.

</dd>

<dt>horizOn : bool, optional, default: True</dt>

<dd>Whether to draw the horizontal line.

</dd>

<dt>vertOn : bool, optional, default: True</dt>

<dd>Whether to draw the vertical line.

</dd>

<dt>useblit : bool, optional, default: False</dt>

<dd>Use blitting for faster drawing if supported by the backend.

</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>**lineprops</dt>

<dd><a class="reference internal" href="_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-obj docutils literal notranslate">Line2D</code></a> properties that control the appearance of the lines.

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

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

See <a class="reference internal" href="../gallery/widgets/cursor.html">Cursor</a>.

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

<dd>Internal event handler to clear the cursor.

</dd></dl>

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

<dd>Internal event handler to draw the cursor when the mouse moves.

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">EllipseSelector</code>(ax, onselect, drawtype='box', minspanx=None, minspany=None, useblit=False, lineprops=None, rectprops=None, spancoords='data', button=None, maxdist=10, marker_props=None, interactive=False, state_modifier_keys=None)<a class="reference internal" href="../_modules/matplotlib/widgets.html#EllipseSelector">[source]</a><a class="headerlink" href="#matplotlib.widgets.EllipseSelector" title="Permalink to this definition">¶</a></dt>

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

Select an elliptical region of an axes.

For the cursor to remain responsive you must keep a reference to

it.

Example usage:

<div class="highlight-default notranslate"><div class="highlight"><pre>import numpy as np

import matplotlib.pyplot as plt

from matplotlib.widgets import EllipseSelector

def onselect(eclick, erelease):

"eclick and erelease are matplotlib events at press and release."

print('startposition: (%f, %f)' % (eclick.xdata, eclick.ydata))

print('endposition : (%f, %f)' % (erelease.xdata, erelease.ydata))

print('used button : ', eclick.button)

def toggle_selector(event):

print(' Key pressed.')

if event.key in ['Q', 'q'] and toggle_selector.ES.active:

print('EllipseSelector deactivated.')

toggle_selector.RS.set_active(False)

if event.key in ['A', 'a'] and not toggle_selector.ES.active:

print('EllipseSelector activated.')

toggle_selector.ES.set_active(True)

x = np.arange(100.) / 99

y = np.sin(x)

fig, ax = plt.subplots()

ax.plot(x, y)

toggle_selector.ES = EllipseSelector(ax, onselect, drawtype='line')

fig.canvas.mpl_connect('key_press_event', toggle_selector)

plt.show()

</pre></div>

</div>

Create a selector in ax. When a selection is made, clear

the span and call onselect with:

<div class="highlight-default notranslate"><div class="highlight"><pre>onselect(pos_1, pos_2)

</pre></div>

</div>

and clear the drawn box/line. The <code class="docutils literal notranslate">pos_1</code> and <code class="docutils literal notranslate">pos_2</code> are

arrays of length 2 containing the x- and y-coordinate.

If minspanx is not None then events smaller than minspanx

in x direction are ignored (it's the same for y).

The rectangle is drawn with rectprops; default:

<div class="highlight-default notranslate"><div class="highlight"><pre>rectprops = dict(facecolor='red', edgecolor = 'black',

alpha=0.2, fill=True)

</pre></div>

</div>

The line is drawn with lineprops; default:

<div class="highlight-default notranslate"><div class="highlight"><pre>lineprops = dict(color='black', linestyle='-',

linewidth = 2, alpha=0.5)

</pre></div>

</div>

Use drawtype if you want the mouse to draw a line,

a box or nothing between click and actual position by setting

<code class="docutils literal notranslate">drawtype = 'line'</code>, <code class="docutils literal notranslate">drawtype='box'</code> or <code class="docutils literal notranslate">drawtype = 'none'</code>.

Drawing a line would result in a line from vertex A to vertex C in

a rectangle ABCD.

spancoords is one of 'data' or 'pixels'. If 'data', minspanx

and minspanx will be interpreted in the same coordinates as

the x and y axis. If 'pixels', they are in pixels.

button is a list of integers indicating which mouse buttons should

be used for rectangle selection. You can also specify a single

integer if only a single button is desired. Default is None,

which does not limit which button can be used.

<dt>Note, typically:</dt>

<dd>1 = left mouse button

2 = center mouse button (scroll wheel)

3 = right mouse button</dd>

</dl>

interactive will draw a set of handles and allow you interact

with the widget after it is drawn.

state_modifier_keys are keyboard modifiers that affect the behavior

of the widget.

The defaults are:

dict(move=' ', clear='escape', square='shift', center='ctrl')

Keyboard modifiers, which:

'move': Move the existing shape.

'clear': Clear the current shape.

'square': Makes the shape square.

'center': Make the initial point the center of the shape.

'square' and 'center' can be combined.

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

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">Lasso</code>(ax, xy, callback=None, useblit=True)<a class="reference internal" href="../_modules/matplotlib/widgets.html#Lasso">[source]</a><a class="headerlink" href="#matplotlib.widgets.Lasso" title="Permalink to this definition">¶</a></dt>

Selection curve of an arbitrary shape.

The selected path can be used in conjunction with

<a class="reference internal" href="path_api.html#matplotlib.path.Path.contains_point" title="matplotlib.path.Path.contains_point"><code class="xref py py-func docutils literal notranslate">contains_point()</code></a> to select data points

from an image.

Unlike <a class="reference internal" href="#matplotlib.widgets.LassoSelector" title="matplotlib.widgets.LassoSelector"><code class="xref py py-class docutils literal notranslate">LassoSelector</code></a>, this must be initialized with a starting

point <code class="xref py py-obj docutils literal notranslate">xy</code>, and the <a class="reference internal" href="#matplotlib.widgets.Lasso" title="matplotlib.widgets.Lasso"><code class="xref py py-obj docutils literal notranslate">Lasso</code></a> events are destroyed upon release.

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

<dd>The parent axes for the widget.

</dd>

<dt>xy : (float, float)</dt>

<dd>Coordinates of the start of the lasso.

</dd>

<dt>callback : callable</dt>

<dd>Whenever the lasso is released, the <code class="xref py py-obj docutils literal notranslate">callback</code> function is called and

passed the vertices of the selected path.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

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

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">LassoSelector</code>(ax, onselect=None, useblit=True, lineprops=None, button=None)<a class="reference internal" href="../_modules/matplotlib/widgets.html#LassoSelector">[source]</a><a class="headerlink" href="#matplotlib.widgets.LassoSelector" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">matplotlib.widgets._SelectorWidget</code>

Selection curve of an arbitrary shape.

For the selector to remain responsive you must keep a reference to it.

The selected path can be used in conjunction with <a class="reference internal" href="path_api.html#matplotlib.path.Path.contains_point" title="matplotlib.path.Path.contains_point"><code class="xref py py-obj docutils literal notranslate">contains_point</code></a>

to select data points from an image.

In contrast to <a class="reference internal" href="#matplotlib.widgets.Lasso" title="matplotlib.widgets.Lasso"><code class="xref py py-obj docutils literal notranslate">Lasso</code></a>, <a class="reference internal" href="#matplotlib.widgets.LassoSelector" title="matplotlib.widgets.LassoSelector"><code class="xref py py-obj docutils literal notranslate">LassoSelector</code></a> is written with an interface

similar to <a class="reference internal" href="#matplotlib.widgets.RectangleSelector" title="matplotlib.widgets.RectangleSelector"><code class="xref py py-obj docutils literal notranslate">RectangleSelector</code></a> and <a class="reference internal" href="#matplotlib.widgets.SpanSelector" title="matplotlib.widgets.SpanSelector"><code class="xref py py-obj docutils literal notranslate">SpanSelector</code></a>, and will continue to

interact with the axes until disconnected.

Example usage:

<div class="highlight-default notranslate"><div class="highlight"><pre>ax = subplot(111)

ax.plot(x,y)

def onselect(verts):

print(verts)

lasso = LassoSelector(ax, onselect)

</pre></div>

</div>

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

<dd>The parent axes for the widget.

</dd>

<dt>onselect : function</dt>

<dd>Whenever the lasso is released, the onselect function is called and

passed the vertices of the selected path.

</dd>

<dt>button : List[Int], optional</dt>

<dd>A list of integers indicating which mouse buttons should be used for

rectangle selection. You can also specify a single integer if only a

single button is desired. Default is <code class="docutils literal notranslate">None</code>, which does not limit

which button can be used.

Note, typically:

<li>1 = left mouse button</li>

<li>2 = center mouse button (scroll wheel)</li>

<li>3 = right mouse button</li>

</ul>

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

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

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">LockDraw</code><a class="reference internal" href="../_modules/matplotlib/widgets.html#LockDraw">[source]</a><a class="headerlink" href="#matplotlib.widgets.LockDraw" title="Permalink to this definition">¶</a></dt>

<dd>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">object</code></a>

Some widgets, like the cursor, draw onto the canvas, and this is not

desirable under all circumstances, like when the toolbar is in zoom-to-rect

mode and drawing a rectangle. To avoid this, a widget can acquire a

canvas' lock with <code class="docutils literal notranslate">canvas.widgetlock(widget)</code> before drawing on the

canvas; this will prevent other widgets from doing so at the same time (if

they also try to acquire the lock first).

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

<dd>Return whether drawing is available to o.

</dd></dl>

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

<dd>Return whether o owns this lock.

</dd></dl>

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

<dd>Return whether the lock is currently held by an owner.

</dd></dl>

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

<dd>Release the lock from o.

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">MultiCursor</code>(canvas, axes, useblit=True, horizOn=False, vertOn=True, **lineprops)<a class="reference internal" href="../_modules/matplotlib/widgets.html#MultiCursor">[source]</a><a class="headerlink" href="#matplotlib.widgets.MultiCursor" title="Permalink to this definition">¶</a></dt>

Provide a vertical (default) and/or horizontal line cursor shared between

multiple axes.

For the cursor to remain responsive you must keep a reference to

it.

Example usage:

<div class="highlight-default notranslate"><div class="highlight"><pre>from matplotlib.widgets import MultiCursor

import matplotlib.pyplot as plt

import numpy as np

fig, (ax1, ax2) = plt.subplots(nrows=2, sharex=True)

t = np.arange(0.0, 2.0, 0.01)

ax1.plot(t, np.sin(2*np.pi*t))

ax2.plot(t, np.sin(4*np.pi*t))

multi = MultiCursor(fig.canvas, (ax1, ax2), color='r', lw=1,

horizOn=False, vertOn=True)

plt.show()

</pre></div>

</div>

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

<dd>clear the cursor

</dd></dl>

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

<dd>connect events

</dd></dl>

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

<dd>disconnect events

</dd></dl>

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

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">PolygonSelector</code>(ax, onselect, useblit=False, lineprops=None, markerprops=None, vertex_select_radius=15)<a class="reference internal" href="../_modules/matplotlib/widgets.html#PolygonSelector">[source]</a><a class="headerlink" href="#matplotlib.widgets.PolygonSelector" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">matplotlib.widgets._SelectorWidget</code>

Select a polygon region of an axes.

Place vertices with each mouse click, and make the selection by completing

the polygon (clicking on the first vertex). Hold the ctrl key and click

and drag a vertex to reposition it (the ctrl key is not necessary if the

polygon has already been completed). Hold the shift key and click and

drag anywhere in the axes to move all vertices. Press the esc key to

start a new polygon.

For the selector to remain responsive you must keep a reference to

it.

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

<dd>The parent axes for the widget.

</dd>

<dt>onselect : function</dt>

<dd>When a polygon is completed or modified after completion,

the <code class="xref py py-obj docutils literal notranslate">onselect</code> function is called and passed a list of the vertices as

<code class="docutils literal notranslate">(xdata, ydata)</code> tuples.

</dd>

<dt>useblit : bool, optional</dt>

<dt>lineprops : dict, optional</dt>

<dd>The line for the sides of the polygon is drawn with the properties

given by <code class="xref py py-obj docutils literal notranslate">lineprops</code>. The default is <code class="docutils literal notranslate">dict(color='k', linestyle='-',

linewidth=2, alpha=0.5)</code>.

</dd>

<dt>markerprops : dict, optional</dt>

<dd>The markers for the vertices of the polygon are drawn with the

properties given by <code class="xref py py-obj docutils literal notranslate">markerprops</code>. The default is <code class="docutils literal notranslate">dict(marker='o',

markersize=7, mec='k', mfc='k', alpha=0.5)</code>.

</dd>

<dt>vertex_select_radius : float, optional</dt>

<dd>A vertex is selected (to complete the polygon or to move a vertex)

if the mouse click is within <code class="xref py py-obj docutils literal notranslate">vertex_select_radius</code> pixels of the

vertex. The default radius is 15 pixels.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

<a class="reference internal" href="../gallery/widgets/polygon_selector_demo.html">Polygon Selector Demo</a>

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

<dd>Cursor move event handler and validator

</dd></dl>

<code class="descname">verts</code><a class="headerlink" href="#matplotlib.widgets.PolygonSelector.verts" title="Permalink to this definition">¶</a></dt>

<dd>Get the polygon vertices.

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

<dd>A list of the vertices of the polygon as <code class="docutils literal notranslate">(xdata, ydata)</code> tuples.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">RadioButtons</code>(ax, labels, active=0, activecolor='blue')<a class="reference internal" href="../_modules/matplotlib/widgets.html#RadioButtons">[source]</a><a class="headerlink" href="#matplotlib.widgets.RadioButtons" title="Permalink to this definition">¶</a></dt>

A GUI neutral radio button.

For the buttons to remain responsive you must keep a reference to this

object.

Connect to the RadioButtons with the <a class="reference internal" href="#matplotlib.widgets.RadioButtons.on_clicked" title="matplotlib.widgets.RadioButtons.on_clicked"><code class="xref py py-meth docutils literal notranslate">on_clicked()</code></a> method.

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

<dd>The containing <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.

</dd>

<dt>activecolor</dt>

<dd>The color of the selected button.

</dd>

<dt>labels</dt>

<dd>A list of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate">Text</code></a> instances containing the button labels.

</dd>

<dt>circles</dt>

<dd>A list of <a class="reference internal" href="_as_gen/matplotlib.patches.Circle.html#matplotlib.patches.Circle" title="matplotlib.patches.Circle"><code class="xref py py-obj docutils literal notranslate">Circle</code></a> instances defining the buttons.

</dd>

<dt>value_selected : str</dt>

<dd>The label text of the currently selected button.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Add radio buttons to an <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>.

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

<dd>The axes to add the buttons to.

</dd>

<dt>labels : list of str</dt>

<dd>The button labels.

</dd>

<dt>active : int</dt>

<dd>The index of the initially selected button.

</dd>

<dt>activecolor : color</dt>

<dd>The color of the selected button.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

<dd>Remove the observer with connection id cid.

</dd></dl>

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

<dd>Connect the callback function func to button click events.

Returns a connection id, which can be used to disconnect the callback.

</dd></dl>

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

<dd>Select button with number index.

Callbacks will be triggered if <code class="xref py py-attr docutils literal notranslate">eventson</code> is True.

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">RectangleSelector</code>(ax, onselect, drawtype='box', minspanx=None, minspany=None, useblit=False, lineprops=None, rectprops=None, spancoords='data', button=None, maxdist=10, marker_props=None, interactive=False, state_modifier_keys=None)<a class="reference internal" href="../_modules/matplotlib/widgets.html#RectangleSelector">[source]</a><a class="headerlink" href="#matplotlib.widgets.RectangleSelector" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">matplotlib.widgets._SelectorWidget</code>

Select a rectangular region of an axes.

For the cursor to remain responsive you must keep a reference to

it.

Example usage:

<div class="highlight-default notranslate"><div class="highlight"><pre>import numpy as np

import matplotlib.pyplot as plt

from matplotlib.widgets import RectangleSelector

def onselect(eclick, erelease):

"eclick and erelease are matplotlib events at press and release."

def toggle_selector(event):

print('Key pressed.')

if event.key in ['Q', 'q'] and toggle_selector.RS.active:

print('RectangleSelector deactivated.')

if event.key in ['A', 'a'] and not toggle_selector.RS.active:

print('RectangleSelector activated.')

y = np.sin(x)

ax.plot(x, y)

toggle_selector.RS = RectangleSelector(ax, onselect, drawtype='line')

plt.show()

</pre></div>

</div>

Create a selector in ax. When a selection is made, clear

the span and call onselect with:

</pre></div>

</div>

arrays of length 2 containing the x- and y-coordinate.

If minspanx is not None then events smaller than minspanx

in x direction are ignored (it's the same for y).

The rectangle is drawn with rectprops; default:

</pre></div>

</div>

The line is drawn with lineprops; default:

</pre></div>

</div>

Use drawtype if you want the mouse to draw a line,

a box or nothing between click and actual position by setting

Drawing a line would result in a line from vertex A to vertex C in

a rectangle ABCD.

spancoords is one of 'data' or 'pixels'. If 'data', minspanx

and minspanx will be interpreted in the same coordinates as

the x and y axis. If 'pixels', they are in pixels.

button is a list of integers indicating which mouse buttons should

be used for rectangle selection. You can also specify a single

integer if only a single button is desired. Default is None,

which does not limit which button can be used.

<dt>Note, typically:</dt>

<dd>1 = left mouse button

2 = center mouse button (scroll wheel)

3 = right mouse button</dd>

</dl>

interactive will draw a set of handles and allow you interact

with the widget after it is drawn.

state_modifier_keys are keyboard modifiers that affect the behavior

of the widget.

The defaults are:

dict(move=' ', clear='escape', square='shift', center='ctrl')

Keyboard modifiers, which:

'move': Move the existing shape.

'clear': Clear the current shape.

'square': Makes the shape square.

'center': Make the initial point the center of the shape.

'square' and 'center' can be combined.

<code class="descname">center</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.center" title="Permalink to this definition">¶</a></dt>

<dd>Center of rectangle

</dd></dl>

<code class="descname">corners</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.corners" title="Permalink to this definition">¶</a></dt>

<dd>Corners of rectangle from lower left, moving clockwise.

</dd></dl>

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

<code class="descname">edge_centers</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.edge_centers" title="Permalink to this definition">¶</a></dt>

<dd>Midpoint of rectangle edges from left, moving clockwise.

</dd></dl>

<code class="descname">extents</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.extents" title="Permalink to this definition">¶</a></dt>

<dd>Return (xmin, xmax, ymin, ymax).

</dd></dl>

<code class="descname">geometry</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.geometry" title="Permalink to this definition">¶</a></dt>

<dd>Returns numpy.ndarray of shape (2,5) containing

x (<code class="docutils literal notranslate">RectangleSelector.geometry[1,:]</code>) and

y (<code class="docutils literal notranslate">RectangleSelector.geometry[0,:]</code>)

coordinates of the four corners of the rectangle starting

and ending in the top left corner.

</dd></dl>

class <code class="descclassname">matplotlib.widgets.</code><code class="descname">Slider</code>(ax, label, valmin, valmax, valinit=0.5, valfmt='%1.2f', closedmin=True, closedmax=True, slidermin=None, slidermax=None, dragging=True, valstep=None, orientation='horizontal', **kwargs)<a class="reference internal" href="../_modules/matplotlib/widgets.html#Slider">[source]</a><a class="headerlink" href="#matplotlib.widgets.Slider" title="Permalink to this definition">¶</a></dt>

A slider representing a floating point range.

Create a slider from valmin to valmax in axes ax. For the slider to

remain responsive you must maintain a reference to it. Call

<a class="reference internal" href="#matplotlib.widgets.Slider.on_changed" title="matplotlib.widgets.Slider.on_changed"><code class="xref py py-meth docutils literal notranslate">on_changed()</code></a> to connect to the slider event.

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

<dt>val : float</dt>

<dd>Slider value.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

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

<dd>The Axes to put the slider in.

</dd>

<dt>label : str</dt>

<dd>Slider label.

</dd>

<dt>valmin : float</dt>

<dd>The minimum value of the slider.

</dd>

<dt>valmax : float</dt>

<dd>The maximum value of the slider.

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

widgets_api.html

Latest commit

History

widgets_api.html

File metadata and controls