labels and names

Author: emmanuelle

packages/python/plotly/plotly/express/__init__.py

@@ -41,6 +41,7 @@
     density_heatmap,
     pie,
     sunburst,
+    treemap,
     funnel,
     funnel_area,
 )
@@ -83,7 +84,10 @@
     "choropleth",
     "pie",
     "sunburst",
-    "funnel" "funnel_area" "imshow",
+    "treemap",
+    "funnel",
+    "funnel_area",
+    "imshow",
     "data",
     "colors",
     "set_mapbox_access_token",

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

@@ -1119,8 +1119,9 @@ def parallel_categories(
 
 def pie(
     data_frame=None,
-    text=None,
+    names=None,
     values=None,
+    textinfo=None,
     hover_name=None,
     hover_data=None,
     custom_data=None,
@@ -1130,19 +1131,35 @@ def pie(
     width=None,
     height=None,
     opacity=None,
+    hole=None,
 ):
     """
     In a pie plot, each row of `data_frame` is represented as a sector of a pie.
     """
-    return make_figure(args=locals(), constructor=go.Pie,)
+    return make_figure(
+        args=locals(),
+        constructor=go.Pie,
+        trace_patch=dict(showlegend=True, hole=hole)
+                        )
 
 
-pie.__doc__ = make_docstring(pie)
+pie.__doc__ = make_docstring(pie,
+        override_dict=dict(
+        textinfo=[
+            "str",
+            "Determines which trace information appear on the graph.",
+        ],
+        hole=[
+            "float",
+            "Sets the fraction of the radius to cut out of the pie."
+            "Use this to make a donut chart."
+            ],
+    ),)
 
 
 def sunburst(
     data_frame=None,
-    text=None,
+    names=None,
     values=None,
     parents=None,
     ids=None,
@@ -1158,7 +1175,8 @@ def sunburst(
     maxdepth=None,
 ):
     """
-    In a pie plot, each row of `data_frame` is represented as a sector of a pie.
+    A sunburst plot represents hierarchial data as sectors laid out over
+    several levels of concentric rings.
     """
     return make_figure(
         args=locals(),
@@ -1170,6 +1188,36 @@ def sunburst(
 sunburst.__doc__ = make_docstring(sunburst)
 
 
+def treemap(
+    data_frame=None,
+    names=None,
+    values=None,
+    parents=None,
+    ids=None,
+    hover_name=None,
+    hover_data=None,
+    custom_data=None,
+    labels={},
+    title=None,
+    template=None,
+    width=None,
+    height=None,
+    branchvalues=None,
+    maxdepth=None,
+):
+    """
+    A treemap plot represents hierarchial data as nested rectangular sectors. 
+    """
+    return make_figure(
+        args=locals(),
+        constructor=go.Treemap,
+        trace_patch=dict(branchvalues=branchvalues, maxdepth=maxdepth),
+    )
+
+
+treemap.__doc__ = make_docstring(treemap)
+
+
 def funnel(
     data_frame=None,
     x=None,
@@ -1213,7 +1261,7 @@ def funnel(
 def funnel_area(
     data_frame=None,
     values=None,
-    text=None,
+    names=None,
     textinfo=None,
     hover_name=None,
     hover_data=None,

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

@@ -307,16 +307,21 @@ def make_trace_kwargs(args, trace_spec, g, mapping_labels, sizeref):
                 mapping_labels[v_label] = "%{location}"
             elif k == "values":
                 result[k] = g[v]
-                mapping_labels["value"] = "%{value}"
+                _label = "value" if v_label == 'values' else v_label
+                mapping_labels[_label] = "%{value}"
             elif k == "parents":
                 result[k] = g[v]
-                mapping_labels["parent"] = "%{parent}"
+                _label = "parent" if v_label == 'parents' else v_label
+                mapping_labels[_label] = "%{parent}"
             elif k == "ids":
                 result[k] = g[v]
-                mapping_labels["id"] = "%{id}"
-            elif k == "text":
-                if trace_spec.constructor in [go.Sunburst, go.Treemap]:
+                _label = "id" if v_label == 'ids' else v_label
+                mapping_labels[_label] = "%{id}"
+            elif k == "names":
+                if trace_spec.constructor in [go.Sunburst, go.Treemap, go.Pie, go.Funnelarea]:
                     result["labels"] = g[v]
+                    _label = "label" if v_label == 'names' else v_label
+                    mapping_labels[_label] = "%{label}"
                 else:
                     result[k] = g[v]
             else:
@@ -975,7 +980,7 @@ def infer_config(args, constructor, trace_patch):
     attrables = (
         ["x", "y", "z", "a", "b", "c", "r", "theta", "size", "dimensions"]
         + ["custom_data", "hover_name", "hover_data", "text"]
-        + ["values", "parents", "ids"]
+        + ["names", "values", "parents", "ids"]
         + ["error_x", "error_x_minus"]
         + ["error_y", "error_y_minus", "error_z", "error_z_minus"]
         + ["lat", "lon", "locations", "animation_group"]
@@ -1171,6 +1176,7 @@ def make_figure(args, constructor, trace_patch={}, layout_patch={}):
                 go.Choropleth,
                 go.Histogram2d,
                 go.Sunburst,
+                go.Treemap,
             ]:
                 trace.update(
                     legendgroup=trace_name,

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

@@ -183,6 +183,12 @@
         colref_desc,
         "Values from this column or array_like appear in the figure as text labels.",
     ],
+    names=[
+        colref_type,
+        colref_desc,
+        "Values from this column or array_like are used as labels for sectors.",
+    ],
+
     locationmode=[
         "str",
         "One of 'ISO-3', 'USA-states', or 'country names'",