adjustments to bring object role only

plotly · archmoj · Jan 22, 2021 · Jan 22, 2021 · Jan 22, 2021 · Jan 22, 2021
commit 4efc5aec1f166ebf5afb09ba9a45d5281a3cef37
diff --git a/src/components/colorbar/attributes.js b/src/components/colorbar/attributes.js
@@ -18,7 +18,6 @@ module.exports = overrideAll({
 // TODO: only right is supported currently
 //     orient: {
 //         valType: 'enumerated',
-//         role: 'info',
 //         values: ['left', 'right', 'top', 'bottom'],
 //         dflt: 'right',
 //         description: [

diff --git a/src/plot_api/plot_schema.js b/src/plot_api/plot_schema.js
@@ -621,13 +621,8 @@ function mergeValTypeAndRole(attrs) {
 
     function callback(attr, attrName, attrs) {
         if(exports.isValObject(attr)) {
-            if(attr.valType === 'data_array') {
-                // all 'data_array' attrs have role 'data'
-                attr.role = 'data';
-                // all 'data_array' attrs have a corresponding 'src' attr
-                attrs[attrName + 'src'] = makeSrcAttr(attrName);
-            } else if(attr.arrayOk === true) {
-                // all 'arrayOk' attrs have a corresponding 'src' attr
+            if(attr.arrayOk === true || attr.valType === 'data_array') {
+                // all 'arrayOk' and 'data_array' attrs have a corresponding 'src' attr
                 attrs[attrName + 'src'] = makeSrcAttr(attrName);
             }
         } else if(isPlainObject(attr)) {

diff --git a/src/traces/barpolar/attributes.js b/src/traces/barpolar/attributes.js
@@ -24,7 +24,6 @@ module.exports = {
 
     // orientation: {
     //     valType: 'enumerated',
-    //     role: 'info',
     //     values: ['radial', 'angular'],
     //     editType: 'calc+clearAxisTypes',
     //     description: 'Sets the orientation of the bars.'

diff --git a/src/traces/streamtube/attributes.js b/src/traces/streamtube/attributes.js
@@ -95,7 +95,6 @@ var attrs = {
     //     valType: 'enumerated',
     //     values: ['scaled', 'absolute', 'fixed'],
     //     dflt: 'scaled',
-    //     role: 'info',
     //     editType: 'calc',
     //     description: [
     //         'Sets the mode by which the streamtubes are sized.'

diff --git a/tasks/compress_attributes.js b/tasks/compress_attributes.js
@@ -48,6 +48,7 @@ module.exports = function() {
                 .replace(makeJoinedArrayRegex('description'), '')
                 .replace(makeArrayRegex('requiredOpts'), '')
                 .replace(makeArrayRegex('otherOpts'), '')
+                .replace(makeStringRegex('role'), '')
                 .replace(makeStringRegex('hrName'), '')
         );
         done();

diff --git a/test/jasmine/bundle_tests/plotschema_test.js b/test/jasmine/bundle_tests/plotschema_test.js
@@ -25,7 +25,7 @@ describe('plot schema', function() {
     var isPlainObject = Lib.isPlainObject;
 
     var VALTYPES = Object.keys(valObjects);
-    var ROLES = ['info', 'style', 'data'];
+    var deprecatedRoles = ['info', 'style', 'data'];
     var editType = plotSchema.defs.editType;
 
     function assertTraceSchema(callback) {
@@ -73,11 +73,11 @@ describe('plot schema', function() {
         );
     });
 
-    it('all attributes should only have valid `role`', function() {
+    it('all attributes should not have valid a deprecated `role`', function() {
         assertPlotSchema(
             function(attr) {
                 if(isValObject(attr)) {
-                    expect(ROLES.indexOf(attr.role) !== -1).toBe(true, attr);
+                    expect(deprecatedRoles.indexOf(attr.role) === -1).toBe(true, attr);
                 }
             }
         );
@@ -223,7 +223,7 @@ describe('plot schema', function() {
         );
     });
 
-    it('deprecated attributes should have a `valType` and `role`', function() {
+    it('deprecated attributes should have a `valType` and not any deprecated roles', function() {
         var DEPRECATED = '_deprecated';
 
         assertPlotSchema(
@@ -234,7 +234,7 @@ describe('plot schema', function() {
 
                         expect(VALTYPES.indexOf(dAttr.valType) !== -1)
                             .toBe(true, attrString + ': ' + dAttrName);
-                        expect(ROLES.indexOf(dAttr.role) !== -1)
+                        expect(deprecatedRoles.indexOf(dAttr.role) === -1)
                             .toBe(true, attrString + ': ' + dAttrName);
                     });
                 }

diff --git a/test/jasmine/tests/plot_api_test.js b/test/jasmine/tests/plot_api_test.js
@@ -2877,8 +2877,7 @@ describe('plot_api edit_types', function() {
 
         editTypes.update(flags, {
             valType: 'boolean',
-            dflt: true,
-            role: 'style'
+            dflt: true
         });
 
         expect(flags).toEqual({calc: false, style: true});
@@ -2898,8 +2897,7 @@ describe('plot_api edit_types', function() {
         editTypes.update(flags, {
             editType: 'calc+style',
             valType: 'number',
-            dflt: 1,
-            role: 'style'
+            dflt: 1
         });
 
         expect(flags).toEqual({calc: true, legend: true, style: true});