add schema attributes in calendars module

- ++ allow trace and transform attributes to be filled by component modules.
plotly · etpinard · Dec 7, 2016 · Dec 6, 2016 · Dec 6, 2016 · Dec 6, 2016
commit 68af28745fba7551e57ae166a95e64bad76bf6d0
diff --git a/src/components/calendars/index.js b/src/components/calendars/index.js
@@ -35,6 +35,7 @@ var handleTraceDefaults = function(traceIn, traceOut, coords, layout) {
        handleDefaults(traceIn, traceOut, coords[i] + 'calendar', layout.calendar);
    }
 };
+
 // each calendar needs its own default canonical tick. I would love to use
 // 2000-01-01 (or even 0000-01-01) for them all but they don't necessarily
 // all support either of those dates. Instead I'll use the most significant
@@ -164,10 +165,77 @@ function getCal(calendar) {
    return calendarObj;
 }

+function makeAttrs(description) {
+    return Lib.extendFlat({}, attributes, { description: description });
+}
+
+function makeTraceAttrsDescription(coord) {
+    return 'Sets the calendar system to use with `' + coord + '` date data.';
+}
+
+var xAttrs = {
+    xcalendar: makeAttrs(makeTraceAttrsDescription('x'))
+};
+
+var xyAttrs = Lib.extendFlat({}, xAttrs, {
+    ycalendar: makeAttrs(makeTraceAttrsDescription('y'))
+});
+
+var xyzAttrs = Lib.extendFlat({}, xyAttrs, {
+    zcalendar: makeAttrs(makeTraceAttrsDescription('z'))
+});
+
+var axisAttrs = makeAttrs([
+    'Sets the calendar system to use for `range` and `tick0`',
+    'if this is a date axis. This does not set the calendar for',
+    'interpreting data on this axis, that\'s specified in the trace',
+    'or via the global `layout.calendar`'
+].join(' '));
+
 module.exports = {
    moduleType: 'component',
    name: 'calendars',

+    schema: {
+        traces: {
+            scatter: xyAttrs,
+            bar: xyAttrs,
+            heatmap: xyAttrs,
+            contour: xyAttrs,
+            histogram: xyAttrs,
+            histogram2d: xyAttrs,
+            histogram2dcontour: xyAttrs,
+            scatter3d: xyzAttrs,
+            surface: xyzAttrs,
+            mesh3d: xyzAttrs,
+            scattergl: xyAttrs,
+            ohlc: xAttrs,
+            candlestick: xAttrs
+        },
+        layout: {
+            calendar: makeAttrs([
+                'Sets the default calendar system to use for interpreting and',
+                'displaying dates throughout the plot.'
+            ].join(' ')),
+            'xaxis.calendar': axisAttrs,
+            'yaxis.calendar': axisAttrs,
+            'scene.xaxis.calendar': axisAttrs,
+            'scene.yaxis.calendar': axisAttrs,
+            'scene.zaxis.calendar': axisAttrs
+        },
+        transforms: {
+            filter: {
+                calendar: makeAttrs([
+                    'Sets the calendar system to use for `value`, if it is a date.',
+                    'Note that this is not necessarily the same calendar as is used',
+                    'for the target data; that is set by its own calendar attribute,',
+                    'ie `trace.x` uses `trace.xcalendar` etc.'
+                ].join(' '))
+            }
+        }
+    },
+
+    layoutAttributes: attributes,

    handleDefaults: handleDefaults,
    handleTraceDefaults: handleTraceDefaults,

diff --git a/src/plot_api/plot_schema.js b/src/plot_api/plot_schema.js
@@ -212,6 +212,17 @@ function getTraceAttributes(type) {
        extendDeep(attributes, basePlotModule.attributes);
    }

+    // add registered components trace attributes
+    Object.keys(Registry.componentsRegistry).forEach(function(k) {
+        var _module = Registry.componentsRegistry[k];
+
+        if(_module.schema && _module.schema.traces && _module.schema.traces[type]) {
+            Object.keys(_module.schema.traces[type]).forEach(function(v) {
+                insertAttrs(attributes, _module.schema.traces[type][v], v);
+            });
+        }
+    });
+
    // 'type' gets overwritten by baseAttributes; reset it here
    attributes.type = type;

@@ -280,9 +291,21 @@ function getLayoutAttributes() {

 function getTransformAttributes(type) {
    var _module = Registry.transformsRegistry[type];
+    var attributes = extendDeep({}, _module.attributes);
+
+    // add registered components transform attributes
+    Object.keys(Registry.componentsRegistry).forEach(function(k) {
+        var _module = Registry.componentsRegistry[k];
+
+        if(_module.schema && _module.schema.transforms && _module.schema.transforms[type]) {
+            Object.keys(_module.schema.transforms[type]).forEach(function(v) {
+                insertAttrs(attributes, _module.schema.transforms[type][v], v);
+            });
+        }
+    });

    return {
-        attributes: formatAttributes(_module.attributes)
+        attributes: formatAttributes(attributes)
    };
 }


diff --git a/test/jasmine/tests/plotschema_test.js b/test/jasmine/tests/plotschema_test.js
@@ -188,6 +188,17 @@ describe('plot schema', function() {
        });
    });

+    it('should work with registered components', function() {
+        expect(plotSchema.traces.scatter.attributes.xcalendar.valType).toEqual('enumerated');
+        expect(plotSchema.traces.scatter3d.attributes.zcalendar.valType).toEqual('enumerated');
+
+        expect(plotSchema.layout.layoutAttributes.calendar.valType).toEqual('enumerated');
+        expect(plotSchema.layout.layoutAttributes.xaxis.calendar.valType).toEqual('enumerated');
+        expect(plotSchema.layout.layoutAttributes.scene.xaxis.calendar.valType).toEqual('enumerated');
+
+        expect(plotSchema.transforms.filter.attributes.calendar.valType).toEqual('enumerated');
+    });
+
    it('should list correct defs', function() {
        expect(plotSchema.defs.valObjects).toBeDefined();