Allow US states to be looked up by name

Author: camdecoster

src/lib/geo_location_utils.js

@@ -11,13 +11,14 @@ var loggers = require('./loggers');
 var isPlainObject = require('./is_plain_object');
 var nestedProperty = require('./nested_property');
 var polygon = require('./polygon');
+const { usaLocationAbbreviations, usaLocationList } = require('./usa_location_names');
 
 // make list of all country iso3 ids from at runtime
 var countryIds = Object.keys(countryRegex);
 
 var locationmodeToIdFinder = {
     'ISO-3': identity,
-    'USA-states': identity,
+    'USA-states': usaLocationToAbbreviation,
     'country names': countryNameToISO3
 };
 
@@ -34,14 +35,25 @@ function countryNameToISO3(countryName) {
     return false;
 }
 
+function usaLocationToAbbreviation(loc) {
+    loc = loc.trim();
+    const abbreviation = usaLocationAbbreviations.has(loc.toUpperCase())
+        ? loc.toUpperCase()
+        : usaLocationList[loc.toLowerCase()];
+
+    if (abbreviation) return abbreviation;
+
+    loggers.log('Unrecognized US location: ' + loc + '.');
+
+    return false;
+}
+
 function locationToFeature(locationmode, location, features) {
     if (!location || typeof location !== 'string') return false;
 
-    var locationId = locationmodeToIdFinder[locationmode](location);
-    var filteredFeatures;
-    var f, i;
-
+    const locationId = locationmodeToIdFinder[locationmode](location);
     if (locationId) {
+        let filteredFeatures;
         if (locationmode === 'USA-states') {
             // Filter out features out in USA
             //
@@ -50,24 +62,18 @@ function locationToFeature(locationmode, location, features) {
             // which have some overlay in their two-letter ids. For example,
             // 'WA' is used for both Washington state and Western Australia.
             filteredFeatures = [];
-            for (i = 0; i < features.length; i++) {
-                f = features[i];
-                if (f.properties && f.properties.gu && f.properties.gu === 'USA') {
-                    filteredFeatures.push(f);
-                }
+            for (const f of features) {
+                if (f?.properties?.gu === 'USA') filteredFeatures.push(f);
             }
         } else {
             filteredFeatures = features;
         }
 
-        for (i = 0; i < filteredFeatures.length; i++) {
-            f = filteredFeatures[i];
+        for (const f of filteredFeatures) {
             if (f.id === locationId) return f;
         }
 
-        loggers.log(
-            ['Location with id', locationId, 'does not have a matching topojson feature at this resolution.'].join(' ')
-        );
+        loggers.log(`Location with id ${locationId} does not have a matching topojson feature at this resolution.`);
     }
 
     return false;

src/lib/usa_location_names.js

@@ -0,0 +1,60 @@
+'use strict';
+
+// Mapping of lowercase full US state names to two-letter abbreviations
+export const usaLocationList = {
+    alabama: 'AL',
+    alaska: 'AK',
+    arizona: 'AZ',
+    arkansas: 'AR',
+    california: 'CA',
+    colorado: 'CO',
+    connecticut: 'CT',
+    delaware: 'DE',
+    'district of columbia': 'DC',
+    florida: 'FL',
+    georgia: 'GA',
+    hawaii: 'HI',
+    idaho: 'ID',
+    illinois: 'IL',
+    indiana: 'IN',
+    iowa: 'IA',
+    kansas: 'KS',
+    kentucky: 'KY',
+    louisiana: 'LA',
+    maine: 'ME',
+    maryland: 'MD',
+    massachusetts: 'MA',
+    michigan: 'MI',
+    minnesota: 'MN',
+    mississippi: 'MS',
+    missouri: 'MO',
+    montana: 'MT',
+    nebraska: 'NE',
+    nevada: 'NV',
+    'new hampshire': 'NH',
+    'new jersey': 'NJ',
+    'new mexico': 'NM',
+    'new york': 'NY',
+    'north carolina': 'NC',
+    'north dakota': 'ND',
+    ohio: 'OH',
+    oklahoma: 'OK',
+    oregon: 'OR',
+    pennsylvania: 'PA',
+    'rhode island': 'RI',
+    'south carolina': 'SC',
+    'south dakota': 'SD',
+    tennessee: 'TN',
+    texas: 'TX',
+    utah: 'UT',
+    vermont: 'VT',
+    virginia: 'VA',
+    washington: 'WA',
+    'washington dc': 'DC',
+    'washington d.c.': 'DC',
+    'west virginia': 'WV',
+    wisconsin: 'WI',
+    wyoming: 'WY'
+};
+
+export const usaLocationAbbreviations = new Set(Object.values(usaLocationList));

src/traces/scattergeo/attributes.js

@@ -48,7 +48,9 @@ module.exports = overrideAll(
                 'to regions on the map.',
                 'Values *ISO-3*, *USA-states*, *country names* correspond to features on',
                 'the base map and value *geojson-id* corresponds to features from a custom',
-                'GeoJSON linked to the `geojson` attribute.'
+                'GeoJSON linked to the `geojson` attribute.',
+                '*USA-states* accepts both two-letter abbreviations (e.g. *CA*) and',
+                'full state names (e.g. *California*).'
             ].join(' ')
         },