Merge pull request #1886 from plotly/swatch_templates

apply defaults cascade to swatches()

Author: nicolaskruchten

packages/python/plotly/_plotly_utils/colors/__init__.py

@@ -797,3 +797,12 @@ def convert_colorscale_to_rgb(colorscale):
     for color in colorscale:
         color[1] = label_rgb(color[1])
     return colorscale
+
+
+def named_colorscales():
+    """
+    Returns lowercased names of built-in continuous colorscales.
+    """
+    from _plotly_utils.basevalidators import ColorscaleValidator
+
+    return [c for c in ColorscaleValidator("", "").named_colorscales]

packages/python/plotly/_plotly_utils/colors/_swatches.py

@@ -1,10 +1,21 @@
-def _swatches(module_names, module_contents):
+def _swatches(module_names, module_contents, template=None):
     """
-    Returns:
+    Parameters
+    ----------
+    template : str or dict or plotly.graph_objects.layout.Template instance
+        The figure template name or definition.
+
+    Returns
+    -------
+    fig : graph_objects.Figure containing the displayed image
         A `Figure` object. This figure demonstrates the color scales and
         sequences in this module, as stacked bar charts.
     """
     import plotly.graph_objs as go
+    from plotly.express._core import apply_default_cascade
+
+    args = dict(template=template)
+    apply_default_cascade(args)
 
     sequences = [
         (k, v)
@@ -25,13 +36,13 @@ def _swatches(module_names, module_contents):
             for name, colors in reversed(sequences)
         ],
         layout=dict(
-            title=module_names,
+            title="plotly.colors." + module_names.split(".")[-1],
             barmode="stack",
             barnorm="fraction",
-            template="plotly",
             bargap=0.5,
             showlegend=False,
             xaxis=dict(range=[-0.02, 1.02], showticklabels=False, showgrid=False),
             height=max(600, 40 * len(sequences)),
+            template=args["template"],
         ),
     )

packages/python/plotly/_plotly_utils/colors/carto.py

@@ -9,8 +9,8 @@
 from ._swatches import _swatches
 
 
-def swatches():
-    return _swatches(__name__, globals())
+def swatches(template=None):
+    return _swatches(__name__, globals(), template)
 
 
 swatches.__doc__ = _swatches.__doc__

packages/python/plotly/_plotly_utils/colors/cmocean.py

@@ -9,8 +9,8 @@
 from ._swatches import _swatches
 
 
-def swatches():
-    return _swatches(__name__, globals())
+def swatches(template=None):
+    return _swatches(__name__, globals(), template)
 
 
 swatches.__doc__ = _swatches.__doc__

packages/python/plotly/_plotly_utils/colors/colorbrewer.py

@@ -9,8 +9,8 @@
 from ._swatches import _swatches
 
 
-def swatches():
-    return _swatches(__name__, globals())
+def swatches(template=None):
+    return _swatches(__name__, globals(), template)
 
 
 swatches.__doc__ = _swatches.__doc__

packages/python/plotly/_plotly_utils/colors/cyclical.py

@@ -7,8 +7,8 @@
 from ._swatches import _swatches
 
 
-def swatches():
-    return _swatches(__name__, globals())
+def swatches(template=None):
+    return _swatches(__name__, globals(), template)
 
 
 swatches.__doc__ = _swatches.__doc__

packages/python/plotly/_plotly_utils/colors/diverging.py

@@ -25,8 +25,8 @@
 from ._swatches import _swatches
 
 
-def swatches():
-    return _swatches(__name__, globals())
+def swatches(template=None):
+    return _swatches(__name__, globals(), template)
 
 
 swatches.__doc__ = _swatches.__doc__

packages/python/plotly/_plotly_utils/colors/qualitative.py

@@ -7,8 +7,8 @@
 from ._swatches import _swatches
 
 
-def swatches():
-    return _swatches(__name__, globals())
+def swatches(template=None):
+    return _swatches(__name__, globals(), template)
 
 
 swatches.__doc__ = _swatches.__doc__

packages/python/plotly/_plotly_utils/colors/sequential.py

@@ -8,8 +8,8 @@
 from ._swatches import _swatches
 
 
-def swatches():
-    return _swatches(__name__, globals())
+def swatches(template=None):
+    return _swatches(__name__, globals(), template)
 
 
 swatches.__doc__ = _swatches.__doc__