matplotlib.github.com/2.2.2/_modules/matplotlib/widgets.html at main · ACPMAD/matplotlib.github.com

History

3064 lines (2493 loc) · 400 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 2.2.2 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.2.2',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.2.2 documentation"

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

</head>

<body>

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

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 2.2.2</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>

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

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

<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>

<li><a href="../index.html" >Module code</a> »</li>

<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3>Related Topics</h3>

<ul>

<li><a href="../../contents.html">Documentation overview</a><ul>

<li><a href="../index.html">Module code</a><ul>

<li><a href="../matplotlib.html">matplotlib</a><ul>

</ul></li>

</ul>

</div>

<h1>Source code for matplotlib.widgets</h1><div class="highlight"><pre>

"""

GUI neutral widgets

===================

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

All of these widgets require you to predefine a :class:`matplotlib.axes.Axes`

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.

"""

from __future__ import (absolute_import, division, print_function,

unicode_literals)

import copy

import six

from six.moves import zip

import numpy as np

from matplotlib import rcParams

from .patches import Circle, Rectangle, Ellipse

from .lines import Line2D

from .transforms import blended_transform_factory

<div class="viewcode-block" id="LockDraw"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.LockDraw">[docs]</a>class LockDraw(object):

"""

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 ``matplotlib.widgets.lock(someobj)`` to prevent

other widgets from drawing while you're interacting with the canvas.

"""

def __init__(self):

self._owner = None

def __call__(self, o):

"""reserve the lock for *o*"""

if not self.available(o):

raise ValueError('already locked')

self._owner = o

<div class="viewcode-block" id="LockDraw.release"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.LockDraw.release">[docs]</a> def release(self, o):

"""release the lock"""

raise ValueError('you do not own this lock')

self._owner = None</div>

<div class="viewcode-block" id="LockDraw.available"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.LockDraw.available">[docs]</a> def available(self, o):

"""drawing is available to *o*"""

return not self.locked() or self.isowner(o)</div>

<div class="viewcode-block" id="LockDraw.isowner"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.LockDraw.isowner">[docs]</a> def isowner(self, o):

"""Return True if *o* owns this lock"""

return self._owner is o</div>

<div class="viewcode-block" id="LockDraw.locked"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.LockDraw.locked">[docs]</a> def locked(self):

"""Return True if the lock is currently held by an owner"""

return self._owner is not None</div></div>

<div class="viewcode-block" id="Widget"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Widget">[docs]</a>class Widget(object):

"""

Abstract base class for GUI neutral widgets

"""

drawon = True

eventson = True

_active = True

<div class="viewcode-block" id="Widget.set_active"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Widget.set_active">[docs]</a> def set_active(self, active):

"""Set whether the widget is active.

"""

self._active = active</div>

<div class="viewcode-block" id="Widget.get_active"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Widget.get_active">[docs]</a> def get_active(self):

"""Get whether the widget is active.

"""

return self._active</div>

# set_active is overridden by SelectorWidgets.

active = property(get_active, lambda self, active: self.set_active(active),

doc="Is the widget active?")

<div class="viewcode-block" id="Widget.ignore"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Widget.ignore">[docs]</a> def ignore(self, event):

"""Return True if event should be ignored.

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

of any event callback.

"""

return not self.active</div></div>

<div class="viewcode-block" id="AxesWidget"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.AxesWidget">[docs]</a>class AxesWidget(Widget):

"""Widget that is connected to a single

:class:`~matplotlib.axes.Axes`.

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:

*ax* : :class:`~matplotlib.axes.Axes`

The parent axes for the widget

*canvas* : :class:`~matplotlib.backend_bases.FigureCanvasBase` subclass

The parent figure canvas for the widget.

*active* : bool

If False, the widget does not respond to events.

"""

def __init__(self, ax):

self.ax = ax

self.canvas = ax.figure.canvas

self.cids = []

<div class="viewcode-block" id="AxesWidget.connect_event"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.AxesWidget.connect_event">[docs]</a> def connect_event(self, event, callback):

"""Connect callback with an event.

This should be used in lieu of `figure.canvas.mpl_connect` since this

function stores callback ids for later clean up.

"""

cid = self.canvas.mpl_connect(event, callback)

self.cids.append(cid)</div>

<div class="viewcode-block" id="AxesWidget.disconnect_events"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.AxesWidget.disconnect_events">[docs]</a> def disconnect_events(self):

"""Disconnect all events created by this widget."""

for c in self.cids:

self.canvas.mpl_disconnect(c)</div></div>

<div class="viewcode-block" id="Button"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Button">[docs]</a>class Button(AxesWidget):

"""

A GUI neutral button.

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

Call :meth:`on_clicked` to connect to the button.

Attributes

----------

ax :

The :class:`matplotlib.axes.Axes` the button renders into.

label :

A :class:`matplotlib.text.Text` instance.

color :

The color of the button when not hovering.

hovercolor :

The color of the button when hovering.

"""

color='0.85', hovercolor='0.95'):

"""

Parameters

----------

ax : matplotlib.axes.Axes

The :class:`matplotlib.axes.Axes` instance the button

will be placed into.

label : str

The button text. Accepts string.

image : array, mpl image, Pillow Image

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).

color : color

The color of the button when not activated

hovercolor : color

The color of the button when the mouse is over it

"""

AxesWidget.__init__(self, ax)

if image is not None:

ax.imshow(image)

verticalalignment='center',

horizontalalignment='center',

transform=ax.transAxes)

self.cnt = 0

self.observers = {}

self.connect_event('button_press_event', self._click)

self.connect_event('button_release_event', self._release)

self.connect_event('motion_notify_event', self._motion)

ax.set_navigate(False)

ax.set_facecolor(color)

ax.set_xticks([])

ax.set_yticks([])

self.color = color

self.hovercolor = hovercolor

self._lastcolor = color

def _click(self, event):

if self.ignore(event):

return

if event.inaxes != self.ax:

return

if not self.eventson:

return

if event.canvas.mouse_grabber != self.ax:

event.canvas.grab_mouse(self.ax)

def _release(self, event):

if self.ignore(event):

return

event.canvas.release_mouse(self.ax)

if not self.eventson:

return

for cid, func in six.iteritems(self.observers):

func(event)

def _motion(self, event):

if self.ignore(event):

return

if event.inaxes == self.ax:

c = self.hovercolor

else:

c = self.color

if c != self._lastcolor:

self.ax.set_facecolor(c)

self._lastcolor = c

if self.drawon:

self.ax.figure.canvas.draw()

<div class="viewcode-block" id="Button.on_clicked"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Button.on_clicked">[docs]</a> def on_clicked(self, func):

"""

When the button is clicked, call this *func* with event.

A connection id is returned. It can be used to disconnect

the button from its callback.

"""

cid = self.cnt

self.observers[cid] = func

self.cnt += 1

return cid</div>

<div class="viewcode-block" id="Button.disconnect"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Button.disconnect">[docs]</a> def disconnect(self, cid):

"""remove the observer with connection id *cid*"""

try:

del self.observers[cid]

except KeyError:

pass</div></div>

<div class="viewcode-block" id="Slider"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Slider">[docs]</a>class Slider(AxesWidget):

"""

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

:meth:`on_changed` to connect to the slider event.

Attributes

----------

val : float

Slider value.

"""

def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt='%1.2f',

closedmin=True, closedmax=True, slidermin=None,

slidermax=None, dragging=True, valstep=None, **kwargs):

"""

Parameters

----------

ax : Axes

The Axes to put the slider in.

label : str

Slider label.

valmin : float

The minimum value of the slider.

valmax : float

The maximum value of the slider.

valinit : float, optional, default: 0.5

The slider initial position.

valfmt : str, optional, default: "%1.2f"

Used to format the slider value, fprint format string.

closedmin : bool, optional, default: True

Indicate whether the slider interval is closed on the bottom.

closedmax : bool, optional, default: True

Indicate whether the slider interval is closed on the top.

slidermin : Slider, optional, default: None

Do not allow the current slider to have a value less than

the value of the Slider `slidermin`.

slidermax : Slider, optional, default: None

Do not allow the current slider to have a value greater than

the value of the Slider `slidermax`.

dragging : bool, optional, default: True

If True the slider can be dragged by the mouse.

valstep : float, optional, default: None

If given, the slider will snap to multiples of `valstep`.

Notes

-----

Additional kwargs are passed on to ``self.poly`` which is the

:class:`~matplotlib.patches.Rectangle` that draws the slider

knob. See the :class:`~matplotlib.patches.Rectangle` documentation for

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

"""

if slidermin is not None and not hasattr(slidermin, 'val'):

raise ValueError("Argument slidermin ({}) has no 'val'"

.format(type(slidermin)))

if slidermax is not None and not hasattr(slidermax, 'val'):

raise ValueError("Argument slidermax ({}) has no 'val'"

.format(type(slidermax)))

self.closedmin = closedmin

self.closedmax = closedmax

self.slidermin = slidermin

self.slidermax = slidermax

self.drag_active = False

self.valmin = valmin

self.valmax = valmax

self.valstep = valstep

valinit = self._value_in_bounds(valinit)

if valinit is None:

valinit = valmin

self.val = valinit

self.valinit = valinit

self.poly = ax.axvspan(valmin, valinit, 0, 1, **kwargs)

self.vline = ax.axvline(valinit, 0, 1, color='r', lw=1)

self.valfmt = valfmt

ax.set_yticks([])

ax.set_xlim((valmin, valmax))

ax.set_xticks([])

ax.set_navigate(False)

if dragging:

self.label = ax.text(-0.02, 0.5, label, transform=ax.transAxes,

verticalalignment='center',

horizontalalignment='right')

self.valtext = ax.text(1.02, 0.5, valfmt % valinit,

transform=ax.transAxes,

verticalalignment='center',

horizontalalignment='left')

self.cnt = 0

self.observers = {}

self.set_val(valinit)

def _value_in_bounds(self, val):

""" Makes sure self.val is with given bounds."""

if self.valstep:

val = np.round((val - self.valmin)/self.valstep)*self.valstep

val += self.valmin

if val <= self.valmin:

if not self.closedmin:

return

val = self.valmin

elif val >= self.valmax:

if not self.closedmax:

return

val = self.valmax

if self.slidermin is not None and val <= self.slidermin.val:

if not self.closedmin:

return

val = self.slidermin.val

if self.slidermax is not None and val >= self.slidermax.val:

if not self.closedmax:

return

val = self.slidermax.val

return val

def _update(self, event):

"""update the slider position"""

if self.ignore(event):

return

if event.button != 1:

return

if event.name == 'button_press_event' and event.inaxes == self.ax:

self.drag_active = True

if not self.drag_active:

return

elif ((event.name == 'button_release_event') or

(event.name == 'button_press_event' and

event.inaxes != self.ax)):

self.drag_active = False

return

val = self._value_in_bounds(event.xdata)

if (val is not None) and (val != self.val):

self.set_val(val)

<div class="viewcode-block" id="Slider.set_val"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Slider.set_val">[docs]</a> def set_val(self, val):

"""

Set slider value to *val*

Parameters

----------

val : float

"""

xy = self.poly.xy

xy[2] = val, 1

xy[3] = val, 0

self.poly.xy = xy

self.valtext.set_text(self.valfmt % val)

if self.drawon:

self.val = val

if not self.eventson:

return

func(val)</div>

<div class="viewcode-block" id="Slider.on_changed"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Slider.on_changed">[docs]</a> def on_changed(self, func):

"""

When the slider value is changed call *func* with the new

slider value

Parameters

----------

func : callable

Function to call when slider is changed.

The function must accept a single float as its arguments.

Returns

-------

cid : int

Connection id (which can be used to disconnect *func*)

"""

cid = self.cnt

self.cnt += 1

return cid</div>

<div class="viewcode-block" id="Slider.disconnect"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Slider.disconnect">[docs]</a> def disconnect(self, cid):

"""

Remove the observer with connection id *cid*

Parameters

----------

cid : int

Connection id of the observer to be removed

"""

try:

del self.observers[cid]

except KeyError:

pass</div>

<div class="viewcode-block" id="Slider.reset"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.Slider.reset">[docs]</a> def reset(self):

"""Reset the slider to the initial value"""

if (self.val != self.valinit):

self.set_val(self.valinit)</div></div>

<div class="viewcode-block" id="CheckButtons"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.CheckButtons">[docs]</a>class CheckButtons(AxesWidget):

"""

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

*ax*

The :class:`matplotlib.axes.Axes` instance the buttons are

located in

*labels*

List of :class:`matplotlib.text.Text` instances

*lines*

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

These lines exist for each box, but have ``set_visible(False)``

when its box is not checked.

*rectangles*

List of :class:`matplotlib.patches.Rectangle` instances

Connect to the CheckButtons with the :meth:`on_clicked` method

"""

"""

Add check buttons to :class:`matplotlib.axes.Axes` instance *ax*

*labels*

A len(buttons) list of labels as strings

*actives*

A len(buttons) list of booleans indicating whether

the button is active

"""

ax.set_xticks([])

ax.set_yticks([])

ax.set_navigate(False)

if len(labels) > 1:

dy = 1. / (len(labels) + 1)

ys = np.linspace(1 - dy, dy, len(labels))

else:

dy = 0.25

ys = [0.5]

cnt = 0

axcolor = ax.get_facecolor()

self.labels = []

self.lines = []

self.rectangles = []

lineparams = {'color': 'k', 'linewidth': 1.25,

'transform': ax.transAxes, 'solid_capstyle': 'butt'}

for y, label in zip(ys, labels):

t = ax.text(0.25, y, label, transform=ax.transAxes,

horizontalalignment='left',

verticalalignment='center')

w, h = dy / 2., dy / 2.

x, y = 0.05, y - h / 2.

p = Rectangle(xy=(x, y), width=w, height=h, edgecolor='black',

facecolor=axcolor, transform=ax.transAxes)

l1 = Line2D([x, x + w], [y + h, y], **lineparams)

l2 = Line2D([x, x + w], [y, y + h], **lineparams)

l1.set_visible(actives[cnt])

l2.set_visible(actives[cnt])

self.labels.append(t)

self.rectangles.append(p)

self.lines.append((l1, l2))

ax.add_patch(p)

ax.add_line(l1)

ax.add_line(l2)

cnt += 1

self.cnt = 0

self.observers = {}

def _clicked(self, event):

if self.ignore(event):

return

if event.button != 1:

return

for i, (p, t) in enumerate(zip(self.rectangles, self.labels)):

if (t.get_window_extent().contains(event.x, event.y) or

p.get_window_extent().contains(event.x, event.y)):

self.set_active(i)

break

else:

return

<div class="viewcode-block" id="CheckButtons.set_active"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.CheckButtons.set_active">[docs]</a> def set_active(self, index):

"""

Directly (de)activate a check button by index.

*index* is an index into the original label list

that this object was constructed with.

Raises ValueError if *index* is invalid.

Callbacks will be triggered if :attr:`eventson` is True.

"""

if 0 > index >= len(self.labels):

raise ValueError("Invalid CheckButton index: %d" % index)

l1, l2 = self.lines[index]

l1.set_visible(not l1.get_visible())

l2.set_visible(not l2.get_visible())

if self.drawon:

if not self.eventson:

return

func(self.labels[index].get_text())</div>

<div class="viewcode-block" id="CheckButtons.get_status"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.CheckButtons.get_status">[docs]</a> def get_status(self):

"""

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

"""

return [l1.get_visible() for (l1, l2) in self.lines]</div>

<div class="viewcode-block" id="CheckButtons.on_clicked"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.CheckButtons.on_clicked">[docs]</a> def on_clicked(self, func):

"""

When the button is clicked, call *func* with button label

A connection id is returned which can be used to disconnect

"""

cid = self.cnt

self.cnt += 1

return cid</div>

<div class="viewcode-block" id="CheckButtons.disconnect"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.CheckButtons.disconnect">[docs]</a> def disconnect(self, cid):

"""remove the observer with connection id *cid*"""

try:

del self.observers[cid]

except KeyError:

pass</div></div>

<div class="viewcode-block" id="TextBox"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.TextBox">[docs]</a>class TextBox(AxesWidget):

"""

A GUI neutral text input box.

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

The following attributes are accessible:

*ax*

The :class:`matplotlib.axes.Axes` the button renders into.

*label*

A :class:`matplotlib.text.Text` instance.

*color*

The color of the text box when not hovering.

*hovercolor*

The color of the text box when hovering.

Call :meth:`on_text_change` to be updated whenever the text changes.

Call :meth:`on_submit` to be updated whenever the user hits enter or

leaves the text entry field.

"""

color='.95', hovercolor='1', label_pad=.01):

"""

Parameters

----------

ax : matplotlib.axes.Axes

The :class:`matplotlib.axes.Axes` instance the button

will be placed into.

label : str

Label for this text box. Accepts string.

initial : str

Initial value in the text box

color : color

The color of the box

hovercolor : color

The color of the box when the mouse is over it

label_pad : float

the distance between the label and the right side of the textbox

"""

self.DIST_FROM_LEFT = .05

self.params_to_disable = [key for key in rcParams if u'keymap' in key]

self.text = initial

self.label = ax.text(-label_pad, 0.5, label,

verticalalignment='center',

horizontalalignment='right',

transform=ax.transAxes)

self.text_disp = self._make_text_disp(self.text)

self.cnt = 0

self.change_observers = {}

self.submit_observers = {}

# If these lines are removed, the cursor won't appear the first

# time the box is clicked:

self.ax.set_xlim(0, 1)

self.ax.set_ylim(0, 1)

self.cursor_index = 0

# Because this is initialized, _render_cursor

# can assume that cursor exists.

self.cursor.set_visible(False)

self.connect_event('key_press_event', self._keypress)

self.connect_event('resize_event', self._resize)

ax.set_navigate(False)

ax.set_facecolor(color)

ax.set_xticks([])

ax.set_yticks([])

self.color = color

self.hovercolor = hovercolor

self._lastcolor = color

self.capturekeystrokes = False

def _make_text_disp(self, string):

return self.ax.text(self.DIST_FROM_LEFT, 0.5, string,

verticalalignment='center',

horizontalalignment='left',

transform=self.ax.transAxes)

def _rendercursor(self):

# this is a hack to figure out where the cursor should go.

# we draw the text up to where the cursor should go, measure

# and save its dimensions, draw the real text, then put the cursor

# at the saved dimensions

widthtext = self.text[:self.cursor_index]

no_text = False

if(widthtext == "" or widthtext == " " or widthtext == " "):

no_text = widthtext == ""

widthtext = ","

wt_disp = self._make_text_disp(widthtext)

bb = wt_disp.get_window_extent()

inv = self.ax.transData.inverted()

bb = inv.transform(bb)

wt_disp.set_visible(False)

if no_text:

bb[1, 0] = bb[0, 0]

# hack done

self.cursor = self.ax.vlines(bb[1, 0], bb[0, 1], bb[1, 1])

def _notify_submit_observers(self):

func(self.text)

def _release(self, event):

if self.ignore(event):

return

def _keypress(self, event):

if self.ignore(event):

return

if self.capturekeystrokes:

key = event.key

if(len(key) == 1):

self.text = (self.text[:self.cursor_index] + key +

self.text[self.cursor_index:])

self.cursor_index += 1

elif key == "right":

if self.cursor_index != len(self.text):

self.cursor_index += 1

elif key == "left":

if self.cursor_index != 0:

self.cursor_index -= 1

elif key == "home":

self.cursor_index = 0

elif key == "end":

self.cursor_index = len(self.text)

elif(key == "backspace"):

if self.cursor_index != 0:

self.text = (self.text[:self.cursor_index - 1] +

self.cursor_index -= 1

elif(key == "delete"):

self.text_disp.remove()

self._rendercursor()

self._notify_change_observers()

if key == "enter":

self._notify_submit_observers()

<div class="viewcode-block" id="TextBox.set_val"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.TextBox.set_val">[docs]</a> def set_val(self, val):

newval = str(val)

if self.text == newval:

return

self.text = newval

self.text_disp.remove()

self._rendercursor()

self._notify_change_observers()

self._notify_submit_observers()</div>

def _notify_change_observers(self):

func(self.text)

<div class="viewcode-block" id="TextBox.begin_typing"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.TextBox.begin_typing">[docs]</a> def begin_typing(self, x):

self.capturekeystrokes = True

# disable command keys so that the user can type without

# command keys causing figure to be saved, etc

self.reset_params = {}

for key in self.params_to_disable:

self.reset_params[key] = rcParams[key]

rcParams[key] = []</div>

<div class="viewcode-block" id="TextBox.stop_typing"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.TextBox.stop_typing">[docs]</a> def stop_typing(self):

notifysubmit = False

# because _notify_submit_users might throw an error in the

# user's code, we only want to call it once we've already done

# our cleanup.

if self.capturekeystrokes:

# since the user is no longer typing,

# reactivate the standard command keys

for key in self.params_to_disable:

rcParams[key] = self.reset_params[key]

notifysubmit = True

self.capturekeystrokes = False

if notifysubmit:

self._notify_submit_observers()</div>

<div class="viewcode-block" id="TextBox.position_cursor"><a class="viewcode-back" href="../../api/widgets_api.html#matplotlib.widgets.TextBox.position_cursor">[docs]</a> def position_cursor(self, x):

# now, we have to figure out where the cursor goes.

# approximate it based on assuming all characters the same length

if len(self.text) == 0:

self.cursor_index = 0

else:

bb = self.text_disp.get_window_extent()

trans = self.ax.transData

bb = trans.transform(inv.transform(bb))

text_start = bb[0, 0]

text_end = bb[1, 0]

ratio = (x - text_start) / (text_end - text_start)

if ratio < 0:

ratio = 0

if ratio > 1:

ratio = 1

self.cursor_index = int(len(self.text) * ratio)

self._rendercursor()</div>

def _click(self, event):

if self.ignore(event):

return

View remainder of file in raw view

FilesExpand file tree

widgets.html

Latest commit

History

widgets.html

File metadata and controls