px.density_mapbox

Author: nicolaskruchten

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

@@ -4,6 +4,7 @@
 """
 from __future__ import absolute_import
 from plotly import optional_imports
+from ._imshow import imshow
 
 pd = optional_imports.get_module("pandas")
 if pd is None:
@@ -12,7 +13,6 @@
 Plotly express requires pandas to be installed."""
     )
 
-
 from ._chart_types import (  # noqa: F401
     scatter,
     scatter_3d,
@@ -45,9 +45,9 @@
     funnel,
     funnel_area,
     choropleth_mapbox,
+    density_mapbox,
 )
 
-from ._imshow import imshow
 
 from ._core import (  # noqa: F401
     set_mapbox_access_token,
@@ -67,6 +67,7 @@
     "scatter_matrix",
     "density_contour",
     "density_heatmap",
+    "density_mapbox",
     "line",
     "line_3d",
     "line_polar",

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

@@ -1032,6 +1032,41 @@ def choropleth_mapbox(
 choropleth_mapbox.__doc__ = make_docstring(choropleth_mapbox)
 
 
+def density_mapbox(
+    data_frame=None,
+    lat=None,
+    lon=None,
+    z=None,
+    hover_name=None,
+    hover_data=None,
+    custom_data=None,
+    animation_frame=None,
+    animation_group=None,
+    category_orders={},
+    labels={},
+    color_continuous_scale=None,
+    range_color=None,
+    color_continuous_midpoint=None,
+    opacity=None,
+    zoom=8,
+    radius=None,
+    title=None,
+    template=None,
+    width=None,
+    height=None,
+):
+    """
+    In a Mapbox density map, each row of `data_frame` contributes to the intensity of
+    the color of the region around the corresponding point on the map
+    """
+    return make_figure(
+        args=locals(), constructor=go.Densitymapbox, trace_patch=dict(radius=radius)
+    )
+
+
+density_mapbox.__doc__ = make_docstring(density_mapbox)
+
+
 def line_mapbox(
     data_frame=None,
     lat=None,

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

@@ -381,6 +381,7 @@ def configure_axes(args, constructor, fig, orders):
         go.Barpolar: configure_polar_axes,
         go.Scattermapbox: configure_mapbox,
         go.Choroplethmapbox: configure_mapbox,
+        go.Densitymapbox: configure_mapbox,
         go.Scattergeo: configure_geo,
         go.Choropleth: configure_geo,
     }
@@ -571,7 +572,7 @@ def configure_mapbox(args, fig, orders):
                     lat=args["data_frame"][args["lat"]].mean(),
                     lon=args["data_frame"][args["lon"]].mean(),
                 )
-                if "lat" in args and "lon" in  args
+                if "lat" in args and "lon" in args
                 else dict(),
                 zoom=args["zoom"],
             )
@@ -1012,7 +1013,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"]
-        + ["names", "values", "parents", "ids"]
+        + ["names", "values", "parents", "ids", "radius"]
         + ["error_x", "error_x_minus"]
         + ["error_y", "error_y_minus", "error_z", "error_z_minus"]
         + ["lat", "lon", "locations", "animation_group"]
@@ -1086,7 +1087,7 @@ def infer_config(args, constructor, trace_patch):
     # Compute final trace patch
     trace_patch = trace_patch.copy()
 
-    if constructor == go.Histogram2d:
+    if constructor in [go.Histogram2d, go.Densitymapbox]:
         show_colorbar = True
         trace_patch["coloraxis"] = "coloraxis1"
 
@@ -1225,6 +1226,7 @@ def make_figure(args, constructor, trace_patch={}, layout_patch={}):
                 go.Parcoords,
                 go.Choropleth,
                 go.Choroplethmapbox,
+                go.Densitymapbox,
                 go.Histogram2d,
                 go.Sunburst,
                 go.Treemap,
@@ -1325,7 +1327,7 @@ def make_figure(args, constructor, trace_patch={}, layout_patch={}):
         )
     layout_patch = layout_patch.copy()
     if show_colorbar:
-        colorvar = "z" if constructor == go.Histogram2d else "color"
+        colorvar = "z" if constructor in [go.Histogram2d, go.Densitymapbox] else "color"
         range_color = args["range_color"] or [None, None]
 
         colorscale_validator = ColorscaleValidator("colorscale", "make_figure")

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

@@ -164,6 +164,11 @@
         colref_desc,
         "Values from this column or array_like are used to assign mark sizes.",
     ],
+    radius=[
+        colref_type,
+        colref_desc,
+        "Values from this column or array_like are used to set the radius of influence of each point.",
+    ],
     hover_name=[
         colref_type,
         colref_desc,