matplotlib.github.com/1.2.1/api/widgets_api.html at refs/heads/main · matplotlib/matplotlib.github.com

History

910 lines (817 loc) · 64 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

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

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

<head>

<title>widgets — Matplotlib 1.2.1 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.2.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.2.1 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v1.2.1). 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>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");

document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

}

</script>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

piwik_action_name = '';

piwik_idsite = 1;

piwik_url = pkBaseURL + "piwik.php";

piwik_log(piwik_action_name, piwik_idsite, piwik_url);

document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));

}

</script>

</map>

</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="../glossary/index.html" title="Glossary"

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

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

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

<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>

<li><a href="../search.html">search</a>| </li>

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

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

<li><a href="../citing.html">citation</a>| </li>

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

</ul>

</div>

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

<ul>

<li><a class="reference internal" href="#">widgets</a><ul>

<li><a class="reference internal" href="#module-matplotlib.widgets"><tt class="docutils literal">matplotlib.widgets</tt></a><ul>

<li><a class="reference internal" href="#gui-neutral-widgets">GUI Neutral widgets</a></li>

</ul>

</li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<a href="units_api.html"

title="previous chapter">units</a>

<h4>Next topic</h4>

<a href="../glossary/index.html"

title="next chapter">Glossary</a>

<li><a href="../_sources/api/widgets_api.txt"

rel="nofollow">Show Source</a></li>

</ul>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</div>

</div>

<h1>widgets<a class="headerlink" href="#widgets" title="Permalink to this headline">¶</a></h1>

<h2><a class="reference internal" href="#module-matplotlib.widgets" title="matplotlib.widgets"><tt class="xref py py-mod docutils literal">matplotlib.widgets</tt></a><a class="headerlink" href="#module-matplotlib.widgets" title="Permalink to this headline">¶</a></h2>

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

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

All of these widgets require you to predefine an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal">matplotlib.axes.Axes</tt></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 <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">AxesWidget</tt><big>(</big>ax<big>)</big><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"><tt class="xref py py-class docutils literal">matplotlib.widgets.Widget</tt></a>

Widget that is connected to a single <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal">Axes</tt></a>.

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"><tt class="xref py py-class docutils literal">FigureCanvasBase</tt></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>

<tt class="descname">connect_event</tt><big>(</big>event, callback<big>)</big><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 <tt class="xref py py-obj docutils literal">figure.canvas.mpl_connect</tt> since this

function stores call back ids for later clean up.

</dd></dl>

<tt class="descname">disconnect_events</tt><big>(</big><big>)</big><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>

<tt class="descname">ignore</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.AxesWidget.ignore" title="Permalink to this definition">¶</a></dt>

<dd>Return True if event should be ignored.

This method (or a version of it) should be called at the beginning

of any event callback.

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">Button</tt><big>(</big>ax, label, image=None, color='0.85', hovercolor='0.95'<big>)</big><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"><tt class="xref py py-class docutils literal">matplotlib.widgets.AxesWidget</tt></a>

A GUI neutral button

The following attributes are accessible

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

<dt>label</dt>

<dd>A <a class="reference internal" href="artist_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><tt class="xref py py-class docutils literal">matplotlib.text.Text</tt></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>

</div></blockquote>

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

will be placed into.</dd>

<dt>label</dt>

<dd>The button text. Accepts string.</dd>

<dt>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 PIL image).</dd>

<dt>color</dt>

<dd>The color of the button when not activated</dd>

<dt>hovercolor</dt>

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

</dl>

<tt class="descname">disconnect</tt><big>(</big>cid<big>)</big><a class="headerlink" href="#matplotlib.widgets.Button.disconnect" title="Permalink to this definition">¶</a></dt>

<dd>remove the observer with connection id cid

</dd></dl>

<tt class="descname">on_clicked</tt><big>(</big>func<big>)</big><a class="headerlink" href="#matplotlib.widgets.Button.on_clicked" title="Permalink to this definition">¶</a></dt>

<dd>When the button is clicked, call this func with event

A connection id is returned which can be used to disconnect

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">CheckButtons</tt><big>(</big>ax, labels, actives<big>)</big><a class="headerlink" href="#matplotlib.widgets.CheckButtons" title="Permalink to this definition">¶</a></dt>

A GUI neutral radio button

The following attributes are exposed

located in</dd>

<dt>labels</dt>

<dd>List of <a class="reference internal" href="artist_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><tt class="xref py py-class docutils literal">matplotlib.text.Text</tt></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 <tt class="docutils literal">set_visible(False)</tt>

when its box is not checked.</dd>

<dt>rectangles</dt>

<dd>List of <a class="reference internal" href="artist_api.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><tt class="xref py py-class docutils literal">matplotlib.patches.Rectangle</tt></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"><tt class="xref py py-meth docutils literal">on_clicked()</tt></a> method

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

<dt>labels</dt>

<dd>A len(buttons) list of labels as strings</dd>

<dt>actives</dt>

<dt>A len(buttons) list of booleans indicating whether</dt>

<dd>the button is active</dd>

</dl>

</dd>

</dl>

<tt class="descname">disconnect</tt><big>(</big>cid<big>)</big><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>

<tt class="descname">on_clicked</tt><big>(</big>func<big>)</big><a class="headerlink" href="#matplotlib.widgets.CheckButtons.on_clicked" title="Permalink to this definition">¶</a></dt>

<dd>When the button is clicked, call func with button label

A connection id is returned which can be used to disconnect

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">Cursor</tt><big>(</big>ax, useblit=False, **lineprops<big>)</big><a class="headerlink" href="#matplotlib.widgets.Cursor" title="Permalink to this definition">¶</a></dt>

A horizontal and vertical line span the axes that and move with

the pointer. You can turn off the hline or vline spectively with

the attributes

<dt>horizOn</dt>

<dd>Controls the visibility of the horizontal line</dd>

<dt>vertOn</dt>

<dd>Controls the visibility of the horizontal line</dd>

</dl>

</div></blockquote>

and the visibility of the cursor itself with the visible attribute

Add a cursor to ax. If <tt class="docutils literal">useblit=True</tt>, use the backend-

dependent blitting features for faster updates (GTKAgg

only for now). lineprops is a dictionary of line properties.

(<a class="reference external" href="../mpl_examples/widgets/cursor.py">Source code</a>, <a class="reference external" href="../mpl_examples/widgets/cursor.png">png</a>, <a class="reference external" href="../mpl_examples/widgets/cursor.hires.png">hires.png</a>, <a class="reference external" href="../mpl_examples/widgets/cursor.pdf">pdf</a>)

</div>

<tt class="descname">clear</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.Cursor.clear" title="Permalink to this definition">¶</a></dt>

<dd>clear the cursor

</dd></dl>

<tt class="descname">onmove</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.Cursor.onmove" title="Permalink to this definition">¶</a></dt>

<dd>on mouse motion draw the cursor if visible

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">HorizontalSpanSelector</tt><big>(</big>ax, onselect, **kwargs<big>)</big><a class="headerlink" href="#matplotlib.widgets.HorizontalSpanSelector" title="Permalink to this definition">¶</a></dt>

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

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">Lasso</tt><big>(</big>ax, xy, callback=None, useblit=True<big>)</big><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"><tt class="xref py py-func docutils literal">contains_point()</tt></a> to select data points

from an image.

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

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

Parameters:

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

<dt>xy : array</dt>

<dd>Coordinates of the start of the lasso.</dd>

<dt>callback : function</dt>

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

passed the vertices of the selected path.</dd>

</dl>

<tt class="descname">onmove</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.Lasso.onmove" title="Permalink to this definition">¶</a></dt>

<tt class="descname">onrelease</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.Lasso.onrelease" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">LassoSelector</tt><big>(</big>ax, onselect=None, useblit=True, lineprops=None<big>)</big><a class="headerlink" href="#matplotlib.widgets.LassoSelector" title="Permalink to this definition">¶</a></dt>

Selection curve of an arbitrary shape.

The selected path can be used in conjunction with

data points from an image.

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

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

continue to interact with the axes until disconnected.

Parameters:

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

<dt>onselect : function</dt>

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

passed the vertices of the selected path.</dd>

</dl>

Example usage:

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

ax.plot(x,y)

def onselect(verts):

print verts

lasso = LassoSelector(ax, onselect)

</pre></div>

</div>

<tt class="descname">ignore</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.LassoSelector.ignore" title="Permalink to this definition">¶</a></dt>

<tt class="descname">onmove</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.LassoSelector.onmove" title="Permalink to this definition">¶</a></dt>

<tt class="descname">onpress</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.LassoSelector.onpress" title="Permalink to this definition">¶</a></dt>

<tt class="descname">onrelease</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.LassoSelector.onrelease" title="Permalink to this definition">¶</a></dt>

<tt class="descname">update_background</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.LassoSelector.update_background" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">LockDraw</tt><a class="headerlink" href="#matplotlib.widgets.LockDraw" title="Permalink to this definition">¶</a></dt>

<dd>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. The module level “lock”

allows someone to grab the lock and prevent other widgets from

drawing. Use <tt class="docutils literal">matplotlib.widgets.lock(someobj)</tt> to pr

<tt class="descname">available</tt><big>(</big>o<big>)</big><a class="headerlink" href="#matplotlib.widgets.LockDraw.available" title="Permalink to this definition">¶</a></dt>

<dd>drawing is available to o

</dd></dl>

<tt class="descname">isowner</tt><big>(</big>o<big>)</big><a class="headerlink" href="#matplotlib.widgets.LockDraw.isowner" title="Permalink to this definition">¶</a></dt>

<dd>Return True if o owns this lock

</dd></dl>

<tt class="descname">locked</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.widgets.LockDraw.locked" title="Permalink to this definition">¶</a></dt>

<dd>Return True if the lock is currently held by an owner

</dd></dl>

<tt class="descname">release</tt><big>(</big>o<big>)</big><a class="headerlink" href="#matplotlib.widgets.LockDraw.release" title="Permalink to this definition">¶</a></dt>

<dd>release the lock

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">MultiCursor</tt><big>(</big>canvas, axes, useblit=True, **lineprops<big>)</big><a class="headerlink" href="#matplotlib.widgets.MultiCursor" title="Permalink to this definition">¶</a></dt>

Provide a vertical line cursor shared between multiple axes

Example usage:

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

from pylab import figure, show, np

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

s1 = np.sin(2*np.pi*t)

s2 = np.sin(4*np.pi*t)

fig = figure()

ax1 = fig.add_subplot(211)

ax1.plot(t, s1)

ax2 = fig.add_subplot(212, sharex=ax1)

ax2.plot(t, s2)

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

show()

</pre></div>

</div>

<tt class="descname">clear</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.MultiCursor.clear" title="Permalink to this definition">¶</a></dt>

<dd>clear the cursor

</dd></dl>

<tt class="descname">onmove</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.MultiCursor.onmove" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">RadioButtons</tt><big>(</big>ax, labels, active=0, activecolor='blue'<big>)</big><a class="headerlink" href="#matplotlib.widgets.RadioButtons" title="Permalink to this definition">¶</a></dt>

A GUI neutral radio button

The following attributes are exposed

<dt>activecolor</dt>

<dd>The color of the button when clicked</dd>

<dt>labels</dt>

<dd>A list of <a class="reference internal" href="artist_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><tt class="xref py py-class docutils literal">matplotlib.text.Text</tt></a> instances</dd>

<dt>circles</dt>

<dd>A list of <a class="reference internal" href="artist_api.html#matplotlib.patches.Circle" title="matplotlib.patches.Circle"><tt class="xref py py-class docutils literal">matplotlib.patches.Circle</tt></a> instances</dd>

</dl>

</div></blockquote>

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

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

<dt>labels</dt>

<dd>A len(buttons) list of labels as strings</dd>

<dt>active</dt>

<dd>The index into labels for the button that is active</dd>

<dt>activecolor</dt>

<dd>The color of the button when clicked</dd>

</dl>

<tt class="descname">disconnect</tt><big>(</big>cid<big>)</big><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>

<tt class="descname">on_clicked</tt><big>(</big>func<big>)</big><a class="headerlink" href="#matplotlib.widgets.RadioButtons.on_clicked" title="Permalink to this definition">¶</a></dt>

<dd>When the button is clicked, call func with button label

A connection id is returned which can be used to disconnect

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">RectangleSelector</tt><big>(</big>ax, onselect, drawtype='box', minspanx=None, minspany=None, useblit=False, lineprops=None, rectprops=None, spancoords='data', button=None<big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector" title="Permalink to this definition">¶</a></dt>

Select a min/max range of the x axes for a matplotlib Axes

Example usage:

<div class="highlight-python"><div class="highlight"><pre>from matplotlib.widgets import RectangleSelector

from pylab import *

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.RS.active:

print ' RectangleSelector deactivated.'

toggle_selector.RS.set_active(False)

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

print ' RectangleSelector activated.'

x = arange(100)/(99.0)

y = sin(x)

fig = figure

ax = subplot(111)

ax.plot(x,y)

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

connect('key_press_event', toggle_selector)

show()

</pre></div>

</div>

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

the span and call onselect with:

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

</pre></div>

</div>

and clear the drawn box/line. The <tt class="docutils literal">pos_1</tt> and <tt class="docutils literal">pos_2</tt> 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-python"><div class="highlight"><pre>rectprops = dict(facecolor='red', edgecolor = 'black',

alpha=0.5, fill=False)

</pre></div>

</div>

The line is drawn with lineprops; default:

<div class="highlight-python"><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

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

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>

<tt class="descname">get_active</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.get_active" title="Permalink to this definition">¶</a></dt>

<dd>Get status of active mode (boolean variable)

</dd></dl>

<tt class="descname">ignore</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.ignore" title="Permalink to this definition">¶</a></dt>

<dd>return True if event should be ignored

</dd></dl>

<tt class="descname">onmove</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.onmove" title="Permalink to this definition">¶</a></dt>

<dd>on motion notify event if box/line is wanted

</dd></dl>

<tt class="descname">press</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.press" title="Permalink to this definition">¶</a></dt>

<dd>on button press event

</dd></dl>

<tt class="descname">release</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.release" title="Permalink to this definition">¶</a></dt>

<dd>on button release event

</dd></dl>

<tt class="descname">set_active</tt><big>(</big>active<big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.set_active" title="Permalink to this definition">¶</a></dt>

<dd>Use this to activate / deactivate the RectangleSelector

from your program with an boolean parameter active.

</dd></dl>

<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.update" title="Permalink to this definition">¶</a></dt>

<dd>draw using newfangled blit or oldfangled draw depending on useblit

</dd></dl>

<tt class="descname">update_background</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.update_background" title="Permalink to this definition">¶</a></dt>

<dd>force an update of the background

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">Slider</tt><big>(</big>ax, label, valmin, valmax, valinit=0.5, valfmt='%1.2f', closedmin=True, closedmax=True, slidermin=None, slidermax=None, dragging=True, **kwargs<big>)</big><a class="headerlink" href="#matplotlib.widgets.Slider" title="Permalink to this definition">¶</a></dt>

A slider representing a floating point range

<dt>The following attributes are defined</dt>

<dd>ax : the slider <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal">matplotlib.axes.Axes</tt></a> instance

val : the current slider value

<dt>vline : a <a class="reference internal" href="artist_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><tt class="xref py py-class docutils literal">matplotlib.lines.Line2D</tt></a> instance</dt>

<dd>representing the initial value of the slider</dd>

<dt>poly : A <a class="reference internal" href="artist_api.html#matplotlib.patches.Polygon" title="matplotlib.patches.Polygon"><tt class="xref py py-class docutils literal">matplotlib.patches.Polygon</tt></a> instance</dt>

<dd>which is the slider knob</dd>

</dl>

valfmt : the format string for formatting the slider text

<dt>label : a <a class="reference internal" href="artist_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><tt class="xref py py-class docutils literal">matplotlib.text.Text</tt></a> instance</dt>

<dd>for the slider label</dd>

</dl>

closedmin : whether the slider is closed on the minimum

closedmax : whether the slider is closed on the maximum

<dt>slidermin : another slider - if not None, this slider must be</dt>

<dd>greater than slidermin</dd>

<dt>slidermax : another slider - if not None, this slider must be</dt>

<dd>less than slidermax</dd>

</dl>

dragging : allow for mouse dragging on slider

</dd>

</dl>

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

Create a slider from valmin to valmax in axes ax

<dt>valinit</dt>

<dd>The slider initial position</dd>

<dt>label</dt>

<dd>The slider label</dd>

<dt>valfmt</dt>

<dd>Used to format the slider value</dd>

<dt>closedmin and closedmax</dt>

<dd>Indicate whether the slider interval is closed</dd>

<dt>slidermin and slidermax</dt>

<dd>Used to constrain the value of this slider to the values

of other sliders.</dd>

</dl>

additional kwargs are passed on to <tt class="docutils literal">self.poly</tt> which is the

<a class="reference internal" href="artist_api.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><tt class="xref py py-class docutils literal">matplotlib.patches.Rectangle</tt></a> which draws the slider

knob. See the <a class="reference internal" href="artist_api.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><tt class="xref py py-class docutils literal">matplotlib.patches.Rectangle</tt></a> documentation

valid property names (e.g., facecolor, edgecolor, alpha, ...)

<tt class="descname">disconnect</tt><big>(</big>cid<big>)</big><a class="headerlink" href="#matplotlib.widgets.Slider.disconnect" title="Permalink to this definition">¶</a></dt>

<dd>remove the observer with connection id cid

</dd></dl>

<tt class="descname">on_changed</tt><big>(</big>func<big>)</big><a class="headerlink" href="#matplotlib.widgets.Slider.on_changed" title="Permalink to this definition">¶</a></dt>

<dd>When the slider value is changed, call func with the new

slider position

A connection id is returned which can be used to disconnect

</dd></dl>

<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.widgets.Slider.reset" title="Permalink to this definition">¶</a></dt>

<dd>reset the slider to the initial value if needed

</dd></dl>

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">SpanSelector</tt><big>(</big>ax, onselect, direction, minspan=None, useblit=False, rectprops=None, onmove_callback=None<big>)</big><a class="headerlink" href="#matplotlib.widgets.SpanSelector" title="Permalink to this definition">¶</a></dt>

Select a min/max range of the x or y axes for a matplotlib Axes

Example usage:

ax.plot(x,y)

def onselect(vmin, vmax):

print vmin, vmax

span = SpanSelector(ax, onselect, 'horizontal')

</pre></div>

</div>

<dt>onmove_callback is an optional callback that is called on mouse</dt>

<dd>move within the span range</dd>

</dl>

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

the span and call onselect with:

<div class="highlight-python"><div class="highlight"><pre>onselect(vmin, vmax)

</pre></div>

</div>

and clear the span.

direction must be ‘horizontal’ or ‘vertical’

If minspan is not None, ignore events smaller than minspan

<dt>The span rectangle is drawn with rectprops; default::</dt>

<dd>rectprops = dict(facecolor=’red’, alpha=0.5)</dd>

</dl>

Set the visible attribute to False if you want to turn off

the functionality of the span selector

<tt class="descname">ignore</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.SpanSelector.ignore" title="Permalink to this definition">¶</a></dt>

<dd>return True if event should be ignored

</dd></dl>

<tt class="descname">onmove</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.SpanSelector.onmove" title="Permalink to this definition">¶</a></dt>

<dd>on motion notify event

</dd></dl>

<tt class="descname">press</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.SpanSelector.press" title="Permalink to this definition">¶</a></dt>

<dd>on button press event

</dd></dl>

<tt class="descname">release</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.SpanSelector.release" title="Permalink to this definition">¶</a></dt>

<dd>on button release event

</dd></dl>

<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.widgets.SpanSelector.update" title="Permalink to this definition">¶</a></dt>

<dd>Draw using newfangled blit or oldfangled draw depending

on useblit

</dd></dl>

<tt class="descname">update_background</tt><big>(</big>event<big>)</big><a class="headerlink" href="#matplotlib.widgets.SpanSelector.update_background" title="Permalink to this definition">¶</a></dt>

<dd>force an update of the background

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">SubplotTool</tt><big>(</big>targetfig, toolfig<big>)</big><a class="headerlink" href="#matplotlib.widgets.SubplotTool" title="Permalink to this definition">¶</a></dt>

A tool to adjust to subplot params of a <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal">matplotlib.figure.Figure</tt></a>

<dt>targetfig</dt>

<dd>The figure instance to adjust</dd>

<dt>toolfig</dt>

<dd>The figure instance to embed the subplot tool into. If

None, a default figure will be created. If you are using

this from the GUI</dd>

</dl>

<tt class="descname">funcbottom</tt><big>(</big>val<big>)</big><a class="headerlink" href="#matplotlib.widgets.SubplotTool.funcbottom" title="Permalink to this definition">¶</a></dt>

<tt class="descname">funchspace</tt><big>(</big>val<big>)</big><a class="headerlink" href="#matplotlib.widgets.SubplotTool.funchspace" title="Permalink to this definition">¶</a></dt>

<tt class="descname">funcleft</tt><big>(</big>val<big>)</big><a class="headerlink" href="#matplotlib.widgets.SubplotTool.funcleft" title="Permalink to this definition">¶</a></dt>

<tt class="descname">funcright</tt><big>(</big>val<big>)</big><a class="headerlink" href="#matplotlib.widgets.SubplotTool.funcright" title="Permalink to this definition">¶</a></dt>

<tt class="descname">functop</tt><big>(</big>val<big>)</big><a class="headerlink" href="#matplotlib.widgets.SubplotTool.functop" title="Permalink to this definition">¶</a></dt>

<tt class="descname">funcwspace</tt><big>(</big>val<big>)</big><a class="headerlink" href="#matplotlib.widgets.SubplotTool.funcwspace" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <tt class="descclassname">matplotlib.widgets.</tt><tt class="descname">Widget</tt><a class="headerlink" href="#matplotlib.widgets.Widget" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

Abstract base class for GUI neutral widgets

<tt class="descname">drawon</tt> = True<a class="headerlink" href="#matplotlib.widgets.Widget.drawon" title="Permalink to this definition">¶</a></dt>

<tt class="descname">eventson</tt> = True<a class="headerlink" href="#matplotlib.widgets.Widget.eventson" title="Permalink to this definition">¶</a></dt>

</dd></dl>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

>index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="../glossary/index.html" title="Glossary"

>next</a> |</li>

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

>previous</a> |</li>

<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>

<li><a href="../search.html">search</a>| </li>

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

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

<li><a href="../citing.html">citation</a>| </li>

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

</ul>

</div>

Last updated on May 29, 2013.

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.

</div>

</body>

</html>

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