Add breaking change warning for 'country names' locationmode option

camdecoster · camdecoster · commit 8ae607bcf4e4 · 2025-08-07T16:11:44.000-06:00
diff --git a/src/traces/choropleth/plot.js b/src/traces/choropleth/plot.js
@@ -9,7 +9,18 @@ var findExtremes = require('../../plots/cartesian/autorange').findExtremes;
 
 var style = require('./style').style;
 
+const breakingChangeWarning = [
+    'The library used by the *country names* `locationmode` option is changing in an upcoming version.',
+    'Country names in existing plots may not work in the new version.'
+].join(' ');
+let firstPlot = true;
+
 function plot(gd, geo, calcData) {
+    if(firstPlot) {
+        firstPlot = false;
+        Lib.warn(breakingChangeWarning);
+    }
+
     var choroplethLayer = geo.layers.backplot.select('.choroplethlayer');
 
     Lib.makeTraceGroups(choroplethLayer, calcData, 'trace choropleth').each(function(calcTrace) {
diff --git a/src/traces/scattergeo/attributes.js b/src/traces/scattergeo/attributes.js
@@ -15,6 +15,11 @@ var scatterMarkerAttrs = scatterAttrs.marker;
 var scatterLineAttrs = scatterAttrs.line;
 var scatterMarkerLineAttrs = scatterMarkerAttrs.line;
 
+const breakingChangeWarning = [
+    'The library used by the *country names* `locationmode` option is changing in an upcoming version.',
+    'Country names in existing plots may not work in the new version.'
+].join(' ');
+
 module.exports = overrideAll({
     lon: {
         valType: 'data_array',
@@ -38,6 +43,7 @@ module.exports = overrideAll({
         values: ['ISO-3', 'USA-states', 'country names', 'geojson-id'],
         dflt: 'ISO-3',
         description: [
+            breakingChangeWarning,
             'Determines the set of locations used to match entries in `locations`',
             'to regions on the map.',
             'Values *ISO-3*, *USA-states*, *country names* correspond to features on',
diff --git a/src/traces/scattergeo/plot.js b/src/traces/scattergeo/plot.js
@@ -13,7 +13,18 @@ var calcMarkerSize = require('../scatter/calc').calcMarkerSize;
 var subTypes = require('../scatter/subtypes');
 var style = require('./style');
 
+const breakingChangeWarning = [
+    'The library used by the *country names* `locationmode` option is changing in an upcoming version.',
+    'Country names in existing plots may not work in the new version.'
+].join(' ');
+let firstPlot = true;
+
 function plot(gd, geo, calcData) {
+    if(firstPlot) {
+        firstPlot = false;
+        Lib.warn(breakingChangeWarning);
+    }
+
     var scatterLayer = geo.layers.frontplot.select('.scatterlayer');
     var gTraces = Lib.makeTraceGroups(scatterLayer, calcData, 'trace scattergeo');
 
