Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Add capstyle and joinstyle attributes to Collection class (Issue #8277)#9523
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
4 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
7 changes: 7 additions & 0 deletionsdoc/users/whats_new.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -246,6 +246,13 @@ volumetric model. | ||
| Improvements | ||
| ++++++++++++ | ||
| Add ``capstyle`` and ``joinstyle`` attributes to `Collection` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This got put into the 2.1 whats_new 😞 | ||
| ------------------------------------------------------------- | ||
| The `Collection` class now has customizable ``capstyle`` and ``joinstyle`` | ||
| attributes. This allows the user for example to set the ``capstyle`` of | ||
| errorbars. | ||
| CheckButtons widget ``get_status`` function | ||
| ------------------------------------------- | ||
59 changes: 59 additions & 0 deletionslib/matplotlib/collections.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -52,11 +52,16 @@ class Collection(artist.Artist, cm.ScalarMappable): | ||
| prop[i % len(props)] | ||
| Exceptions are *capstyle* and *joinstyle* properties, these can | ||
| only be set globally for the whole collection. | ||
| Keyword arguments and default values: | ||
| * *edgecolors*: None | ||
| * *facecolors*: None | ||
| * *linewidths*: None | ||
| * *capstyle*: None | ||
| * *joinstyle*: None | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 👍 | ||
| * *antialiaseds*: None | ||
| * *offsets*: None | ||
| * *transOffset*: transforms.IdentityTransform() | ||
| @@ -104,6 +109,8 @@ def __init__(self, | ||
| facecolors=None, | ||
| linewidths=None, | ||
| linestyles='solid', | ||
| capstyle=None, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Those two new arguments need to be documented in the docstring for this class. | ||
| joinstyle=None, | ||
| antialiaseds=None, | ||
| offsets=None, | ||
| transOffset=None, | ||
| @@ -145,6 +152,16 @@ def __init__(self, | ||
| self.set_offset_position(offset_position) | ||
| self.set_zorder(zorder) | ||
| if capstyle: | ||
| self.set_capstyle(capstyle) | ||
| else: | ||
| self._capstyle = None | ||
| if joinstyle: | ||
| self.set_joinstyle(joinstyle) | ||
| else: | ||
| self._joinstyle = None | ||
| self._offsets = np.zeros((1, 2)) | ||
| self._uniform_offsets = None | ||
| if offsets is not None: | ||
| @@ -304,6 +321,12 @@ def draw(self, renderer): | ||
| extents.height < height): | ||
| do_single_path_optimization = True | ||
| if self._joinstyle: | ||
| gc.set_joinstyle(self._joinstyle) | ||
| if self._capstyle: | ||
| gc.set_capstyle(self._capstyle) | ||
| if do_single_path_optimization: | ||
| gc.set_foreground(tuple(edgecolors[0])) | ||
| gc.set_linewidth(self._linewidths[0]) | ||
| @@ -536,6 +559,42 @@ def set_linestyle(self, ls): | ||
| self._linewidths, self._linestyles = self._bcast_lwls( | ||
| self._us_lw, self._us_linestyles) | ||
| def set_capstyle(self, cs): | ||
| """ | ||
| Set the capstyle for the collection. The capstyle can | ||
| only be set globally for all elements in the collection | ||
| Parameters | ||
| ---------- | ||
| cs : ['butt' | 'round' | 'projecting'] | ||
| The capstyle | ||
| """ | ||
| if cs in ('butt', 'round', 'projecting'): | ||
| self._capstyle = cs | ||
| else: | ||
| raise ValueError('Unrecognized cap style. Found %s' % cs) | ||
| def get_capstyle(self): | ||
| return self._capstyle | ||
| def set_joinstyle(self, js): | ||
| """ | ||
| Set the joinstyle for the collection. The joinstyle can only be | ||
| set globally for all elements in the collection. | ||
| Parameters | ||
| ---------- | ||
| js : ['miter' | 'round' | 'bevel'] | ||
| The joinstyle | ||
| """ | ||
| if js in ('miter', 'round', 'bevel'): | ||
| self._joinstyle = js | ||
| else: | ||
| raise ValueError('Unrecognized join style. Found %s' % js) | ||
| def get_joinstyle(self): | ||
| return self._joinstyle | ||
| @staticmethod | ||
| def _bcast_lwls(linewidths, dashes): | ||
| '''Internal helper function to broadcast + scale ls/lw | ||
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 39 additions & 1 deletionlib/matplotlib/tests/test_collections.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.