matplotlib_devdocs/api/artist_api.html at first_commit · puwei0000/matplotlib_devdocs

History

786 lines (730 loc) · 62.4 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

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

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

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

<head>

<title>artist Module — Matplotlib 2.0.2.post4416.dev0+g1df513f documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.0.2.post4416.dev0+g1df513f',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.2.post4416.dev0+g1df513f documentation"

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

</head>

<body>

</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="_as_gen/matplotlib.artist.Artist.add_callback.html" title="matplotlib.artist.Artist.add_callback"

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

<a href="_as_gen/matplotlib.animation.MencoderWriter.html" title="matplotlib.animation.MencoderWriter"

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="pyplot_summary.html">pyplot</a>| </li>

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

</ul>

</div>

</a>

<br/>

</a>

<br/>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<br/>

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

<ul>

<li><a class="reference internal" href="#"><code class="docutils literal"><span class="pre">artist</span></code> Module</a><ul>

<li><a class="reference internal" href="#artist-class"><code class="docutils literal"><span class="pre">Artist</span></code> class</a><ul>

<li><a class="reference internal" href="#interactive">Interactive</a></li>

<li><a class="reference internal" href="#margins-and-autoscaling">Margins and Autoscaling</a></li>

<li><a class="reference internal" href="#clipping">Clipping</a></li>

<li><a class="reference internal" href="#bulk-properties">Bulk Properties</a></li>

<li><a class="reference internal" href="#drawing">Drawing</a></li>

<li><a class="reference internal" href="#figure-and-axes">Figure and Axes</a></li>

<li><a class="reference internal" href="#children">Children</a></li>

<li><a class="reference internal" href="#transform">Transform</a></li>

<li><a class="reference internal" href="#units">Units</a></li>

<li><a class="reference internal" href="#metadata">Metadata</a></li>

<li><a class="reference internal" href="#stale">Stale</a></li>

</ul>

</li>

<li><a class="reference internal" href="#functions">Functions</a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

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

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

<li>Previous: <a href="_as_gen/matplotlib.animation.MencoderWriter.html" title="previous chapter">matplotlib.animation.MencoderWriter</a></li>

<li>Next: <a href="_as_gen/matplotlib.artist.Artist.add_callback.html" title="next chapter">matplotlib.artist.Artist.add_callback</a></li>

</ul></li>

</ul>

</div>

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<span id="artist-api"></span><h1><code class="docutils literal"><span class="pre">artist</span></code> Module<a class="headerlink" href="#artist-module" title="Permalink to this headline">¶</a></h1>

</map>

<h2><code class="docutils literal"><span class="pre">Artist</span></code> class<a class="headerlink" href="#artist-class" title="Permalink to this headline">¶</a></h2>

<em class="property">class </em><code class="descclassname">matplotlib.artist.</code><code class="descname">Artist</code><a class="headerlink" href="#matplotlib.artist.Artist" title="Permalink to this definition">¶</a></dt>

<dd><p>Abstract base class for someone who renders into a

<code class="xref py py-class docutils literal"><span class="pre">FigureCanvas</span></code>.</p>

</dd></dl>

<h3>Interactive<a class="headerlink" href="#interactive" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.add_callback.html#matplotlib.artist.Artist.add_callback" title="matplotlib.artist.Artist.add_callback"><code class="xref py py-obj docutils literal"><span class="pre">Artist.add_callback</span></code></a></td>

<td>Adds a callback function that will be called whenever one of the <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a>’s properties changes.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.format_cursor_data.html#matplotlib.artist.Artist.format_cursor_data" title="matplotlib.artist.Artist.format_cursor_data"><code class="xref py py-obj docutils literal"><span class="pre">Artist.format_cursor_data</span></code></a></td>

<td>Return <em>cursor data</em> string formatted.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_contains.html#matplotlib.artist.Artist.get_contains" title="matplotlib.artist.Artist.get_contains"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_contains</span></code></a></td>

<td>Return the _contains test used by the artist, or <em>None</em> for default.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_cursor_data.html#matplotlib.artist.Artist.get_cursor_data" title="matplotlib.artist.Artist.get_cursor_data"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_cursor_data</span></code></a></td>

<td>Get the cursor data for a given event.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_picker.html#matplotlib.artist.Artist.get_picker" title="matplotlib.artist.Artist.get_picker"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_picker</span></code></a></td>

<td>Return the picker object used by this artist</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.hitlist.html#matplotlib.artist.Artist.hitlist" title="matplotlib.artist.Artist.hitlist"><code class="xref py py-obj docutils literal"><span class="pre">Artist.hitlist</span></code></a></td>

<td>List the children of the artist which contain the mouse event <em>event</em>.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.mouseover.html#matplotlib.artist.Artist.mouseover" title="matplotlib.artist.Artist.mouseover"><code class="xref py py-obj docutils literal"><span class="pre">Artist.mouseover</span></code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.pchanged.html#matplotlib.artist.Artist.pchanged" title="matplotlib.artist.Artist.pchanged"><code class="xref py py-obj docutils literal"><span class="pre">Artist.pchanged</span></code></a></td>

<td>Fire an event when property changed, calling all of the registered callbacks.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.pick.html#matplotlib.artist.Artist.pick" title="matplotlib.artist.Artist.pick"><code class="xref py py-obj docutils literal"><span class="pre">Artist.pick</span></code></a></td>

<td>Process pick event</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.pickable.html#matplotlib.artist.Artist.pickable" title="matplotlib.artist.Artist.pickable"><code class="xref py py-obj docutils literal"><span class="pre">Artist.pickable</span></code></a></td>

<td>Return <em>True</em> if <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a> is pickable.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.remove_callback.html#matplotlib.artist.Artist.remove_callback" title="matplotlib.artist.Artist.remove_callback"><code class="xref py py-obj docutils literal"><span class="pre">Artist.remove_callback</span></code></a></td>

<td>Remove a callback based on its <em>id</em>.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_contains</span></code></a></td>

<td>Replace the contains test used by this artist.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_picker</span></code></a></td>

<td>Set the epsilon for picking used by this artist</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.contains.html#matplotlib.artist.Artist.contains" title="matplotlib.artist.Artist.contains"><code class="xref py py-obj docutils literal"><span class="pre">Artist.contains</span></code></a></td>

<td>Test whether the artist contains the mouse event.</td>

</tr>

</tbody>

</table>

</div>

<h3>Margins and Autoscaling<a class="headerlink" href="#margins-and-autoscaling" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.sticky_edges.html#matplotlib.artist.Artist.sticky_edges" title="matplotlib.artist.Artist.sticky_edges"><code class="xref py py-obj docutils literal"><span class="pre">Artist.sticky_edges</span></code></a></td>

<td><code class="xref py py-obj docutils literal"><span class="pre">x</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">y</span></code> sticky edge lists.</td>

</tr>

</tbody>

</table>

</div>

<h3>Clipping<a class="headerlink" href="#clipping" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_clip_box.html#matplotlib.artist.Artist.get_clip_box" title="matplotlib.artist.Artist.get_clip_box"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_clip_box</span></code></a></td>

<td>Return artist clipbox</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_clip_on.html#matplotlib.artist.Artist.get_clip_on" title="matplotlib.artist.Artist.get_clip_on"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_clip_on</span></code></a></td>

<td>Return whether artist uses clipping</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_clip_path.html#matplotlib.artist.Artist.get_clip_path" title="matplotlib.artist.Artist.get_clip_path"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_clip_path</span></code></a></td>

<td>Return artist clip path</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_box.html#matplotlib.artist.Artist.set_clip_box" title="matplotlib.artist.Artist.set_clip_box"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_clip_box</span></code></a></td>

<td>Set the artist’s clip <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">Bbox</span></code></a>.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_on.html#matplotlib.artist.Artist.set_clip_on" title="matplotlib.artist.Artist.set_clip_on"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_clip_on</span></code></a></td>

<td>Set whether artist uses clipping.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_path.html#matplotlib.artist.Artist.set_clip_path" title="matplotlib.artist.Artist.set_clip_path"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_clip_path</span></code></a></td>

<td>Set the artist’s clip path, which may be:</td>

</tr>

</tbody>

</table>

</div>

<h3>Bulk Properties<a class="headerlink" href="#bulk-properties" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.update.html#matplotlib.artist.Artist.update" title="matplotlib.artist.Artist.update"><code class="xref py py-obj docutils literal"><span class="pre">Artist.update</span></code></a></td>

<td>Update the properties of this <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a> from the dictionary <em>prop</em>.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.update_from.html#matplotlib.artist.Artist.update_from" title="matplotlib.artist.Artist.update_from"><code class="xref py py-obj docutils literal"><span class="pre">Artist.update_from</span></code></a></td>

<td>Copy properties from <em>other</em> to <em>self</em>.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.properties.html#matplotlib.artist.Artist.properties" title="matplotlib.artist.Artist.properties"><code class="xref py py-obj docutils literal"><span class="pre">Artist.properties</span></code></a></td>

<td>return a dictionary mapping property name -> value for all Artist props</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set.html#matplotlib.artist.Artist.set" title="matplotlib.artist.Artist.set"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set</span></code></a></td>

<td>A property batch setter.</td>

</tr>

</tbody>

</table>

</div>

<h3>Drawing<a class="headerlink" href="#drawing" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.draw.html#matplotlib.artist.Artist.draw" title="matplotlib.artist.Artist.draw"><code class="xref py py-obj docutils literal"><span class="pre">Artist.draw</span></code></a></td>

<td>Derived classes drawing method</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_animated.html#matplotlib.artist.Artist.get_animated" title="matplotlib.artist.Artist.get_animated"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_animated</span></code></a></td>

<td>Return the artist’s animated state</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_animated</span></code></a></td>

<td>Set the artist’s animation state.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_agg_filter.html#matplotlib.artist.Artist.get_agg_filter" title="matplotlib.artist.Artist.get_agg_filter"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_agg_filter</span></code></a></td>

<td>return filter function to be used for agg filter</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_alpha.html#matplotlib.artist.Artist.get_alpha" title="matplotlib.artist.Artist.get_alpha"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_alpha</span></code></a></td>

<td>Return the alpha value used for blending - not supported on all</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_snap.html#matplotlib.artist.Artist.get_snap" title="matplotlib.artist.Artist.get_snap"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_snap</span></code></a></td>

<td>Returns the snap setting which may be:</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_visible.html#matplotlib.artist.Artist.get_visible" title="matplotlib.artist.Artist.get_visible"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_visible</span></code></a></td>

<td>Return the artist’s visiblity</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_zorder.html#matplotlib.artist.Artist.get_zorder" title="matplotlib.artist.Artist.get_zorder"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_zorder</span></code></a></td>

<td>Return the <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a>’s zorder.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_agg_filter</span></code></a></td>

<td>set agg_filter function.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_alpha</span></code></a></td>

<td>Set the alpha value used for blending - not supported on all backends.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_sketch_params</span></code></a></td>

<td>Sets the sketch parameters.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_snap.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_snap</span></code></a></td>

<td>Sets the snap setting which may be:</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_rasterized.html#matplotlib.artist.Artist.get_rasterized" title="matplotlib.artist.Artist.get_rasterized"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_rasterized</span></code></a></td>

<td>return True if the artist is to be rasterized</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_sketch_params.html#matplotlib.artist.Artist.get_sketch_params" title="matplotlib.artist.Artist.get_sketch_params"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_sketch_params</span></code></a></td>

<td>Returns the sketch parameters for the artist.</td>

</tr>

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

<td>set path_effects, which should be a list of instances of</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_rasterized</span></code></a></td>

<td>Force rasterized (bitmap) drawing in vector backend output.</td>

</tr>

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

</tr>

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

<td>Set the artist’s visiblity.</td>

</tr>

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

<td>Set the zorder for the artist.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_window_extent.html#matplotlib.artist.Artist.get_window_extent" title="matplotlib.artist.Artist.get_window_extent"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_window_extent</span></code></a></td>

<td>Get the axes bounding box in display space.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_path_effects.html#matplotlib.artist.Artist.get_path_effects" title="matplotlib.artist.Artist.get_path_effects"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_path_effects</span></code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_transformed_clip_path_and_affine.html#matplotlib.artist.Artist.get_transformed_clip_path_and_affine" title="matplotlib.artist.Artist.get_transformed_clip_path_and_affine"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_transformed_clip_path_and_affine</span></code></a></td>

<td>Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.</td>

</tr>

</tbody>

</table>

</div>

<h3>Figure and Axes<a class="headerlink" href="#figure-and-axes" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.remove.html#matplotlib.artist.Artist.remove" title="matplotlib.artist.Artist.remove"><code class="xref py py-obj docutils literal"><span class="pre">Artist.remove</span></code></a></td>

<td>Remove the artist from the figure if possible.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.axes.html#matplotlib.artist.Artist.axes" title="matplotlib.artist.Artist.axes"><code class="xref py py-obj docutils literal"><span class="pre">Artist.axes</span></code></a></td>

<td>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance the artist resides in, or <em>None</em>.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_axes.html#matplotlib.artist.Artist.get_axes" title="matplotlib.artist.Artist.get_axes"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_axes</span></code></a></td>

<td>Return the <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance the artist resides in, or <em>None</em>.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_axes.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_axes</span></code></a></td>

<td>Set the <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance in which the artist resides, if any.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_figure</span></code></a></td>

<td>Set the <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">Figure</span></code></a> instance the artist belongs to.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_figure.html#matplotlib.artist.Artist.get_figure" title="matplotlib.artist.Artist.get_figure"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_figure</span></code></a></td>

<td>Return the <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">Figure</span></code></a> instance the artist belongs to.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.is_figure_set.html#matplotlib.artist.Artist.is_figure_set" title="matplotlib.artist.Artist.is_figure_set"><code class="xref py py-obj docutils literal"><span class="pre">Artist.is_figure_set</span></code></a></td>

<td>Returns True if the artist is assigned to a <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">Figure</span></code></a>.</td>

</tr>

</tbody>

</table>

</div>

<h3>Children<a class="headerlink" href="#children" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_children.html#matplotlib.artist.Artist.get_children" title="matplotlib.artist.Artist.get_children"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_children</span></code></a></td>

<td>Return a list of the child <code class="xref py py-class docutils literal"><span class="pre">Artist`s</span> <span class="pre">this</span> <span class="pre">:class:`Artist</span></code> contains.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.findobj.html#matplotlib.artist.Artist.findobj" title="matplotlib.artist.Artist.findobj"><code class="xref py py-obj docutils literal"><span class="pre">Artist.findobj</span></code></a></td>

<td>Find artist objects.</td>

</tr>

</tbody>

</table>

</div>

<h3>Transform<a class="headerlink" href="#transform" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_transform</span></code></a></td>

<td>Set the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a> instance used by this artist.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_transform.html#matplotlib.artist.Artist.get_transform" title="matplotlib.artist.Artist.get_transform"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_transform</span></code></a></td>

<td>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a> instance used by this artist.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.is_transform_set.html#matplotlib.artist.Artist.is_transform_set" title="matplotlib.artist.Artist.is_transform_set"><code class="xref py py-obj docutils literal"><span class="pre">Artist.is_transform_set</span></code></a></td>

<td>Returns <em>True</em> if <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a> has a transform explicitly set.</td>

</tr>

</tbody>

</table>

</div>

<h3>Units<a class="headerlink" href="#units" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.convert_xunits.html#matplotlib.artist.Artist.convert_xunits" title="matplotlib.artist.Artist.convert_xunits"><code class="xref py py-obj docutils literal"><span class="pre">Artist.convert_xunits</span></code></a></td>

<td>For artists in an axes, if the xaxis has units support,</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.convert_yunits.html#matplotlib.artist.Artist.convert_yunits" title="matplotlib.artist.Artist.convert_yunits"><code class="xref py py-obj docutils literal"><span class="pre">Artist.convert_yunits</span></code></a></td>

<td>For artists in an axes, if the yaxis has units support,</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.have_units.html#matplotlib.artist.Artist.have_units" title="matplotlib.artist.Artist.have_units"><code class="xref py py-obj docutils literal"><span class="pre">Artist.have_units</span></code></a></td>

<td>Return <em>True</em> if units are set on the <em>x</em> or <em>y</em> axes</td>

</tr>

</tbody>

</table>

</div>

<h3>Metadata<a class="headerlink" href="#metadata" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_gid.html#matplotlib.artist.Artist.get_gid" title="matplotlib.artist.Artist.get_gid"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_gid</span></code></a></td>

<td>Returns the group id</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_label.html#matplotlib.artist.Artist.get_label" title="matplotlib.artist.Artist.get_label"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_label</span></code></a></td>

<td>Get the label used for this artist in the legend.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_gid.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_gid</span></code></a></td>

<td>Sets the (group) id for the artist</td>

</tr>

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

<td>Set the label to <em>s</em> for auto legend.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_url.html#matplotlib.artist.Artist.get_url" title="matplotlib.artist.Artist.get_url"><code class="xref py py-obj docutils literal"><span class="pre">Artist.get_url</span></code></a></td>

<td>Returns the url</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_url.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-obj docutils literal"><span class="pre">Artist.set_url</span></code></a></td>

<td>Sets the url for the artist</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.aname.html#matplotlib.artist.Artist.aname" title="matplotlib.artist.Artist.aname"><code class="xref py py-obj docutils literal"><span class="pre">Artist.aname</span></code></a></td>

</tr>

</tbody>

</table>

</div>

<h3>Stale<a class="headerlink" href="#stale" title="Permalink to this headline">¶</a></h3>

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.stale.html#matplotlib.artist.Artist.stale" title="matplotlib.artist.Artist.stale"><code class="xref py py-obj docutils literal"><span class="pre">Artist.stale</span></code></a></td>

<td>If the artist is ‘stale’ and needs to be re-drawn for the output to match the internal state of the artist.</td>

</tr>

</tbody>

</table>

</div>

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

</colgroup>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.allow_rasterization.html#matplotlib.artist.allow_rasterization" title="matplotlib.artist.allow_rasterization"><code class="xref py py-obj docutils literal"><span class="pre">allow_rasterization</span></code></a></td>

<td>Decorator for Artist.draw method.</td>

</tr>

<td>Return the value of object’s property.</td>

</tr>

<td>Return the value of object’s property.</td>

</tr>

<td>Set a property on an artist object.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.kwdoc.html#matplotlib.artist.kwdoc" title="matplotlib.artist.kwdoc"><code class="xref py py-obj docutils literal"><span class="pre">kwdoc</span></code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.ArtistInspector.html#matplotlib.artist.ArtistInspector" title="matplotlib.artist.ArtistInspector"><code class="xref py py-obj docutils literal"><span class="pre">ArtistInspector</span></code></a></td>

<td>A helper class to inspect an <a class="reference internal" href="#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a> and return information about it’s settable properties and their current values.</td>

</tr>

</tbody>

</table>

</div>

</div>

Last updated on Jul 16, 2017.

Created using <a

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

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

<!--Flipcause Integration v3.0// Flipcause Integration Instructions:

Install the following code block once in the website Header (after <head> tag) -->

<style>

.fc-black_overlay{

display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;

background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;

}

.fc-white_content {

opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;

position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;

}

.fc-main-box{

opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;

}

.fc-widget_close{

opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);

position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;

}

.floating_button{

display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;

position:fixed; z-index:999999; overflow: auto;

}

@keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-moz-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-webkit-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-o-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-ms-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; transform: translateY(20px);}

100% {opacity: 1; transform: translateY(0);}

}

@-moz-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -moz-transform: translateY(20px);}

100% {opacity: 1; -moz-transform: translateY(0);}

}

@-webkit-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -webkit-transform: translateY(20px);}

100% {opacity: 1; -webkit-transform: translateY(0);}

}

@-o-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -o-transform: translateY(20px);}

100% {opacity: 1; -o-transform: translateY(0);}

}

@-ms-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -ms-transform: translateY(20px);}

100% {opacity: 1; -ms-transform: translateY(0);}

}

</style>

function open_window(cause_id) {

var protocol=String(document.location.protocol);

var new_url;

if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){

new_url="https://www.flipcause.com/widget/"+cause_id

window.open(new_url);

}

else {

document.getElementById("fc-fade").style.display = "block";

document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";

document.getElementById("fc-fade").style.animation = "backfadesin 1s";

document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";

document.getElementById("fc-light").style.display = "block";

document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-light").style.animation = "fadesin 1.5s";

document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.display = "block";

document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.animation = "fadesin 1.5s";

document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.display = "block";

document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.animation = "fadesin 1.5s";

document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.display = "block";

document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;

}

function close_window() {

document.getElementById("fc-fade").style.display="none";

document.getElementById("fc-light").style.display="none";

document.getElementById("fc-main").style.display="none";

document.getElementById("fc-close").style.display="none";

document.getElementById("fc-myFrame").style.display="none";

}

</script>

</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;

border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>

</div>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

artist_api.html

Latest commit

History

artist_api.html

File metadata and controls