add scattermapbox-specific attributes and defaults

Author: etpinard

src/traces/scattermapbox/attributes.js

@@ -0,0 +1,83 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var scatterGeoAttrs = require('../scattergeo/attributes');
+var plotAttrs = require('../../plots/attributes');
+var extendFlat = require('../../lib/extend').extendFlat;
+
+var lineAttrs = scatterGeoAttrs.line;
+var markerAttrs = scatterGeoAttrs.marker;
+
+
+module.exports = {
+    lon: scatterGeoAttrs.lon,
+    lat: scatterGeoAttrs.lat,
+
+    // locations
+    // locationmode
+
+    mode: {
+        valType: 'flaglist',
+        flags: ['lines', 'markers'],
+        dflt: 'markers',
+        extras: ['none'],
+        role: 'info',
+        description: [
+            'Determines the drawing mode for this scatter trace.'
+        ].join(' ')
+    },
+
+    // text
+
+    line: {
+        color: lineAttrs.color,
+        width: lineAttrs.width,
+        dash: lineAttrs.dash  // TODO
+    },
+
+    //connectgaps
+
+    marker: {
+        symbol: {
+            valType: 'enumerated',
+            values: ['circle'],  // TODO
+            dflt: 'circle',
+            role: 'style',
+            description: [
+                ''
+            ].join(' ')
+        },
+        opacity: extendFlat({}, markerAttrs.opacity, {
+            arrayOk: false
+        }),
+        size: markerAttrs.size,
+        sizeref: markerAttrs.sizeref,
+        sizemin: markerAttrs.sizemin,
+        sizemode: markerAttrs.sizemode,
+        color: markerAttrs.color,
+        colorscale: markerAttrs.colorscale,
+        cauto: markerAttrs.cauto,
+        cmax: markerAttrs.cmax,
+        cmin: markerAttrs.cmin,
+        autocolorscale: markerAttrs.autocolorscale,
+        reversescale: markerAttrs.reversescale,
+        showscale: markerAttrs.showscale
+
+        // line
+    },
+
+    hoverinfo: extendFlat({}, plotAttrs.hoverinfo, {
+        flags: ['lon', 'lat', 'text', 'name']
+    }),
+
+    _nestedModules: {
+        'marker.colorbar': 'Colorbar'
+    }
+};

src/traces/scattermapbox/defaults.js

@@ -0,0 +1,73 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+
+'use strict';
+
+var Lib = require('../../lib');
+
+var subTypes = require('../scatter/subtypes');
+var handleMarkerDefaults = require('../scatter/marker_defaults');
+var handleLineDefaults = require('../scatter/line_defaults');
+
+var attributes = require('./attributes');
+var scatterAttrs = require('../scatter/attributes');
+
+
+module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
+    function coerce(attr, dflt) {
+        return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
+    }
+
+    function coerceMarker(attr, dflt) {
+        var attrs = (attr.indexOf('.line') === -1) ? attributes : scatterAttrs;
+
+        // use 'scatter' attributes for 'marker.line.' attr,
+        // so that we can reuse the scatter marker defaults
+
+        return Lib.coerce(traceIn, traceOut, attrs, attr, dflt);
+    }
+
+    var len = handleLonLatDefaults(traceIn, traceOut, coerce);
+    if(!len) {
+        traceOut.visible = false;
+        return;
+    }
+
+    coerce('mode');
+
+    if(subTypes.hasLines(traceOut)) {
+        handleLineDefaults(traceIn, traceOut, defaultColor, coerce);
+    }
+
+    if(subTypes.hasMarkers(traceOut)) {
+        handleMarkerDefaults(traceIn, traceOut, defaultColor, layout, coerceMarker);
+
+        // array marker.size and marker.color are only supported with circles
+
+        var marker = traceOut.marker;
+
+        if(marker.symbol !== 'circle') {
+            if(Array.isArray(marker.size)) marker.size = marker.size[0];
+            if(Array.isArray(marker.color)) marker.color = marker.color[0];
+        }
+    }
+
+    coerce('hoverinfo', (layout._dataLength === 1) ? 'lon+lat+text' : undefined);
+};
+
+function handleLonLatDefaults(traceIn, traceOut, coerce) {
+    var lon = coerce('lon') || [];
+    var lat = coerce('lat') || [];
+    var len = Math.min(lon.length, lat.length);
+
+    if(len < lon.length) traceOut.lon = lon.slice(0, len);
+    if(len < lat.length) traceOut.lat = lat.slice(0, len);
+
+    return len;
+}

src/traces/scattermapbox/index.js

@@ -20,15 +20,16 @@ var ScatterMapbox = {};
 //  - support for marker.line ???
 ScatterMapbox.attributes = require('../scattergeo/attributes');
 ScatterMapbox.supplyDefaults = require('../scattergeo/defaults');
+ScatterMapbox.attributes = require('./attributes');
+ScatterMapbox.supplyDefaults = require('./defaults');
 ScatterMapbox.colorbar = require('../scatter/colorbar');
 ScatterMapbox.calc = require('../scattergeo/calc');
 ScatterMapbox.plot = require('./plot');
 
 ScatterMapbox.moduleType = 'trace';
 ScatterMapbox.name = 'scattermapbox';
 ScatterMapbox.basePlotModule = require('../../plots/mapbox');
-ScatterMapbox.categories = ['mapbox', 'gl', 'symbols', 'showLegend'];
-// ScatterMapbox.categories = ['mapbox', 'gl', 'symbols', 'markerColorscale', 'showLegend'];
+ScatterMapbox.categories = ['mapbox', 'gl', 'symbols', 'markerColorscale', 'showLegend'];
 ScatterMapbox.meta = {
     hrName: 'scatter_mapbox',
     description: [