plotly.js 1.51.2 → 1.52.2

package/src/traces/choropleth/attributes.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -33,6 +33,21 @@ module.exports = extendFlat({
         editType: 'calc',
         description: 'Sets the color values.'
     },
+    geojson: extendFlat({}, scatterGeoAttrs.geojson, {
+        description: [
+            'Sets optional GeoJSON data associated with this trace.',
+            'If not given, the features on the base map are used.',
+
+            'It can be set as a valid GeoJSON object or as a URL string.',
+            'Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature*',
+            'with geometries of type *Polygon* or *MultiPolygon*.'
+
+            // TODO add topojson support with additional 'topojsonobject' attr?
+            // https://github.com/topojson/topojson-specification/blob/master/README.md
+        ].join(' ')
+    }),
+    featureidkey: scatterGeoAttrs.featureidkey,
+
     text: extendFlat({}, scatterGeoAttrs.text, {
         description: 'Sets the text elements associated with each location.'
     }),
@@ -77,7 +92,8 @@ module.exports = extendFlat({
         editType: 'calc',
         flags: ['location', 'z', 'text', 'name']
     }),
-    hovertemplate: hovertemplateAttrs()
+    hovertemplate: hovertemplateAttrs(),
+    showlegend: extendFlat({}, baseAttrs.showlegend, {dflt: false})
 },
 
     colorScaleAttrs('', {

package/src/traces/choropleth/calc.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the

package/src/traces/choropleth/defaults.js

@@ -1,12 +1,11 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, 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');
@@ -28,7 +27,18 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
 
     traceOut._length = Math.min(locations.length, z.length);
 
-    coerce('locationmode');
+    var geojson = coerce('geojson');
+
+    var locationmodeDflt;
+    if((typeof geojson === 'string' && geojson !== '') || Lib.isPlainObject(geojson)) {
+        locationmodeDflt = 'geojson-id';
+    }
+
+    var locationMode = coerce('locationmode', locationmodeDflt);
+
+    if(locationMode === 'geojson-id') {
+        coerce('featureidkey');
+    }
 
     coerce('text');
     coerce('hovertext');

package/src/traces/choropleth/event_data.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -12,10 +12,12 @@ module.exports = function eventData(out, pt, trace, cd, pointNumber) {
     out.location = pt.location;
     out.z = pt.z;
 
+    // include feature properties from input geojson
     var cdi = cd[pointNumber];
-    if(cdi.fIn) {
+    if(cdi.fIn && cdi.fIn.properties) {
         out.properties = cdi.fIn.properties;
     }
+    out.ct = cdi.ct;
 
     return out;
 };

package/src/traces/choropleth/hover.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the

package/src/traces/choropleth/index.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -13,6 +13,7 @@ module.exports = {
     supplyDefaults: require('./defaults'),
     colorbar: require('../heatmap/colorbar'),
     calc: require('./calc'),
+    calcGeoJSON: require('./plot').calcGeoJSON,
     plot: require('./plot').plot,
     style: require('./style').style,
     styleOnSelect: require('./style').styleOnSelect,
@@ -23,7 +24,7 @@ module.exports = {
     moduleType: 'trace',
     name: 'choropleth',
     basePlotModule: require('../../plots/geo'),
-    categories: ['geo', 'noOpacity'],
+    categories: ['geo', 'noOpacity', 'showLegend'],
     meta: {
         description: [
             'The data that describes the choropleth value-to-color mapping',

package/src/traces/choropleth/plot.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -11,18 +11,15 @@
 var d3 = require('d3');
 
 var Lib = require('../../lib');
-var polygon = require('../../lib/polygon');
-
+var geoUtils = require('../../lib/geo_location_utils');
 var getTopojsonFeatures = require('../../lib/topojson_utils').getTopojsonFeatures;
-var locationToFeature = require('../../lib/geo_location_utils').locationToFeature;
+var findExtremes = require('../../plots/cartesian/autorange').findExtremes;
+
 var style = require('./style').style;
 
 function plot(gd, geo, calcData) {
-    for(var i = 0; i < calcData.length; i++) {
-        calcGeoJSON(calcData[i], geo.topojson);
-    }
-
     var choroplethLayer = geo.layers.backplot.select('.choroplethlayer');
+
     Lib.makeTraceGroups(choroplethLayer, calcData, 'trace choropleth').each(function(calcTrace) {
         var sel = d3.select(this);
 
@@ -39,131 +36,51 @@ function plot(gd, geo, calcData) {
     });
 }
 
-function calcGeoJSON(calcTrace, topojson) {
+function calcGeoJSON(calcTrace, fullLayout) {
     var trace = calcTrace[0].trace;
-    var len = calcTrace.length;
-    var features = getTopojsonFeatures(trace, topojson);
+    var geoLayout = fullLayout[trace.geo];
+    var geo = geoLayout._subplot;
+    var locationmode = trace.locationmode;
+    var len = trace._length;
+
+    var features = locationmode === 'geojson-id' ?
+        geoUtils.extractTraceFeature(calcTrace) :
+        getTopojsonFeatures(trace, geo.topojson);
+
+    var lonArray = [];
+    var latArray = [];
 
     for(var i = 0; i < len; i++) {
         var calcPt = calcTrace[i];
-        var feature = locationToFeature(trace.locationmode, calcPt.loc, features);
-
-        if(!feature) {
+        var feature = locationmode === 'geojson-id' ?
+            calcPt.fOut :
+            geoUtils.locationToFeature(locationmode, calcPt.loc, features);
+
+        if(feature) {
+            calcPt.geojson = feature;
+            calcPt.ct = feature.properties.ct;
+            calcPt._polygons = geoUtils.feature2polygons(feature);
+
+            var bboxFeature = geoUtils.computeBbox(feature);
+            lonArray.push(bboxFeature[0], bboxFeature[2]);
+            latArray.push(bboxFeature[1], bboxFeature[3]);
+        } else {
             calcPt.geojson = null;
-            continue;
         }
-
-        calcPt.geojson = feature;
-        calcPt.ct = feature.properties.ct;
-        calcPt._polygons = feature2polygons(feature);
-    }
-}
-
-function feature2polygons(feature) {
-    var geometry = feature.geometry;
-    var coords = geometry.coordinates;
-    var loc = feature.id;
-
-    var polygons = [];
-    var appendPolygon, j, k, m;
-
-    function doesCrossAntiMerdian(pts) {
-        for(var l = 0; l < pts.length - 1; l++) {
-            if(pts[l][0] > 0 && pts[l + 1][0] < 0) return l;
-        }
-        return null;
-    }
-
-    if(loc === 'RUS' || loc === 'FJI') {
-        // Russia and Fiji have landmasses that cross the antimeridian,
-        // we need to add +360 to their longitude coordinates, so that
-        // polygon 'contains' doesn't get confused when crossing the antimeridian.
-        //
-        // Note that other countries have polygons on either side of the antimeridian
-        // (e.g. some Aleutian island for the USA), but those don't confuse
-        // the 'contains' method; these are skipped here.
-        appendPolygon = function(_pts) {
-            var pts;
-
-            if(doesCrossAntiMerdian(_pts) === null) {
-                pts = _pts;
-            } else {
-                pts = new Array(_pts.length);
-                for(m = 0; m < _pts.length; m++) {
-                    // do nut mutate calcdata[i][j].geojson !!
-                    pts[m] = [
-                        _pts[m][0] < 0 ? _pts[m][0] + 360 : _pts[m][0],
-                        _pts[m][1]
-                    ];
-                }
-            }
-
-            polygons.push(polygon.tester(pts));
-        };
-    } else if(loc === 'ATA') {
-        // Antarctica has a landmass that wraps around every longitudes which
-        // confuses the 'contains' methods.
-        appendPolygon = function(pts) {
-            var crossAntiMeridianIndex = doesCrossAntiMerdian(pts);
-
-            // polygon that do not cross anti-meridian need no special handling
-            if(crossAntiMeridianIndex === null) {
-                return polygons.push(polygon.tester(pts));
-            }
-
-            // stitch polygon by adding pt over South Pole,
-            // so that it covers the projected region covers all latitudes
-            //
-            // Note that the algorithm below only works for polygons that
-            // start and end on longitude -180 (like the ones built by
-            // https://github.com/etpinard/sane-topojson).
-            var stitch = new Array(pts.length + 1);
-            var si = 0;
-
-            for(m = 0; m < pts.length; m++) {
-                if(m > crossAntiMeridianIndex) {
-                    stitch[si++] = [pts[m][0] + 360, pts[m][1]];
-                } else if(m === crossAntiMeridianIndex) {
-                    stitch[si++] = pts[m];
-                    stitch[si++] = [pts[m][0], -90];
-                } else {
-                    stitch[si++] = pts[m];
-                }
-            }
-
-            // polygon.tester by default appends pt[0] to the points list,
-            // we must remove it here, to avoid a jump in longitude from 180 to -180,
-            // that would confuse the 'contains' method
-            var tester = polygon.tester(stitch);
-            tester.pts.pop();
-            polygons.push(tester);
-        };
-    } else {
-        // otherwise using same array ref is fine
-        appendPolygon = function(pts) {
-            polygons.push(polygon.tester(pts));
-        };
     }
 
-    switch(geometry.type) {
-        case 'MultiPolygon':
-            for(j = 0; j < coords.length; j++) {
-                for(k = 0; k < coords[j].length; k++) {
-                    appendPolygon(coords[j][k]);
-                }
-            }
-            break;
-        case 'Polygon':
-            for(j = 0; j < coords.length; j++) {
-                appendPolygon(coords[j]);
-            }
-            break;
+    if(geoLayout.fitbounds === 'geojson' && locationmode === 'geojson-id') {
+        var bboxGeojson = geoUtils.computeBbox(geoUtils.getTraceGeojson(trace));
+        lonArray = [bboxGeojson[0], bboxGeojson[2]];
+        latArray = [bboxGeojson[1], bboxGeojson[3]];
     }
 
-    return polygons;
+    var opts = {padded: true};
+    trace._extremes.lon = findExtremes(geoLayout.lonaxis._ax, lonArray, opts);
+    trace._extremes.lat = findExtremes(geoLayout.lataxis._ax, latArray, opts);
 }
 
 module.exports = {
-    plot: plot,
-    feature2polygons: feature2polygons
+    calcGeoJSON: calcGeoJSON,
+    plot: plot
 };

package/src/traces/choropleth/select.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the

package/src/traces/choropleth/style.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the

package/src/traces/choroplethmapbox/attributes.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -11,7 +11,7 @@
 var choroplethAttrs = require('../choropleth/attributes');
 var colorScaleAttrs = require('../../components/colorscale/attributes');
 var hovertemplateAttrs = require('../../plots/template_attributes').hovertemplateAttrs;
-
+var baseAttrs = require('../../plots/attributes');
 var extendFlat = require('../../lib/extend').extendFlat;
 
 module.exports = extendFlat({
@@ -28,9 +28,7 @@ module.exports = extendFlat({
     // Maybe start with only one value (that we could name e.g. 'geojson-id'),
     // but eventually:
     // - we could also support for our own dist/topojson/*
-    // - some people might want `geojson-properties-name` to map data arrays to
-    //   GeoJSON features
-    // locationmode: choroplethAttrs.locationmode,
+    //   .. and locationmode: choroplethAttrs.locationmode,
 
     z: {
         valType: 'data_array',
@@ -47,11 +45,19 @@ module.exports = extendFlat({
         editType: 'calc',
         description: [
             'Sets the GeoJSON data associated with this trace.',
-            'Can be set as a valid GeoJSON object or as URL string',
-            'Note that we only accept GeoJSON of type *FeatureCollection* and *Feature*',
-            'with geometries of type *Polygon* and *MultiPolygon*.'
+
+            'It can be set as a valid GeoJSON object or as a URL string.',
+            'Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature*',
+            'with geometries of type *Polygon* or *MultiPolygon*.'
         ].join(' ')
     },
+    featureidkey: extendFlat({}, choroplethAttrs.featureidkey, {
+        description: [
+            'Sets the key in GeoJSON features which is used as id to match the items',
+            'included in the `locations` array.',
+            'Support nested property, for example *properties.name*.'
+        ].join(' ')
+    }),
 
     // TODO agree on name / behaviour
     //
@@ -103,7 +109,8 @@ module.exports = extendFlat({
     },
 
     hoverinfo: choroplethAttrs.hoverinfo,
-    hovertemplate: hovertemplateAttrs({}, {keys: ['properties']})
+    hovertemplate: hovertemplateAttrs({}, {keys: ['properties']}),
+    showlegend: extendFlat({}, baseAttrs.showlegend, {dflt: false})
 },
 
     colorScaleAttrs('', {

package/src/traces/choroplethmapbox/convert.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -9,15 +9,13 @@
 'use strict';
 
 var isNumeric = require('fast-isnumeric');
-var turfArea = require('@turf/area');
-var turfCentroid = require('@turf/centroid');
 
 var Lib = require('../../lib');
 var Colorscale = require('../../components/colorscale');
 var Drawing = require('../../components/drawing');
 
 var makeBlank = require('../../lib/geojson_utils').makeBlank;
-var feature2polygons = require('../choropleth/plot').feature2polygons;
+var geoUtils = require('../../lib/geo_location_utils');
 
 /* N.B.
  *
@@ -52,25 +50,9 @@ function convert(calcTrace) {
 
     if(!isVisible) return opts;
 
-    var geojsonIn = typeof trace.geojson === 'string' ?
-        (window.PlotlyGeoAssets || {})[trace.geojson] :
-        trace.geojson;
+    var features = geoUtils.extractTraceFeature(calcTrace);
 
-    // This should not happen, but just in case something goes
-    // really wrong when fetching the GeoJSON
-    if(!Lib.isPlainObject(geojsonIn)) {
-        Lib.error('Oops ... something when wrong when fetching ' + trace.geojson);
-        return opts;
-    }
-
-    var lookup = {};
-    var featuresOut = [];
-    var i;
-
-    for(i = 0; i < calcTrace.length; i++) {
-        var cdi = calcTrace[i];
-        if(cdi.loc) lookup[cdi.loc] = cdi;
-    }
+    if(!features) return opts;
 
     var sclFunc = Colorscale.makeColorScaleFuncFromTrace(trace);
     var marker = trace.marker;
@@ -94,63 +76,19 @@ function convert(calcTrace) {
         lineWidthFn = function(d) { return d.mlw; };
     }
 
-    function appendFeature(fIn) {
-        var cdi = lookup[fIn.id];
-
-        if(cdi) {
-            var geometry = fIn.geometry;
-
-            if(geometry.type === 'Polygon' || geometry.type === 'MultiPolygon') {
-                var props = {fc: sclFunc(cdi.z)};
-
-                if(opacityFn) props.mo = opacityFn(cdi);
-                if(lineColorFn) props.mlc = lineColorFn(cdi);
-                if(lineWidthFn) props.mlw = lineWidthFn(cdi);
-
-                var fOut = {
-                    type: 'Feature',
-                    geometry: geometry,
-                    properties: props
-                };
-
-                cdi._polygons = feature2polygons(fOut);
-                cdi.ct = findCentroid(fOut);
-                cdi.fIn = fIn;
-                cdi.fOut = fOut;
-                featuresOut.push(fOut);
-            } else {
-                Lib.log([
-                    'Location with id', cdi.loc, 'does not have a valid GeoJSON geometry,',
-                    'choroplethmapbox traces only support *Polygon* and *MultiPolygon* geometries.'
-                ].join(' '));
-            }
+    for(var i = 0; i < calcTrace.length; i++) {
+        var cdi = calcTrace[i];
+        var fOut = cdi.fOut;
+
+        if(fOut) {
+            var props = fOut.properties;
+            props.fc = sclFunc(cdi.z);
+            if(opacityFn) props.mo = opacityFn(cdi);
+            if(lineColorFn) props.mlc = lineColorFn(cdi);
+            if(lineWidthFn) props.mlw = lineWidthFn(cdi);
+            cdi.ct = props.ct;
+            cdi._polygons = geoUtils.feature2polygons(fOut);
         }
-
-        // remove key from lookup, so that we can track (if any)
-        // the locations that did not have a corresponding GeoJSON feature
-        delete lookup[fIn.id];
-    }
-
-    switch(geojsonIn.type) {
-        case 'FeatureCollection':
-            var featuresIn = geojsonIn.features;
-            for(i = 0; i < featuresIn.length; i++) {
-                appendFeature(featuresIn[i]);
-            }
-            break;
-        case 'Feature':
-            appendFeature(geojsonIn);
-            break;
-        default:
-            Lib.warn([
-                'Invalid GeoJSON type', (geojsonIn.type || 'none') + ',',
-                'choroplethmapbox traces only support *FeatureCollection* and *Feature* types.'
-            ].join(' '));
-            return opts;
-    }
-
-    for(var loc in lookup) {
-        Lib.log('Location with id ' + loc + ' does not have a matching feature');
     }
 
     var opacitySetting = opacityFn ?
@@ -175,7 +113,7 @@ function convert(calcTrace) {
     fill.layout.visibility = 'visible';
     line.layout.visibility = 'visible';
 
-    opts.geojson = {type: 'FeatureCollection', features: featuresOut};
+    opts.geojson = {type: 'FeatureCollection', features: features};
 
     convertOnSelect(calcTrace);
 
@@ -210,33 +148,6 @@ function convertOnSelect(calcTrace) {
     return opts;
 }
 
-// TODO this find the centroid of the polygon of maxArea
-// (just like we currently do for geo choropleth polygons),
-// maybe instead it would make more sense to compute the centroid
-// of each polygon and consider those on hover/select
-function findCentroid(feature) {
-    var geometry = feature.geometry;
-    var poly;
-
-    if(geometry.type === 'MultiPolygon') {
-        var coords = geometry.coordinates;
-        var maxArea = 0;
-
-        for(var i = 0; i < coords.length; i++) {
-            var polyi = {type: 'Polygon', coordinates: coords[i]};
-            var area = turfArea.default(polyi);
-            if(area > maxArea) {
-                maxArea = area;
-                poly = polyi;
-            }
-        }
-    } else {
-        poly = geometry;
-    }
-
-    return turfCentroid.default(poly).geometry.coordinates;
-}
-
 module.exports = {
     convert: convert,
     convertOnSelect: convertOnSelect

package/src/traces/choroplethmapbox/defaults.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -29,6 +29,8 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return;
     }
 
+    coerce('featureidkey');
+
     traceOut._length = Math.min(locations.length, z.length);
 
     coerce('below');

package/src/traces/choroplethmapbox/index.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -52,7 +52,7 @@ module.exports = {
     moduleType: 'trace',
     name: 'choroplethmapbox',
     basePlotModule: require('../../plots/mapbox'),
-    categories: ['mapbox', 'gl', 'noOpacity'],
+    categories: ['mapbox', 'gl', 'noOpacity', 'showLegend'],
     meta: {
         hr_name: 'choropleth_mapbox',
         description: [

package/src/traces/choroplethmapbox/plot.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the

package/src/traces/cone/attributes.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -166,7 +166,9 @@ var attrs = {
         editType: 'calc',
         description: 'Same as `text`.'
     },
-    hovertemplate: hovertemplateAttrs({editType: 'calc'}, {keys: ['norm']})
+
+    hovertemplate: hovertemplateAttrs({editType: 'calc'}, {keys: ['norm']}),
+    showlegend: extendFlat({}, baseAttrs.showlegend, {dflt: false})
 };
 
 extendFlat(attrs, colorScaleAttrs('', {

package/src/traces/cone/calc.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the

package/src/traces/cone/convert.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the

package/src/traces/cone/defaults.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the

package/src/traces/cone/index.js

@@ -1,5 +1,5 @@
 /**
-* Copyright 2012-2019, Plotly, Inc.
+* Copyright 2012-2020, Plotly, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
@@ -12,7 +12,7 @@ module.exports = {
     moduleType: 'trace',
     name: 'cone',
     basePlotModule: require('../../plots/gl3d'),
-    categories: ['gl3d'],
+    categories: ['gl3d', 'showLegend'],
 
     attributes: require('./attributes'),
     supplyDefaults: require('./defaults'),