8000 Add cross-references to Artist tutorial. · matplotlib/matplotlib@85e3c85 · GitHub
[go: up one dir, main page]
Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 85e3c85

Browse files
QuLogicQuLogic
committed
Add cross-references to Artist tutorial.
1 parent eb0bd90 commit 85e3c85

File tree

2 files changed

+74
-66
lines changed

2 files changed

+74
-66
lines changed

‎doc/api/axis_api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Axis Label
7777
Axis.set_label_coords
7878
Axis.set_label_position
7979
Axis.set_label_text
80+
Axis.get_label
8081
Axis.get_label_position
8182
Axis.get_label_text
8283

‎tutorials/intermediate/artists.py

Lines changed: 73 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -348,21 +348,20 @@ class in the Matplotlib API, and the one you will be working with most
348348
###############################################################################
349349
# Here is a summary of the Artists the Figure contains
350350
#
351-
# .. TODO: Add xrefs to this table
352-
#
353351
# ================ ============================================================
354352
# Figure attribute Description
355353
# ================ ============================================================
356-
# axes A list of Axes instances (includes Subplot)
357-
# patch The Rectangle background
358-
# images A list of FigureImage patches -
354+
# axes A list of `~.axes.Axes` instances (includes Subplot)
355+
# patch The `.Rectangle` background
356+
# images A list of `.FigureImage` patches -
359357
# useful for raw pixel display
360-
# legends A list of Figure Legend instances
361-
# (different from Axes.legends)
362-
# lines A list of Figure Line2D instances
363-
# (rarely used, see Axes.lines)
364-
# patches A list of Figure patches (rarely used, see Axes.patches)
365-
# texts A list Figure Text instances
358+
# legends A list of Figure `.Legend` instances
359+
# (different from ``Axes.legends``)
360+
# lines A list of Figure `.Line2D` instances
361+
# (rarely used, see ``Axes.lines``)
362+
# patches A list of Figure `.Patch`\s
363+
# (rarely used, see ``Axes.patches``)
364+
# texts A list Figure `.Text` instances
366365
# ================ ============================================================
367366
#
368367
# .. _axes-container:
@@ -537,20 +536,21 @@ class in the Matplotlib API, and the one you will be working with most
537536
# below summarizes a small sampling of them, the kinds of ``Artist`` they
538537
# create, and where they store them
539538
#
540-
# ============================== ==================== =======================
541-
# Helper method Artist Container
542-
# ============================== ==================== =======================
543-
# ax.annotate - text annotations Annotate ax.texts
544-
# ax.bar - bar charts Rectangle ax.patches
545-
# ax.errorbar - error bar plots Line2D and Rectangle ax.lines and ax.patches
546-
# ax.fill - shared area Polygon ax.patches
547-
# ax.hist - histograms Rectangle ax.patches
548-
# ax.imshow - image data AxesImage ax.images
549-
# ax.legend - Axes legends Legend ax.legends
550-
# ax.plot - xy plots Line2D ax.lines
551-
# ax.scatter - scatter charts PolygonCollection ax.collections
552-
# ax.text - text Text ax.texts
553-
# ============================== ==================== =======================
539+
# ========================================= ================= ===============
540+
# Axes helper method Artist Container
541+
# ========================================= ================= ===============
542+
# `~.axes.Axes.annotate` - text annotations `.Annotation` ax.texts
543+
# `~.axes.Axes.bar` - bar charts `.Rectangle` ax.patches
544+
# `~.axes.Axes.errorbar` - error bar plots `.Line2D` and ax.lines and
545+
# `.Rectangle` ax.patches
546+
# `~.axes.Axes.fill` - shared area `.Polygon` ax.patches
547+
# `~.axes.Axes.hist` - histograms `.Rectangle` ax.patches
548+
# `~.axes.Axes.imshow` - image data `.AxesImage` ax.images
549+
# `~.axes.Axes.legend` - Axes legends `.Legend` ax.legends
550+
# `~.axes.Axes.plot` - xy plots `.Line2D` ax.lines
551+
# `~.axes.Axes.scatter` - scatter charts `.PolyCollection` ax.collections
552+
# `~.axes.Axes.text` - text `.Text` ax.texts
553+
# ========================================= ================= ===============
554554
#
555555
#
556556
# In addition to all of these ``Artists``, the ``Axes`` contains two
@@ -571,20 +571,20 @@ class in the Matplotlib API, and the one you will be working with most
571571
#
572572
# Below is a summary of the Artists that the Axes contains
573573
#
574-
# ============== ======================================
574+
# ============== =========================================
575575
# Axes attribute Description
576-
# ============== ======================================
577-
# artists A list of Artist instances
578-
# patch Rectangle instance for Axes background
579-
# collections A list of Collection instances
580-
# images A list of AxesImage
581-
# legends A list of Legend instances
582-
# lines A list of Line2D instances
583-
# patches A list of Patch instances
584-
# texts A list of Text instances
585-
# xaxis matplotlib.axis.XAxis instance
586-
# yaxis matplotlib.axis.YAxis instance
587-
# ============== ======================================
576+
# ============== =========================================
577+
# artists A list of `.Artist` instances
578+
# patch `.Rectangle` instance for Axes background
579+
# collections A list of `.Collection` instances
580+
# images A list of `.AxesImage`
581+
# legends A list of `.Legend` instances
582+
# lines A list of `.Line2D` instances
583+
# patches A list of `.Patch` instances
584+
# texts A list of `.Text` instances
585+
# xaxis A `matplotlib.axis.XAxis` instance
586+
# yaxis A `matplotlib.axis.YAxis` instance
587+
# ============== =========================================
588588
#
589589
# .. _axis-container:
590590
#
@@ -639,25 +639,32 @@ class in the Matplotlib API, and the one you will be working with most
639639
# (these have corresponding setters where useful, such as
640640
# :meth:`~matplotlib.axis.Axis.set_major_formatter`.)
641641
#
642-
# ==================== =====================================================
643-
# Accessor method Description
644-
# ==================== =====================================================
645-
# get_scale The scale of the axis, e.g., 'log' or 'linear'
646-
# get_view_interval The interval instance of the axis view limits
647-
# get_data_interval The interval instance of the axis data limits
648-
# get_gridlines A list of grid lines for the Axis
649-
# get_label The axis label - a Text instance
650-
# get_ticklabels A list of Text instances - keyword minor=True|False
651-
# get_ticklines A list of Line2D instances - keyword minor=True|False
652-
# get_ticklocs A list of Tick locations - keyword minor=True|False
653-
# get_major_locator The `.ticker.Locator` instance for major ticks
654-
# get_major_formatter The `.ticker.Formatter` instance for major ticks
655-
# get_minor_locator The `.ticker.Locator` instance for minor ticks
656-
# get_minor_formatter The `.ticker.Formatter` instance for minor ticks
657-
# get_major_ticks A list of Tick instances for major ticks
658-
# get_minor_ticks A list of Tick instances for minor ticks
659-
# grid Turn the grid on or off for the major or minor ticks
660-
# ==================== =====================================================
642+
# ============================= ==============================================
643+
# Axis accessor method Description
644+
# ============================= ==============================================
645+
# `~.Axis.get_scale` The scale of the Axis, e.g., 'log' or 'linear'
646+
# `~.Axis.get_view_interval` The interval instance of the Axis view limits
647+
# `~.Axis.get_data_interval` The interval instance of the Axis data limits
648+
# `~.Axis.get_gridlines` A list of grid lines for the Axis
649+
# `~.Axis.get_label` The Axis label - a `.Text` instance
650+
# `~.Axis.get_offset_text` The Axis offset text - a `.Text` instance
651+
# `~.Axis.get_ticklabels` A list of `.Text` instances -
652+
# keyword minor=True|False
653+
# `~.Axis.get_ticklines` A list of `.Line2D` instances -
654+
# keyword minor=True|False
655+
# `~.Axis.get_ticklocs` A list of Tick locations -
656+
# keyword minor=True|False
657+
# `~.Axis.get_major_locator` The `.ticker.Locator` instance for major ticks
658+
# `~.Axis.get_major_formatter` The `.ticker.Formatter` instance for major
659+
# ticks
660+
# `~.Axis.get_minor_locator` The `.ticker.Locator` instance for minor ticks
661+
# `~.Axis.get_minor_formatter` The `.ticker.Formatter` instance for minor
662+
# ticks
663+
# `~.axis.Axis.get_major_ticks` A list of `.Tick` instances for major ticks
664+
# `~.axis.Axis.get_minor_ticks` A list of `.Tick` instances for minor ticks
665+
# `~.Axis.grid` Turn the grid on or off for the major or minor
666+
# ticks
667+
# ============================= ==============================================
661668
#
662669
# Here is an example, not recommended for its beauty, which customizes
663670
# the Axes and Tick properties.
@@ -700,15 +707,15 @@ class in the Matplotlib API, and the one you will be working with most
700707
# and lower ticks. Each of these is accessible directly as an attribute
701708
# of the ``Tick``.
702709
#
703-
# ============== ==========================================================
704-
# Tick attribute Description
705-
# ============== ==========================================================
706-
# tick1line Line2D instance
707-
# tick2line Line2D instance
708-
# gridline Line2D instance
709-
# label1 Text instance
710-
# label2 Text instance
711-
# ============== ==========================================================
710+
# ============== ==========================================================
711+
# Tick attribute Description
712+
# ============== ==========================================================
713+
# tick1line A `.Line2D` instance
714+
# tick2line A `.Line2D` instance
715+
# gridline A `.Line2D` instance
716+
# label1 A `.Text` instance
717+
# label2 A `.Text` instance
718+
# ============== ==========================================================
712719
#
713720
# Here is an example which sets the formatter for the right side ticks with
714721
# dollar signs and colors them green on the right side of the yaxis.

0 commit comments

Comments
 (0)
0