8000 Backport PR #13436 on branch v3.0.x (Add get/set_in_layout to artist API docs.) by meeseeksmachine · Pull Request #13437 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Backport PR #13436 on branch v3.0.x (Add get/set_in_layout to artist API docs.) #13437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 14, 2019
Merged

Backport PR #13436 on branch v3.0.x (Add get/set_in_layout to artist API docs.) #13437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions doc/api/artist_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,6 @@ Interactive
Artist.set_picker
Artist.contains

Margins and Autoscaling
-----------------------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.sticky_edges

Clipping
--------

Expand Down Expand Up @@ -172,13 +163,16 @@ Metadata
Artist.set_url
Artist.aname

Stale
-----
Miscellaneous
-------------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.sticky_edges
Artist.set_in_layout
Artist.get_in_layout
Artist.stale

Functions
Expand Down
6 changes: 3 additions & 3 deletions lib/matplotlib/artist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -962,16 +962,16 @@ def set_zorder(self, level):
@property
def sticky_edges(self):
"""
`x` and `y` sticky edge lists.
``x`` and ``y`` sticky edge lists for autoscaling.

When performing autoscaling, if a data limit coincides with a value in
the corresponding sticky_edges list, then no margin will be added--the
view limit "sticks" to the edge. A typical usecase is histograms,
where one usually expects no margin on the bottom edge (0) of the
histogram.

This attribute cannot be assigned to; however, the `x` and `y` lists
can be modified in place as needed.
This attribute cannot be assigned to; however, the ``x`` and ``y``
lists can be modified in place as needed.

Examples
--------
Expand Down
0