adding pattern_shape to PX

Author: nicolaskruchten

packages/python/plotly/plotly/express/_chart_types.py

@@ -200,7 +200,9 @@ def density_heatmap(
         z=[
             "For `density_heatmap` and `density_contour` these values are used as the inputs to `histfunc`.",
         ],
-        histfunc=["The arguments to this function are the values of `z`.",],
+        histfunc=[
+            "The arguments to this function are the values of `z`.",
+        ],
     ),
 )
 
@@ -308,6 +310,7 @@ def bar(
     x=None,
     y=None,
     color=None,
+    pattern_shape=None,
     facet_row=None,
     facet_col=None,
     facet_col_wrap=0,
@@ -329,6 +332,8 @@ def bar(
     color_discrete_sequence=None,
     color_discrete_map=None,
     color_continuous_scale=None,
+    pattern_shape_sequence=None,
+    pattern_shape_map=None,
     range_color=None,
     color_continuous_midpoint=None,
     opacity=None,
@@ -410,6 +415,7 @@ def histogram(
     x=None,
     y=None,
     color=None,
+    pattern_shape=None,
     facet_row=None,
     facet_col=None,
     facet_col_wrap=0,
@@ -423,6 +429,8 @@ def histogram(
     labels=None,
     color_discrete_sequence=None,
     color_discrete_map=None,
+    pattern_shape_sequence=None,
+    pattern_shape_map=None,
     marginal=None,
     opacity=None,
     orientation=None,
@@ -451,7 +459,9 @@ def histogram(
         args=locals(),
         constructor=go.Histogram,
         trace_patch=dict(
-            histnorm=histnorm, histfunc=histfunc, cumulative=dict(enabled=cumulative),
+            histnorm=histnorm,
+            histfunc=histfunc,
+            cumulative=dict(enabled=cumulative),
         ),
         layout_patch=dict(barmode=barmode, barnorm=barnorm),
     )
@@ -511,7 +521,11 @@ def violin(
         args=locals(),
         constructor=go.Violin,
         trace_patch=dict(
-            points=points, box=dict(visible=box), scalegroup=True, x0=" ", y0=" ",
+            points=points,
+            box=dict(visible=box),
+            scalegroup=True,
+            x0=" ",
+            y0=" ",
         ),
         layout_patch=dict(violinmode=violinmode),
     )
@@ -892,6 +906,7 @@ def bar_polar(
     r=None,
     theta=None,
     color=None,
+    pattern_shape=None,
     hover_name=None,
     hover_data=None,
     custom_data=None,
@@ -903,6 +918,8 @@ def bar_polar(
     color_discrete_sequence=None,
     color_discrete_map=None,
     color_continuous_scale=None,
+    pattern_shape_sequence=None,
+    pattern_shape_map=None,
     range_color=None,
     color_continuous_midpoint=None,
     barnorm=None,

packages/python/plotly/plotly/express/_core.py

@@ -30,6 +30,7 @@
     "color",  # renamed to marker.color or line.color in infer_config
     "symbol",  # renamed to marker.symbol in infer_config
     "line_dash",  # renamed to line.dash in infer_config
+    "pattern_shape",  # renamed to marker.pattern.shape in infer_config
 ]
 all_attrables = (
     direct_attrables + array_attrables + group_attrables + renameable_group_attrables
@@ -51,6 +52,8 @@ class PxDefaults(object):
         "symbol_map",
         "line_dash_sequence",
         "line_dash_map",
+        "pattern_shape_sequence",
+        "pattern_shape_map",
         "size_max",
         "category_orders",
         "labels",
@@ -70,6 +73,8 @@ def reset(self):
         self.symbol_map = {}
         self.line_dash_sequence = None
         self.line_dash_map = {}
+        self.pattern_shape_sequence = None
+        self.pattern_shape_map = {}
         self.size_max = 20
         self.category_orders = {}
         self.labels = {}
@@ -206,14 +211,17 @@ def make_mapping(args, variable):
             updater=(lambda trace, v: v),
             facet="row" if variable == "facet_row" else "col",
         )
-    (parent, variable) = variable.split(".")
+    (parent, variable, *other_variables) = variable.split(".")
     vprefix = variable
     arg_name = variable
     if variable == "color":
         vprefix = "color_discrete"
     if variable == "dash":
         arg_name = "line_dash"
         vprefix = "line_dash"
+    if variable == "pattern":
+        arg_name = "pattern_shape"
+        vprefix = "pattern_shape"
     if args[vprefix + "_map"] == "identity":
         val_map = IdentityMap()
     else:
@@ -224,7 +232,9 @@ def make_mapping(args, variable):
         grouper=args[arg_name],
         val_map=val_map,
         sequence=args[vprefix + "_sequence"],
-        updater=lambda trace, v: trace.update({parent: {variable: v}}),
+        updater=lambda trace, v: trace.update(
+            {parent: {".".join([variable] + other_variables): v}}
+        ),
         facet=None,
     )
 
@@ -952,6 +962,16 @@ def apply_default_cascade(args):
                 "longdashdot",
             ]
 
+    if "pattern_shape_sequence" in args:
+        if args["pattern_shape_sequence"] is None and args["template"].data.bar:
+            args["pattern_shape_sequence"] = [
+                bar.marker.pattern.shape for bar in args["template"].data.bar
+            ]
+        if not args["pattern_shape_sequence"] or not any(
+            args["pattern_shape_sequence"]
+        ):
+            args["pattern_shape_sequence"] = ["", "/", "\\", "x", "+", "."]
+
 
 def _check_name_not_reserved(field_name, reserved_names):
     if field_name not in reserved_names:
@@ -1691,14 +1711,15 @@ def infer_config(args, constructor, trace_patch, layout_patch):
     else:
         show_colorbar = False
 
-    # Compute line_dash grouping attribute
     if "line_dash" in args:
         grouped_attrs.append("line.dash")
 
-    # Compute symbol grouping attribute
     if "symbol" in args:
         grouped_attrs.append("marker.symbol")
 
+    if "pattern_shape" in args:
+        grouped_attrs.append("marker.pattern.shape")
+
     if "orientation" in args:
         has_x = args["x"] is not None
         has_y = args["y"] is not None
@@ -1949,8 +1970,14 @@ def make_figure(args, constructor, trace_patch=None, layout_patch=None):
                     # this catches some odd cases like marginals
                     if (
                         trace_spec != trace_specs[0]
-                        and trace_spec.constructor in [go.Violin, go.Box, go.Histogram]
-                        and m.variable == "symbol"
+                        and (
+                            trace_spec.constructor in [go.Violin, go.Box]
+                            and m.variable in ["symbol", "pattern"]
+                        )
+                        or (
+                            trace_spec.constructor in [go.Histogram]
+                            and m.variable in ["symbol"]
+                        )
                     ):
                         pass
                     elif (

packages/python/plotly/plotly/express/_doc.py

@@ -182,6 +182,11 @@
         colref_desc,
         "Values from this column or array_like are used to assign symbols to marks.",
     ],
+    pattern_shape=[
+        colref_type,
+        colref_desc,
+        "Values from this column or array_like are used to assign pattern shapes to marks.",
+    ],
     size=[
         colref_type,
         colref_desc,
@@ -283,6 +288,18 @@
         "Strings should define valid plotly.js dash-patterns.",
         "When `line_dash` is set, values in that column are assigned dash-patterns by cycling through `line_dash_sequence` in the order described in `category_orders`, unless the value of `line_dash` is a key in `line_dash_map`.",
     ],
+    pattern_shape_map=[
+        "dict with str keys and str values (default `{}`)",
+        "Strings values define plotly.js patterns-shapes.",
+        "Used to override `pattern_shape_sequences` to assign a specific patterns-shapes to lines corresponding with specific values.",
+        "Keys in `pattern_shape_map` should be values in the column denoted by `pattern_shape`.",
+        "Alternatively, if the values of `pattern_shape` are valid patterns-shapes names, the string `'identity'` may be passed to cause them to be used directly.",
+    ],
+    pattern_shape_sequence=[
+        "list of str",
+        "Strings should define valid plotly.js patterns-shapes.",
+        "When `pattern_shape` is set, values in that column are assigned patterns-shapes by cycling through `pattern_shape_sequence` in the order described in `category_orders`, unless the value of `pattern_shape` is a key in `pattern_shape_map`.",
+    ],
     color_discrete_sequence=[
         "list of str",
         "Strings should define valid CSS-colors.",