Keep auto textposition in cleanData only for trace types that accept it

Author: camdecoster

src/plot_api/helpers.js

@@ -205,11 +205,12 @@ exports.cleanData = function (data) {
 
         if (!traceIs(trace, 'pie-like') && !traceIs(trace, 'bar-like')) {
             if (Array.isArray(trace.textposition)) {
+                const keepAuto = acceptsAutoTextPosition(trace);
                 for (i = 0; i < trace.textposition.length; i++) {
-                    trace.textposition[i] = cleanTextPosition(trace.textposition[i]);
+                    trace.textposition[i] = cleanTextPosition(trace.textposition[i], keepAuto);
                 }
             } else if (trace.textposition) {
-                trace.textposition = cleanTextPosition(trace.textposition);
+                trace.textposition = cleanTextPosition(trace.textposition, acceptsAutoTextPosition(trace));
             }
         }
 
@@ -321,10 +322,16 @@ function commonPrefix(name1, name2, show1, show2) {
     return out.trim();
 }
 
+// Only some trace types accept *auto*, so the others clean it like any other incorrect value
+function acceptsAutoTextPosition(trace) {
+    const values = Registry.getModule(trace.type || 'scatter')?.attributes?.textposition?.values;
+    return Array.isArray(values) && values.includes('auto');
+}
+
 // textposition - support partial attributes (ie just 'top')
 // and incorrect use of middle / center etc.
-function cleanTextPosition(textposition) {
-    if (textposition === 'auto') return textposition;
+function cleanTextPosition(textposition, keepAuto) {
+    if (keepAuto && textposition === 'auto') return textposition;
 
     var posY = 'middle';
     var posX = 'center';

test/jasmine/tests/plot_api_test.js

@@ -2569,20 +2569,19 @@ describe('Test plot api', function () {
             expect(gd.data[0].scl).toBe(undefined);
         });
 
-        it('should keep *auto* textposition on scatter traces', function () {
-            var data = [
-                {
-                    type: 'scatter',
-                    mode: 'text',
-                    x: [1],
-                    y: [1],
-                    text: ['a'],
-                    textposition: 'auto'
-                }
+        it('should keep *auto* textposition only on trace types that accept it', () => {
+            const data = [
+                { type: 'scatter', mode: 'text', x: [1], y: [1], text: ['a'], textposition: 'auto' },
+                { type: 'scatter', mode: 'text', x: [1], y: [1], text: ['a'], textposition: ['auto', 'top'] },
+                { type: 'scattergl', mode: 'text', x: [1], y: [1], text: ['a'], textposition: 'auto' },
+                { type: 'scattergl', mode: 'text', x: [1], y: [1], text: ['a'], textposition: ['auto', 'top'] }
             ];
 
-            Plotly.newPlot(gd, data);
-            expect(gd.data[0].textposition).toBe('auto');
+            helpers.cleanData(data);
+            expect(data[0].textposition).toBe('auto');
+            expect(data[1].textposition).toEqual(['auto', 'top center']);
+            expect(data[2].textposition).toBe('middle center');
+            expect(data[3].textposition).toEqual(['middle center', 'top center']);
         });
 
         it("should not delete rename 'scl' to 'colorscale' when colorscale is defined ", function () {