Skip to content

ENH: Add properties bottoms, tops, and position_centers to BarContainer #30226

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions doc/users/next_whats_new/barcontainer_properties.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
``BarContainer`` properties
---------------------------
`.BarContainer` gained new properties to easily access coordinates of the bars:

- `~.BarContainer.bottoms`
- `~.BarContainer.tops`
- `~.BarContainer.position_centers`
42 changes: 42 additions & 0 deletions lib/matplotlib/container.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,48 @@ def __init__(self, patches, errorbar=None, *, datavalues=None,
self.orientation = orientation
super().__init__(patches, **kwargs)

@property
def bottoms(self):
"""
Return the values at the lower end of the bars.

.. versionadded:: 3.11
"""
if self.orientation == 'vertical':
return [p.get_y() for p in self.patches]
elif self.orientation == 'horizontal':
return [p.get_x() for p in self.patches]
else:
raise ValueError("orientation must be 'vertical' or 'horizontal'.")

@property
def tops(self):
"""
Return the values at the upper end of the bars.

.. versionadded:: 3.11
"""
if self.orientation == 'vertical':
return [p.get_y() + p.get_height() for p in self.patches]
elif self.orientation == 'horizontal':
return [p.get_x() + p.get_width() for p in self.patches]
else:
raise ValueError("orientation must be 'vertical' or 'horizontal'.")

@property
def position_centers(self):
"""
Return the centers of bar positions.

.. versionadded:: 3.11
"""
if self.orientation == 'vertical':
return [p.get_x() + p.get_width() / 2 for p in self.patches]
elif self.orientation == 'horizontal':
return [p.get_y() + p.get_height() / 2 for p in self.patches]
else:
raise ValueError("orientation must be 'vertical' or 'horizontal'.")


class ErrorbarContainer(Container):
"""
Expand Down
6 changes: 6 additions & 0 deletions lib/matplotlib/container.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ class BarContainer(Container):
orientation: Literal["vertical", "horizontal"] | None = ...,
**kwargs
) -> None: ...
@property
def bottoms(self) -> list[float]: ...
@property
def tops(self) -> list[float]: ...
@property
def position_centers(self) -> list[float]: ...

class ErrorbarContainer(Container):
lines: tuple[Line2D, tuple[Line2D, ...], tuple[LineCollection, ...]]
Expand Down
18 changes: 18 additions & 0 deletions lib/matplotlib/tests/test_container.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import numpy as np
from numpy.testing import assert_array_equal
import matplotlib.pyplot as plt


Expand Down Expand Up @@ -35,3 +36,20 @@ def test_nonstring_label():
# Test for #26824
plt.bar(np.arange(10), np.random.rand(10), label=1)
plt.legend()


def test_barcontainer_position_centers__bottoms__tops():
fig, ax = plt.subplots()
pos = [1, 2, 4]
bottoms = np.array([1, 5, 3])
heights = np.array([2, 3, 4])

container = ax.bar(pos, heights, bottom=bottoms)
assert_array_equal(container.position_centers, pos)
assert_array_equal(container.bottoms, bottoms)
assert_array_equal(container.tops, bottoms + heights)

container = ax.barh(pos, heights, left=bottoms)
assert_array_equal(container.position_centers, pos)
assert_array_equal(container.bottoms, bottoms)
assert_array_equal(container.tops, bottoms + heights)
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy