mv geo module to plots/geo :

- keep GeoLayout module (for now) - merge GeoAxes into GeoLayout
plotly · etpinard · Nov 16, 2015 · Nov 11, 2015 · Nov 11, 2015 · Nov 11, 2015
commit 865476a50d4e0c705c3dc2291720e0a8753eec38
diff --git a/src/geo/geo.js → src/plots/geo/geo.js b/src/geo/geo.js → src/plots/geo/geo.js
@@ -2,17 +2,21 @@

 /* global PlotlyGeoAssets:false */

-var Plotly = require('../plotly'),
-    d3 = require('d3'),
-    params = require('./lib/params'),
-    addProjectionsToD3 = require('./lib/projections'),
-    createGeoScale = require('./lib/set-scale'),
-    createGeoZoom = require('./lib/zoom'),
-    createGeoZoomReset = require('./lib/zoom-reset'),
-    plotScatterGeo = require('./plot/scattergeo'),
-    plotChoropleth = require('./plot/choropleth'),
-    topojsonUtils = require('./lib/topojson-utils'),
-    topojsonFeature = require('topojson').feature;
+var Plotly = require('../../plotly');
+var d3 = require('d3');
+
+var addProjectionsToD3 = require('./projections');
+var createGeoScale = require('./set_scale');
+var createGeoZoom = require('./zoom');
+var createGeoZoomReset = require('./zoom_reset');
+
+var plotScatterGeo = require('../../traces/scattergeo/plot');
+var plotChoropleth = require('../../traces/choropleth/plot');
+
+var constants = require('../../constants/geo_constants');
+var topojsonUtils = require('../../lib/topojson_utils');
+var topojsonFeature = require('topojson').feature;
+

 function Geo(options, fullLayout) {

@@ -129,13 +133,13 @@ proto.makeProjection = function(geoLayout) {

    if(isNew) {
        this.projectionType = projType;
-        projection = this.projection = d3.geo[params.projNames[projType]]();
+        projection = this.projection = d3.geo[constants.projNames[projType]]();
    }
    else projection = this.projection;

    projection
        .translate(projLayout._translate0)
-        .precision(params.precision);
+        .precision(constants.precision);

    if(!geoLayout._isAlbersUsa) {
        projection
@@ -146,7 +150,7 @@ proto.makeProjection = function(geoLayout) {
    if(geoLayout._clipAngle) {
        this.clipAngle = geoLayout._clipAngle;  // needed in proto.render
        projection
-            .clipAngle(geoLayout._clipAngle - params.clipPad);
+            .clipAngle(geoLayout._clipAngle - constants.clipPad);
    }
    else this.clipAngle = null;  // for graph edits

@@ -249,7 +253,7 @@ proto.drawTopo = function(selection, layerName, geoLayout) {

    var topojson = this.topojson,
        datum = layerName==='frame' ?
-            params.sphereSVG :
+            constants.sphereSVG :
            topojsonFeature(topojson, topojson.objects[layerName]);

    selection.append('g')
@@ -273,7 +277,7 @@ proto.drawGraticule = function(selection, axisName, geoLayout) {

    if(axisLayout.showgrid !== true) return;

-    var scopeDefaults = params.scopeDefaults[geoLayout.scope],
+    var scopeDefaults = constants.scopeDefaults[geoLayout.scope],
        lonaxisRange = scopeDefaults.lonaxisRange,
        lataxisRange = scopeDefaults.lataxisRange,
        step = axisName==='lonaxis' ?
@@ -290,8 +294,8 @@ proto.drawGraticule = function(selection, axisName, geoLayout) {

 proto.drawLayout = function(geoLayout) {
    var gBaseLayer = this.framework.select('g.baselayer'),
-        baseLayers = params.baseLayers,
-        axesNames = params.axesNames,
+        baseLayers = constants.baseLayers,
+        axesNames = constants.axesNames,
        layerName;

    // TODO move to more d3-idiomatic pattern (that's work on replot)
@@ -311,7 +315,7 @@ proto.drawLayout = function(geoLayout) {
 };

 function styleFillLayer(selection, layerName, geoLayout) {
-    var layerAdj = params.layerNameToAdjective[layerName];
+    var layerAdj = constants.layerNameToAdjective[layerName];

    selection.select('.' + layerName)
        .selectAll('path')
@@ -320,7 +324,7 @@ function styleFillLayer(selection, layerName, geoLayout) {
 }

 function styleLineLayer(selection, layerName, geoLayout) {
-    var layerAdj = params.layerNameToAdjective[layerName];
+    var layerAdj = constants.layerNameToAdjective[layerName];

    selection.select('.' + layerName)
        .selectAll('path')
@@ -338,8 +342,8 @@ function styleGraticule(selection, axisName, geoLayout) {
 }

 proto.styleLayer = function(selection, layerName, geoLayout) {
-    var fillLayers = params.fillLayers,
-        lineLayers = params.lineLayers;
+    var fillLayers = constants.fillLayers,
+        lineLayers = constants.lineLayers;

    if(fillLayers.indexOf(layerName)!==-1) {
        styleFillLayer(selection, layerName, geoLayout);
@@ -351,8 +355,8 @@ proto.styleLayer = function(selection, layerName, geoLayout) {

 proto.styleLayout = function(geoLayout) {
    var gBaseLayer = this.framework.select('g.baselayer'),
-        baseLayers = params.baseLayers,
-        axesNames = params.axesNames,
+        baseLayers = constants.baseLayers,
+        axesNames = constants.axesNames,
        layerName;

    for(var i = 0; i < baseLayers.length; i++) {

diff --git a/src/geo/attributes/geolayout.js → src/plots/geo/layout/attributes.js b/src/geo/attributes/geolayout.js → src/plots/geo/layout/attributes.js
@@ -1,5 +1,7 @@
-var Plotly = require('../../plotly'),
-    params = require('../lib/params');
+var colorAttrs = require('../../../components/color/attributes');
+var constants = require('../../../constants/geo_constants');
+var geoAxesAttrs = require('./axis_attributes');
+

 module.exports = {
    domain: {
@@ -45,15 +47,15 @@ module.exports = {
    scope: {
        valType: 'enumerated',
        role: 'info',
-        values: Object.keys(params.scopeDefaults),
+        values: Object.keys(constants.scopeDefaults),
        dflt: 'world',
        description: 'Set the scope of the map.'
    },
    projection: {
        type: {
            valType: 'enumerated',
            role: 'info',
-            values: Object.keys(params.projNames),
+            values: Object.keys(constants.projNames),
            description: 'Sets the projection type.'
        },
        rotation: {
@@ -112,7 +114,7 @@ module.exports = {
    coastlinecolor: {
        valType: 'color',
        role: 'style',
-        dflt: Plotly.Color.defaultLine,
+        dflt: colorAttrs.defaultLine,
        description: 'Sets the coastline color.'
    },
    coastlinewidth: {
@@ -131,7 +133,7 @@ module.exports = {
    landcolor: {
        valType: 'color',
        role: 'style',
-        dflt: params.landColor,
+        dflt: constants.landColor,
        description: 'Sets the land mass color.'
    },
    showocean: {
@@ -143,7 +145,7 @@ module.exports = {
    oceancolor: {
        valType: 'color',
        role: 'style',
-        dflt: params.waterColor,
+        dflt: constants.waterColor,
        description: 'Sets the ocean color'
    },
    showlakes: {
@@ -155,7 +157,7 @@ module.exports = {
    lakecolor: {
        valType: 'color',
        role: 'style',
-        dflt: params.waterColor,
+        dflt: constants.waterColor,
        description: 'Sets the color of the lakes.'
    },
    showrivers: {
@@ -167,7 +169,7 @@ module.exports = {
    rivercolor: {
        valType: 'color',
        role: 'style',
-        dflt: params.waterColor,
+        dflt: constants.waterColor,
        description: 'Sets color of the rivers.'
    },
    riverwidth: {
@@ -185,7 +187,7 @@ module.exports = {
    countrycolor: {
        valType: 'color',
        role: 'style',
-        dflt: Plotly.Color.defaultLine,
+        dflt: colorAttrs.defaultLine,
        description: 'Sets line color of the country boundaries.'
    },
    countrywidth: {
@@ -206,7 +208,7 @@ module.exports = {
    subunitcolor: {
        valType: 'color',
        role: 'style',
-        dflt: Plotly.Color.defaultLine,
+        dflt: colorAttrs.defaultLine,
        description: 'Sets the color of the subunits boundaries.'
    },
    subunitwidth: {
@@ -224,7 +226,7 @@ module.exports = {
    framecolor: {
        valType: 'color',
        role: 'style',
-        dflt: Plotly.Color.defaultLine,
+        dflt: colorAttrs.defaultLine,
        description: 'Sets the color the frame.'
    },
    framewidth: {
@@ -237,11 +239,9 @@ module.exports = {
    bgcolor: {
        valType: 'color',
        role: 'style',
-        dflt: Plotly.Color.background,
+        dflt: colorAttrs.background,
        description: 'Set the background color of the map'
    },
-    _nestedModules: {
-        'lonaxis': 'GeoAxes',
-        'lataxis': 'GeoAxes'
-    }
+    lonaxis: geoAxesAttrs,
+    lataxis: geoAxesAttrs
 };
diff --git a/src/geo/attributes/geoaxes.js → src/plots/geo/layout/axis_attributes.js b/src/geo/attributes/geoaxes.js → src/plots/geo/layout/axis_attributes.js
@@ -1,4 +1,4 @@
-var Plotly = require('../../plotly');
+var colorAttrs = require('../../../components/color/attributes');

 module.exports = {
    range: {
@@ -33,7 +33,7 @@ module.exports = {
    gridcolor: {
        valType: 'color',
        role: 'style',
-        dflt: Plotly.Color.lightLine,
+        dflt: colorAttrs.lightLine,
        description: [
            'Sets the graticule\'s stroke color.'
        ].join(' ')

diff --git a/src/geo/defaults/geoaxes.js → src/plots/geo/layout/axis_defaults.js b/src/geo/defaults/geoaxes.js → src/plots/geo/layout/axis_defaults.js
@@ -1,20 +1,15 @@
 'use strict';

-var Plotly = require('../../plotly'),
-    params = require('../lib/params');
+var Plotly = require('../../../plotly');
+var constants = require('../../../constants/geo_constants');
+var axisAttributes = require('./axis_attributes');

-var GeoAxes = module.exports = {};

-GeoAxes.layoutAttributes = require('../attributes/geoaxes');
-
-GeoAxes.supplyLayoutDefaults = function(geoLayoutIn, geoLayoutOut) {
-    var axesNames = params.axesNames;
-
-    var axisIn, axisOut, axisName, rangeDflt, range, show;
+module.exports = function supplyGeoAxisLayoutDefaults(geoLayoutIn, geoLayoutOut) {
+    var axesNames = constants.axesNames;

    function coerce(attr, dflt) {
-        return Plotly.Lib.coerce(axisIn, axisOut,
-                                 GeoAxes.layoutAttributes, attr, dflt);
+        return Plotly.Lib.coerce(axisIn, axisOut, axisAttributes, attr, dflt);
    }

    function getRangeDflt(axisName) {
@@ -26,7 +21,7 @@ GeoAxes.supplyLayoutDefaults = function(geoLayoutIn, geoLayoutOut) {
            projLayout = geoLayoutOut.projection;
            projType = projLayout.type;
            projRotation = projLayout.rotation;
-            dfltSpans = params[axisName + 'Span'];
+            dfltSpans = constants[axisName + 'Span'];

            halfSpan = dfltSpans[projType]!==undefined ?
                dfltSpans[projType] / 2 :
@@ -37,24 +32,24 @@ GeoAxes.supplyLayoutDefaults = function(geoLayoutIn, geoLayoutOut) {

            return [rotateAngle - halfSpan, rotateAngle + halfSpan];
        }
-        else return params.scopeDefaults[scope][axisName + 'Range'];
+        else return constants.scopeDefaults[scope][axisName + 'Range'];
    }

    for(var i = 0; i < axesNames.length; i++) {
-        axisName = axesNames[i];
-        axisIn = geoLayoutIn[axisName] || {};
-        axisOut = {};
+        var axisName = axesNames[i];
+        var axisIn = geoLayoutIn[axisName] || {};
+        var axisOut = {};

-        rangeDflt = getRangeDflt(axisName);
+        var rangeDflt = getRangeDflt(axisName);

-        range = coerce('range', rangeDflt);
+        var range = coerce('range', rangeDflt);

        Plotly.Lib.noneOrAll(axisIn.range, axisOut.range, [0, 1]);

        coerce('tick0', range[0]);
        coerce('dtick', axisName==='lonaxis' ? 30 : 10);

-        show = coerce('showgrid');
+        var show = coerce('showgrid');
        if(show) {
            coerce('gridcolor');
            coerce('gridwidth');