Made suggested changes

Author: r3kste

galleries/examples/shapes_and_collections/hatchcolor_demo.py

@@ -3,12 +3,19 @@
 Hatchcolor Demo
 ===============
 
+The color of the hatch can be set using the *hatchcolor* parameter. The following
+examples show how to use the *hatchcolor* parameter to set the color of the hatch
+in `~.patches.Patch` and `~.collections.Collection`.
+
+See also :doc:`/gallery/shapes_and_collections/hatch_demo` for more usage examples
+of hatching.
+
 Patch Hatchcolor
 ----------------
 
 This example shows how to use the *hatchcolor* parameter to set the color of
-the hatch. The *hatchcolor* parameter is available for `~.patches.Patch`,
-child classes of Patch, and methods that pass through to Patch.
+the hatch in a rectangle and a bar plot. The *hatchcolor* parameter is available for
+`~.patches.Patch`, child classes of Patch, and methods that pass through to Patch.
 """
 
 import matplotlib.pyplot as plt
@@ -62,19 +69,13 @@
     facecolor="none",
     edgecolor="gray",
     linewidth=2,
-    marker="h",  # Use hexagon as marker
+    marker="s",  # Use hexagon as marker
     hatch="xxx",
     hatchcolor=colors,
 )
 ax.set_xlim(0, 1)
 ax.set_ylim(0, 1)
 
-# Remove ticks and labels
-ax.set_xticks([])
-ax.set_yticks([])
-ax.set_xticklabels([])
-ax.set_yticklabels([])
-
 plt.show()
 
 # %%

lib/matplotlib/backend_bases.py

@@ -221,7 +221,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
         and *hatchcolors* are lists that set the corresponding properties.
 
         .. versionadded:: 3.11
-            Allowing *hatchcolors* to be specified.
+            Allow *hatchcolors* to be specified.
 
         *offset_position* is unused now, but the argument is kept for
         backwards compatibility.
@@ -244,7 +244,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
         for xo, yo, path_id, gc0, rgbFace in self._iter_collection(
                 gc, list(path_ids), offsets, offset_trans,
                 facecolors, edgecolors, linewidths, linestyles,
-                antialiaseds, urls, offset_position, hatchcolors):
+                antialiaseds, urls, offset_position, hatchcolors=hatchcolors):
             path, transform = path_id
             # Only apply another translation if we have an offset, else we
             # reuse the initial transform.
@@ -258,7 +258,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
 
     def draw_quad_mesh(self, gc, master_transform, meshWidth, meshHeight,
                        coordinates, offsets, offsetTrans, facecolors,
-                       antialiased, edgecolors, hatchcolors=None):
+                       antialiased, edgecolors, *, hatchcolors=None):
         """
         Draw a quadmesh.
 
@@ -346,7 +346,7 @@ def _iter_collection_uses_per_path(self, paths, all_transforms,
 
     def _iter_collection(self, gc, path_ids, offsets, offset_trans, facecolors,
                          edgecolors, linewidths, linestyles,
-                         antialiaseds, urls, offset_position, hatchcolors):
+                         antialiaseds, urls, offset_position, *, hatchcolors):
         """
         Helper method (along with `_iter_collection_raw_paths`) to implement
         `draw_path_collection` in a memory-efficient manner.

lib/matplotlib/backend_bases.pyi

@@ -78,6 +78,7 @@ class RendererBase:
         facecolors: Sequence[ColorType],
         antialiased: bool,
         edgecolors: Sequence[ColorType] | ColorType | None,
+        *,
         hatchcolors: Sequence[ColorType] | ColorType | None = None,
     ) -> None: ...
     def draw_gouraud_triangles(

lib/matplotlib/backends/backend_pdf.py

@@ -2091,7 +2091,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
         for xo, yo, path_id, gc0, rgbFace in self._iter_collection(
                 gc, path_codes, offsets, offset_trans,
                 facecolors, edgecolors, linewidths, linestyles,
-                antialiaseds, urls, offset_position, hatchcolors):
+                antialiaseds, urls, offset_position, hatchcolors=hatchcolors):
 
             self.check_gc(gc0, rgbFace)
             dx, dy = xo - lastx, yo - lasty

lib/matplotlib/backends/backend_ps.py

@@ -711,7 +711,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
         for xo, yo, path_id, gc0, rgbFace in self._iter_collection(
                 gc, path_codes, offsets, offset_trans,
                 facecolors, edgecolors, linewidths, linestyles,
-                antialiaseds, urls, offset_position, hatchcolors):
+                antialiaseds, urls, offset_position, hatchcolors=hatchcolors):
             ps = f"{xo:g} {yo:g} {path_id}"
             self._draw_ps(ps, gc0, rgbFace)
 

lib/matplotlib/backends/backend_svg.py

@@ -772,7 +772,7 @@ def draw_path_collection(self, gc, master_transform, paths, all_transforms,
         for xo, yo, path_id, gc0, rgbFace in self._iter_collection(
                 gc, path_codes, offsets, offset_trans,
                 facecolors, edgecolors, linewidths, linestyles,
-                antialiaseds, urls, offset_position, hatchcolors):
+                antialiaseds, urls, offset_position, hatchcolors=hatchcolors):
             url = gc0.get_url()
             if url is not None:
                 writer.start('a', attrib={'xlink:href': url})

lib/matplotlib/collections.py

@@ -454,7 +454,7 @@ def draw(self, renderer):
                     path_ids = renderer._iter_collection_raw_paths(
                         transform.frozen(), ipaths, self.get_transforms())
                     for xo, yo, path_id, gc0, rgbFace in renderer._iter_collection(
-                        gc, list(path_ids), *args
+                        gc, list(path_ids), *args, hatchcolors=self.get_hatchcolor(),
                     ):
                         path, transform = path_id
                         if xo != 0 or yo != 0:
@@ -474,7 +474,7 @@ def draw(self, renderer):
                 path_ids = renderer._iter_collection_raw_paths(
                     transform.frozen(), paths, self.get_transforms())
                 for xo, yo, path_id, gc0, rgbFace in renderer._iter_collection(
-                    gc, list(path_ids), *args
+                    gc, list(path_ids), *args, hatchcolors=self.get_hatchcolor(),
                 ):
                     path, transform = path_id
                     if xo != 0 or yo != 0:
@@ -802,14 +802,17 @@ def set_color(self, c):
         """
         Set the edgecolor, facecolor and hatchcolor.
 
+        .. versionchanged:: 3.11
+            Now sets the hatchcolor as well.
+
         Parameters
         ----------
         c : :mpltype:`color` or list of RGBA tuples
 
         See Also
         --------
-        Collection.set_facecolor, Collection.set_edgecolor
-            For setting the edge or face color individually.
+        Collection.set_facecolor, Collection.set_edgecolor, Collection.set_hatchcolor
+            For setting the facecolor, edgecolor, and hatchcolor individually.
         """
         self.set_facecolor(c)
         self.set_edgecolor(c)
@@ -2535,7 +2538,7 @@ def draw(self, renderer):
                 # Backends expect flattened rgba arrays (n*m, 4) for fc and ec
                 self.get_facecolor().reshape((-1, 4)),
                 self._antialiased, self.get_edgecolors().reshape((-1, 4)),
-                self.get_hatchcolor().reshape((-1, 4)))
+                hatchcolors=self.get_hatchcolor().reshape((-1, 4)))
         gc.restore()
         renderer.close_group(self.__class__.__name__)
         self.stale = False

lib/matplotlib/collections.pyi

@@ -21,7 +21,7 @@ class Collection(colorizer.ColorizingArtist):
         *,
         edgecolors: ColorType | Sequence[ColorType] | None = ...,
         facecolors: ColorType | Sequence[ColorType] | None = ...,
-        hatchcolors: ColorType | Sequence[ColorType] | None = ...,
+        hatchcolors: ColorType | Sequence[ColorType] | Literal["edge"] | None = ...,
         linewidths: float | Sequence[float] | None = ...,
         linestyles: LineStyleType | Sequence[LineStyleType] = ...,
         capstyle: CapStyleType | None = ...,

lib/matplotlib/patches.pyi

@@ -25,7 +25,7 @@ class Patch(artist.Artist):
         fill: bool = ...,
         capstyle: CapStyleType | None = ...,
         joinstyle: JoinStyleType | None = ...,
-        hatchcolor: ColorType | None = ...,
+        hatchcolor: ColorType | Literal["edge"] | None = ...,
         **kwargs,
     ) -> None: ...
     def get_verts(self) -> ArrayLike: ...

lib/matplotlib/tests/test_backend_bases.py

@@ -38,7 +38,7 @@ def check(master_transform, paths, all_transforms,
                    gc, range(len(raw_paths)), offsets,
                    transforms.AffineDeltaTransform(master_transform),
                    facecolors, edgecolors, [], [], [False],
-                   [], 'screen', [])]
+                   [], 'screen', hatchcolors=[])]
         uses = rb._iter_collection_uses_per_path(
             paths, all_transforms, offsets, facecolors, edgecolors)
         if raw_paths: