Merge pull request #3956 from plotly/plotschema-polishing

Some plot-schema polishing

Author: etpinard

shelly/plotlyjs/static/plotlyjs/src/axes.js

@@ -319,7 +319,7 @@ axes.layoutAttributes = {
         role: 'style',
         description: [
             'Determines whether or not a line bounding this axis is drawn.'
-        ]
+        ].join(' ')
     },
     linecolor: {
         valType: 'color',

shelly/plotlyjs/static/plotlyjs/src/colorbar.js

@@ -351,7 +351,7 @@ var colorbar = module.exports = function(td, id) {
 
             cbAxisOut._pos = xLeft+thickPx +
                 (opts.outlinewidth||0)/2 - (opts.ticks==='outside' ? 1 : 0);
-            cbAxisOut.side = opts.orient;
+            cbAxisOut.side = 'right';
 
             return Plotly.Axes.doTicks(td, cbAxisOut);
         }
@@ -525,14 +525,17 @@ var axesAttrs = Plotly.Axes.layoutAttributes,
     extendFlat = Plotly.Lib.extendFlat;
 
 colorbar.attributes = {
-    orient: {
-        // which side are the labels on (so left and right make vertical bars, etc.)
-        // TODO: only right is supported currently
-        valType: 'enumerated',
-        role: 'info',
-        values: ['left', 'right', 'top', 'bottom'],
-        dflt: 'right'
-    },
+// TODO: only right is supported currently
+//     orient: {
+//         valType: 'enumerated',
+//         role: 'info',
+//         values: ['left', 'right', 'top', 'bottom'],
+//         dflt: 'right',
+//         description: [
+//             'Determines which side are the labels on',
+//             '(so left and right make vertical bars, etc.)'
+//         ].join(' ')
+//     },
     thicknessmode: {
         valType: 'enumerated',
         values: ['fraction', 'pixels'],
@@ -688,7 +691,11 @@ colorbar.attributes = {
         valType: 'enumerated',
         values: ['right', 'top', 'bottom'],
         role: 'style',
-        dflt: 'top'
+        dflt: 'top',
+        description: [
+            'Determines the location of the colorbar title',
+            'with respect to the color bar.'
+        ].join(' ')
     }
 };
 
@@ -701,8 +708,6 @@ colorbar.supplyDefaults = function(containerIn, containerOut, layout) {
                                  colorbar.attributes, attr, dflt);
     }
 
-    coerce('orient');
-
     var thicknessmode = coerce('thicknessmode');
     coerce('thickness', thicknessmode === 'fraction' ?
         30 / (layout.width - layout.margin.l - layout.margin.r) :

shelly/plotlyjs/static/plotlyjs/src/plotschema.js

@@ -8,12 +8,12 @@ var extendDeepAll = Plotly.Lib.extendDeepAll;
 
 var NESTED_MODULE = '_nestedModules',
     COMPOSED_MODULE = '_composedModules',
-    IS_SUBPLOT_OBJ = '_isSubplotObj';
+    IS_SUBPLOT_OBJ = '_isSubplotObj',
+    IS_LINKED_TO_ARRAY = '_isLinkedToArray',
+    DEPRECATED = '_deprecated';
 
 // list of underscore attributes to keep in schema as is
-var UNDERSCORE_ATTRS = [
-    '_isLinkedToArray', '_isSubplotObj', '_deprecated'
-];
+var UNDERSCORE_ATTRS = [IS_SUBPLOT_OBJ, IS_LINKED_TO_ARRAY, DEPRECATED];
 
 var plotSchema = {
     traces: {},
@@ -84,7 +84,6 @@ function getTraceAttributes(type) {
     attributes.type = type;
 
     attributes = removeUnderscoreAttrs(attributes);
-
     mergeValTypeAndRole(attributes);
     plotSchema.traces[type] = extendFlat({},
         meta,
@@ -104,7 +103,6 @@ function getTraceAttributes(type) {
 
 function getLayoutAttributes() {
     var globalLayoutAttributes = Plotly.Plots.layoutAttributes,
-        subplotsRegistry = Plotly.Plots.subplotsRegistry,
         layoutAttributes = {};
 
     // layout module attributes (+ nested + composed)
@@ -116,20 +114,14 @@ function getLayoutAttributes() {
     layoutAttributes = assignPolarLayoutAttrs(layoutAttributes);
 
     // add IS_SUBPLOT_OBJ attribute
-    var gl3dRegex = subplotsRegistry.gl3d.attrRegex,
-        geoRegex = subplotsRegistry.geo.attrRegex,
-        xaxisRegex = subplotsRegistry.cartesian.attrRegex.x,
-        yaxisRegex = subplotsRegistry.cartesian.attrRegex.y;
-
-    Object.keys(layoutAttributes).forEach(function(k) {
-        if(gl3dRegex.test(k) || geoRegex.test(k) || xaxisRegex.test(k) || yaxisRegex.test(k)) {
-             layoutAttributes[k][IS_SUBPLOT_OBJ] = true;
-        }
-    });
+    layoutAttributes = handleSubplotObjs(layoutAttributes);
 
     layoutAttributes = removeUnderscoreAttrs(layoutAttributes);
-
     mergeValTypeAndRole(layoutAttributes);
+
+    // generate IS_LINKED_TO_ARRAY structure
+    layoutAttributes = handleLinkedToArray(layoutAttributes);
+
     plotSchema.layout = { layoutAttributes: layoutAttributes };
 }
 
@@ -268,3 +260,38 @@ function getSubplotRegistry(traceType) {
 
     return subplotsRegistry[subplotType];
 }
+
+function handleSubplotObjs(layoutAttributes) {
+    var subplotsRegistry = Plotly.Plots.subplotsRegistry;
+
+    var gl3dRegex = subplotsRegistry.gl3d.attrRegex,
+        geoRegex = subplotsRegistry.geo.attrRegex,
+        xaxisRegex = subplotsRegistry.cartesian.attrRegex.x,
+        yaxisRegex = subplotsRegistry.cartesian.attrRegex.y;
+
+    Object.keys(layoutAttributes).forEach(function(k) {
+        if(gl3dRegex.test(k) || geoRegex.test(k) || xaxisRegex.test(k) || yaxisRegex.test(k)) {
+             layoutAttributes[k][IS_SUBPLOT_OBJ] = true;
+        }
+    });
+
+    return layoutAttributes;
+}
+
+function handleLinkedToArray(layoutAttributes) {
+    Object.keys(layoutAttributes).forEach(function(k) {
+        var attr = extendDeep({}, layoutAttributes[k]);
+
+        if(attr[IS_LINKED_TO_ARRAY] !== true) return;
+
+        var itemName = k.substr(0, k.length-1);  // TODO more robust logic
+
+        delete attr[IS_LINKED_TO_ARRAY];
+
+        layoutAttributes[k] = { items: {} };
+        layoutAttributes[k].items[itemName] = attr;
+        layoutAttributes[k].role = 'object';
+    });
+
+    return layoutAttributes;
+}

shelly/plotlyjs/static/plotlyjs/src/shapes.js

@@ -109,7 +109,7 @@ shapes.layoutAttributes = {
     path: {
         valType: 'string',
         role: 'info',
-        dflt: [
+        description: [
             'For `type` *path* - a valid SVG path but with the pixel values',
             'replaced by data values. There are a few restrictions / quirks',
             'only absolute instructions, not relative. So the allowed segments',

shelly/plotlyjs/static/plotlyjs/tests/plotschema_test.js

@@ -9,6 +9,9 @@ describe('plot schema', function() {
     var isValObject = Plotly.PlotSchema.isValObject,
         isPlainObject = Plotly.Lib.isPlainObject;
 
+    var VALTYPES = Object.keys(valObjects),
+        ROLES = ['info', 'style', 'data'];
+
     function assertPlotSchema(callback) {
         var traces = plotSchema.traces;
 
@@ -20,34 +23,30 @@ describe('plot schema', function() {
     }
 
     it('all attributes should have a valid `valType`', function() {
-        var valTypes = Object.keys(valObjects);
-
         assertPlotSchema(
             function(attr) {
                 if(isValObject(attr)) {
-                    expect(valTypes.indexOf(attr.valType) !== -1).toBe(true);
+                    expect(VALTYPES.indexOf(attr.valType) !== -1).toBe(true);
                 }
             }
         );
 
     });
 
     it('all attributes should only have valid `role`', function() {
-        var roles = ['info', 'style', 'data'];
-
         assertPlotSchema(
             function(attr) {
                 if(isValObject(attr)) {
-                    expect(roles.indexOf(attr.role) !== -1).toBe(true);
+                    expect(ROLES.indexOf(attr.role) !== -1).toBe(true);
                 }
             }
         );
     });
 
     it('all nested objects should have the *object* `role`', function() {
         assertPlotSchema(
-            function(attr) {
-                if(!isValObject(attr) && isPlainObject(attr)) {
+            function(attr, attrName) {
+                if(!isValObject(attr) && isPlainObject(attr) && attrName!=='items') {
                     expect(attr.role === 'object').toBe(true);
                 }
             }
@@ -112,25 +111,50 @@ describe('plot schema', function() {
         expect(list).toEqual(astrs);
     });
 
-    it('layout.annotations and layout.shapes should contain _isLinkedToArray', function() {
-        var IS_LINKED_TO_ARRAY = '_isLinkedToArray',
-            astrs = ['annotations', 'shapes'],
-            list = [];
+    it('layout.annotations and layout.shapes should contain `items`', function() {
+        var astrs = ['annotations', 'shapes'];
 
         astrs.forEach(function(astr) {
             expect(
-                Plotly.Lib.nestedProperty(
-                    plotSchema.layout.layoutAttributes,
-                    astr + '.' + IS_LINKED_TO_ARRAY
-                ).get()
+                isPlainObject(
+                    Plotly.Lib.nestedProperty(
+                        plotSchema.layout.layoutAttributes, astr
+                    ).get().items
+                )
             ).toBe(true);
         });
+    });
 
+    it('valObjects descriptions should be strings', function() {
         assertPlotSchema(
-            function(attr, attrName) {
-                if(attr[IS_LINKED_TO_ARRAY] === true) list.push(attrName);
+            function(attr) {
+                var isValid;
+
+                if(isValObject(attr)) {
+                    // attribute don't have to have a description (for now)
+                    isValid = (typeof attr.description === 'string') ||
+                        (attr.description === undefined);
+
+                    expect(isValid).toBe(true);
+                }
+            }
+        );
+    });
+
+    it('deprecated attributes should have a `valType` and `role`', function() {
+        var DEPRECATED = '_deprecated';
+
+        assertPlotSchema(
+            function(attr) {
+                if(isPlainObject(attr[DEPRECATED])) {
+                    Object.keys(attr[DEPRECATED]).forEach(function(dAttrName) {
+                        var dAttr = attr[DEPRECATED][dAttrName];
+
+                        expect(VALTYPES.indexOf(dAttr.valType) !== -1).toBe(true);
+                        expect(ROLES.indexOf(dAttr.role) !== -1).toBe(true);
+                    });
+                }
             }
         );
-        expect(list).toEqual(astrs);
     });
 });