Changed scatter attribute fillgradient.orientation to fillgradient.ty…

…pe for greater consistency with marker.gradient.type
plotly · archmoj · Mar 6, 2024 · Nov 27, 2023 · Feb 24, 2024 · Feb 27, 2024
commit 4c56fa819241ba5561e8bcdb985de80d0373f5f0
diff --git a/src/components/drawing/index.js b/src/components/drawing/index.js
@@ -193,8 +193,8 @@ function setFillStyle(sel, trace, gd, forLegend) {
             undefined, markerPattern.fillmode,
             patternBGColor, patternFGColor, patternFGOpacity
         );
-    } else if(fillgradient && fillgradient.orientation !== 'none') {
-        var direction = fillgradient.orientation;
+    } else if(fillgradient && fillgradient.type !== 'none') {
+        var direction = fillgradient.type;
         var gradientID = 'scatterfill-' + trace.uid;
         if(forLegend) {
             gradientID = 'legendfill-' + trace.uid;

diff --git a/src/traces/scatter/attributes.js b/src/traces/scatter/attributes.js
@@ -404,13 +404,13 @@ module.exports = {
         ].join(' ')
     },
     fillgradient: extendFlat({
-        orientation: {
+        type: {
             valType: 'enumerated',
             values: ['radial', 'horizontal', 'vertical', 'none'],
             dflt: 'none',
-            editType: 'style',
+            editType: 'calc',
             description: [
-                'Sets the orientation of the color gradient.',
+                'Sets the type/orientation of the color gradient for the fill.',
                 'Defaults to *none*.'
             ].join(' ')
         },

diff --git a/src/traces/scatter/fillcolor_defaults.js b/src/traces/scatter/fillcolor_defaults.js
@@ -33,7 +33,7 @@ module.exports = function fillColorDefaults(traceIn, traceOut, defaultColor, coe
         // to specifiy fillcolor after all other more specific candidates
         // are considered, but before the global default color.
         // fillcolor affects the background color of the hoverlabel in this case.
-        var gradientOrientation = coerce('fillgradient.orientation');
+        var gradientOrientation = coerce('fillgradient.type');
         if(gradientOrientation !== 'none') {
             coerce('fillgradient.start');
             coerce('fillgradient.stop');

diff --git a/test/image/mocks/zz-scatter_fill_gradient_tonext.json b/test/image/mocks/zz-scatter_fill_gradient_tonext.json
@@ -8,7 +8,7 @@
             "fill": "tonext",
             "hoveron": "points+fills",
             "fillgradient": {
-                "orientation": "horizontal",
+                "type": "horizontal",
                 "colorscale": [
                     [0.0, "rgba(0, 255, 0, 1)"],
                     [0.5, "rgba(0, 255, 0, 0)"],
@@ -24,7 +24,7 @@
             "fill": "tonext",
             "hoveron": "fills+points",
                 "fillgradient": {
-                "orientation": "radial",
+                "type": "radial",
                 "colorscale": [
                     [0.0, "rgba(255, 255, 0, 0.0)"],
                     [0.8, "rgba(255, 0, 0, 0.3)"],

diff --git a/test/image/mocks/zz-scatter_fill_gradient_tonexty_toself.json b/test/image/mocks/zz-scatter_fill_gradient_tonexty_toself.json
@@ -8,7 +8,7 @@
             "fill": "tonexty",
             "fillcolor": "rgba(0, 255, 0, .5)",
             "fillgradient": {
-                "orientation": "horizontal",
+                "type": "horizontal",
                 "colorscale": [
                     [0.0, "rgba(0, 255, 0, 1)"],
                     [0.5, "rgba(0, 255, 0, 0)"],
@@ -28,7 +28,7 @@
             "fill": "tonexty",
             "hoveron": "fills+points",
             "fillgradient": {
-                "orientation": "horizontal",
+                "type": "horizontal",
                 "colorscale": [
                     [0.0, "rgba(255, 255, 0, 1.0)"],
                     [0.6, "rgba(255, 255, 0, 1.0)"],
@@ -44,7 +44,7 @@
             "mode": "none",
             "fill": "toself",
             "fillgradient": {
-                "orientation": "vertical",
+                "type": "vertical",
                 "colorscale": [
                     [0.0, "rgba(255, 0, 0, 0.8)"],
                     [1.0, "rgba(0, 0, 255, 0.9)"]
@@ -60,7 +60,7 @@
             "mode": "none",
             "fill": "toself",
             "fillgradient": {
-                "orientation": "vertical",
+                "type": "vertical",
                 "colorscale": [
                     [0.0, "rgba(255, 0, 0, 0.8)"],
                     [1.0, "rgba(0, 0, 255, 0.9)"]

diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -45041,25 +45041,12 @@
     },
     "fillgradient": {
      "colorscale": {
-      "anim": true,
       "description": "Sets the fill gradient colors as a color scale. The color scale is interpreted as a gradient applied in the direction specified by *orientation*, from the lowest to the highest value of the scatter plot along that axis, or from the center to the most distant point from it, if orientation is *radial*.",
       "editType": "style",
       "valType": "colorscale"
      },
      "description": "Sets a fill gradient. If not specified, the fillcolor is used instead.",
-     "editType": "style",
-     "orientation": {
-      "description": "Sets the orientation of the color gradient. Defaults to *none*.",
-      "dflt": "none",
-      "editType": "style",
-      "valType": "enumerated",
-      "values": [
-       "radial",
-       "horizontal",
-       "vertical",
-       "none"
-      ]
-     },
+     "editType": "calc",
      "role": "object",
      "start": {
       "description": "Sets the gradient start value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is *horizontal*, the gradient will be horizontal and start from the x-position given by start. If omitted, the gradient starts at the lowest value of the trace along the respective axis. Ignored if orientation is *radial*.",
@@ -45070,6 +45057,18 @@
       "description": "Sets the gradient end value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is *horizontal*, the gradient will be horizontal and end at the x-position given by end. If omitted, the gradient ends at the highest value of the trace along the respective axis. Ignored if orientation is *radial*.",
       "editType": "calc",
       "valType": "number"
+     },
+     "type": {
+      "description": "Sets the type/orientation of the color gradient for the fill. Defaults to *none*.",
+      "dflt": "none",
+      "editType": "calc",
+      "valType": "enumerated",
+      "values": [
+       "radial",
+       "horizontal",
+       "vertical",
+       "none"
+      ]
      }
     },
     "fillpattern": {