move pattern to drawing and make a lib fn to coerce it

Author: archmoj

src/components/drawing/attributes.js

@@ -15,3 +15,52 @@ exports.dash = {
         'or a dash length list in px (eg *5px,10px,2px,2px*).'
     ].join(' ')
 };
+
+exports.pattern = {
+    shape: {
+        valType: 'enumerated',
+        values: ['', '/', '\\', 'x', '-', '|', '+', '.'],
+        dflt: '',
+        arrayOk: true,
+        editType: 'style',
+        description: [
+            'Sets the shape of the pattern fill.',
+            'By default, no pattern is used for filling the area.',
+        ].join(' ')
+    },
+    bgcolor: {
+        valType: 'color',
+        arrayOk: true,
+        editType: 'style',
+        description: [
+            'Sets the background color of the pattern fill.',
+            'Defaults to a transparent background.',
+        ].join(' ')
+    },
+    size: {
+        valType: 'number',
+        min: 0,
+        dflt: 8,
+        arrayOk: true,
+        editType: 'style',
+        description: [
+            'Sets the size of unit squares of the pattern fill in pixels,',
+            'which corresponds to the interval of repetition of the pattern.',
+        ].join(' ')
+    },
+    solidity: {
+        valType: 'number',
+        min: 0,
+        max: 1,
+        dflt: 0.3,
+        arrayOk: true,
+        editType: 'style',
+        description: [
+            'Sets the solidity of the pattern fill.',
+            'Solidity is roughly proportional to the ratio of the area filled by the pattern.',
+            'Solidity of 0 shows only the background color without pattern',
+            'and solidty of 1 shows only the foreground color without pattern.',
+        ].join(' ')
+    },
+    editType: 'style'
+};

src/lib/coerce.js

@@ -424,6 +424,22 @@ exports.coerceFont = function(coerce, attr, dfltObj) {
     return out;
 };
 
+/*
+ * Shortcut to coerce the pattern attributes
+ */
+exports.coercePattern = function(coerce, attr) {
+    var out = {};
+
+    out.shape = coerce(attr + '.shape');
+    if(out.shape) {
+        out.size = coerce(attr + '.size');
+        out.bgcolor = coerce(attr + '.bgcolor');
+        out.solidity = coerce(attr + '.solidity');
+    }
+
+    return out;
+};
+
 /** Coerce shortcut for 'hoverinfo'
  * handling 1-vs-multi-trace dflt logic
  *

src/lib/index.js

@@ -35,6 +35,7 @@ lib.valObjectMeta = coerceModule.valObjectMeta;
 lib.coerce = coerceModule.coerce;
 lib.coerce2 = coerceModule.coerce2;
 lib.coerceFont = coerceModule.coerceFont;
+lib.coercePattern = coerceModule.coercePattern;
 lib.coerceHoverinfo = coerceModule.coerceHoverinfo;
 lib.coerceSelectionMarkerOpacity = coerceModule.coerceSelectionMarkerOpacity;
 lib.validate = coerceModule.validate;

src/traces/bar/attributes.js

@@ -6,6 +6,7 @@ var texttemplateAttrs = require('../../plots/template_attributes').texttemplateA
 var colorScaleAttrs = require('../../components/colorscale/attributes');
 var fontAttrs = require('../../plots/font_attributes');
 var constants = require('./constants');
+var pattern = require('../../components/drawing/attributes').pattern;
 
 var extendFlat = require('../../lib/extend').extendFlat;
 
@@ -40,54 +41,7 @@ var marker = extendFlat({
         editType: 'style',
         description: 'Sets the opacity of the bars.'
     },
-    pattern: {
-        shape: {
-            valType: 'enumerated',
-            values: ['', '/', '\\', 'x', '-', '|', '+', '.'],
-            dflt: '',
-            arrayOk: true,
-            editType: 'style',
-            description: [
-                'Sets the shape of the pattern fill.',
-                'By default, no pattern is used for filling the area.',
-            ].join(' ')
-        },
-        bgcolor: {
-            valType: 'color',
-            arrayOk: true,
-            editType: 'style',
-            description: [
-                'Sets the background color of the pattern fill.',
-                'Defaults to a transparent background.',
-            ].join(' ')
-        },
-        size: {
-            valType: 'number',
-            min: 0,
-            dflt: 8,
-            arrayOk: true,
-            editType: 'style',
-            description: [
-                'Sets the size of unit squares of the pattern fill in pixels,',
-                'which corresponds to the interval of repetition of the pattern.',
-            ].join(' ')
-        },
-        solidity: {
-            valType: 'number',
-            min: 0,
-            max: 1,
-            dflt: 0.3,
-            arrayOk: true,
-            editType: 'style',
-            description: [
-                'Sets the solidity of the pattern fill.',
-                'Solidity is roughly proportional to the ratio of the area filled by the pattern.',
-                'Solidity of 0 shows only the background color without pattern',
-                'and solidty of 1 shows only the foreground color without pattern.',
-            ].join(' ')
-        },
-        editType: 'style'
-    }
+    pattern: pattern
 });
 
 module.exports = {

src/traces/bar/style_defaults.js

@@ -3,6 +3,7 @@
 var Color = require('../../components/color');
 var hasColorscale = require('../../components/colorscale/helpers').hasColorscale;
 var colorscaleDefaults = require('../../components/colorscale/defaults');
+var coercePattern = require('../../lib').coercePattern;
 
 module.exports = function handleStyleDefaults(traceIn, traceOut, coerce, defaultColor, layout) {
     coerce('marker.color', defaultColor);
@@ -23,12 +24,8 @@ module.exports = function handleStyleDefaults(traceIn, traceOut, coerce, default
 
     coerce('marker.line.width');
     coerce('marker.opacity');
-    var patternShape = coerce('marker.pattern.shape');
-    if(patternShape) {
-        coerce('marker.pattern.bgcolor');
-        coerce('marker.pattern.size');
-        coerce('marker.pattern.solidity');
-    }
+    coercePattern(coerce, 'marker.pattern');
+
     coerce('selected.marker.color');
     coerce('unselected.marker.color');
 };

src/traces/funnel/defaults.js

@@ -48,12 +48,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     var markerColor = coerce('marker.color', defaultColor);
     coerce('marker.line.color', Color.defaultLine);
     coerce('marker.line.width');
-    var patternShape = coerce('marker.pattern.shape');
-    if(patternShape) {
-        coerce('marker.pattern.bgcolor');
-        coerce('marker.pattern.size');
-        coerce('marker.pattern.solidity');
-    }
+    Lib.coercePattern(coerce, 'marker.pattern');
 
     var connectorVisible = coerce('connector.visible');
     if(connectorVisible) {