area plots

Author: nicolaskruchten

gallery.md

@@ -115,6 +115,10 @@ px.line(gapminder, x="year", y="lifeExp", color="continent", line_group="country
         line_shape="spline")
 ```
 
+```python
+px.area(gapminder, x="year", y="pop", color="continent", line_group="country")
+```
+
 ## Visualize Distributions
 
 ```python

plotly_express/__init__.py

@@ -18,6 +18,7 @@
     line_ternary,
     line_mapbox,
     line_geo,
+    area,
     bar,
     bar_polar,
     violin,
@@ -50,6 +51,7 @@
     "line_geo",
     "parallel_coordinates",
     "parallel_categories",
+    "area",
     "bar",
     "bar_polar",
     "violin",

plotly_express/_chart_types.py

@@ -150,6 +150,51 @@ def line(
 line.__doc__ = make_docstring(line)
 
 
+def area(
+    data_frame,
+    x=None,
+    y=None,
+    line_group=None,
+    color=None,
+    hover_name=None,
+    hover_data=None,
+    text=None,
+    facet_row=None,
+    facet_col=None,
+    animation_frame=None,
+    animation_group=None,
+    category_orders={},
+    labels={},
+    color_discrete_sequence=default_qualitative,
+    color_discrete_map={},
+    orientation="v",
+    groupnorm=None,
+    log_x=False,
+    log_y=False,
+    range_x=None,
+    range_y=None,
+    line_shape=None,
+    render_mode="auto",
+    title=None,
+    template=default_template,
+    width=default_width,
+    height=default_height,
+):
+    """
+    In a stacked area plot, each row of `data_frame` is represented as vertex of a polyline mark in 2D space. The area between successive polylines is filled.
+    """
+    return make_figure(
+        args=locals(),
+        constructor=go.Scatter,
+        trace_patch=dict(
+            stackgroup=1, mode="lines", orientation=orientation, groupnorm=groupnorm
+        ),
+    )
+
+
+area.__doc__ = make_docstring(area)
+
+
 def bar(
     data_frame,
     x=None,

plotly_express/_core.py

@@ -579,10 +579,8 @@ def infer_config(args, constructor, trace_patch):
         + ["lat", "lon", "locations", "animation_group"]
     )
 
-    groupables = ["animation_frame", "facet_row", "facet_col", "line_group"]
-
     attrs = [k for k in attrables if k in args]
-    grouped_attrs = [k for k in groupables if k in args]
+    grouped_attrs = []
 
     sizeref = 0
     if "size" in args and args["size"]:
@@ -647,6 +645,10 @@ def infer_config(args, constructor, trace_patch):
         args[position] = args["marginal"]
         args[other_position] = None
 
+    for k in ["animation_frame", "facet_row", "facet_col", "line_group"]:
+        if k in args:
+            grouped_attrs.append(k)
+
     grouped_mappings = [make_mapping(args, a) for a in grouped_attrs]
     trace_specs = make_trace_spec(args, constructor, attrs, trace_patch)
     return trace_specs, grouped_mappings, sizeref, color_range

plotly_express/_doc.py

@@ -267,6 +267,11 @@
         "If set to `'fraction'`, the value of each bar is divided by the sum of all values at that location coordinate.",
         "`'percent'` is the same but multiplied by 100 to show percentages.",
     ],
+    groupnorm=[
+        "(string, one of `'fraction'` or `'percent'`, default is `None`)",
+        "If set to `'fraction'`, the value of each point is divided by the sum of all values at that location coordinate.",
+        "`'percent'` is the same but multiplied by 100 to show percentages.",
+    ],
     barmode=[
         "(string, one of `'group'`, `'overlay'` or `'relative'`. Default is `'relative'`)",
         "In `'relative'` mode, bars are stacked above zero for positive values and below zero for negative values.",
@@ -284,7 +289,10 @@
         "In `'group'` mode, violins are placed beside each other.",
     ],
     zoom=["(integer between 0 and 20, default is 8)", "Sets map zoom level."],
-    orientation=["(string, one of `'h'` or `'v'`)", "Default is `'v'`."],
+    orientation=[
+        "(string, one of `'h'` for horizontal or `'v' for vertical`)",
+        "Default is `'v'`.",
+    ],
     line_close=[
         "(boolean, default `False`)",
         "If `True`, an extra line segment is drawn between the first and last point.",