migrate to maplibre

plotly · archmoj · Aug 8, 2024 · Jun 5, 2024 · Jun 5, 2024 · Jun 5, 2024
commit 54408b203907f24ce74c77b00a967d0253ca96b8
diff --git a/.circleci/test.sh b/.circleci/test.sh
@@ -95,7 +95,7 @@ case $1 in
     make-baselines-virtual-webgl)
         SUITE=$({\
                   find $ROOT/test/image/mocks/gl*     -type f -printf "%f\n"; \
-                  find $ROOT/test/image/mocks/mapbox* -type f -printf "%f\n"; \
+                  find $ROOT/test/image/mocks/maplibre* -type f -printf "%f\n"; \
                 } | sed 's/\.json$//1' | circleci tests split)
         python3 test/image/make_baseline.py virtual-webgl $SUITE || EXIT_STATE=$?
         exit $EXIT_STATE

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -382,7 +382,7 @@ Other methods used by some trace modules:
   selections.
 - `_module.convert`: Sometimes separated from `_module.plot` or `_module.calc` to convert the
   plotly.js settings to another framework e.g. to `gl-plot3d` for `gl3d` traces, to
-  `mapbox-gl` from `mapbox` traces. This split can make the logic easier to test.
+  `maplibre-gl` from `maplibre` traces. This split can make the logic easier to test.
   If you make a `convert`, you should call it from either `calc` or `plot`.
 
 ## Coding style

diff --git a/devtools/test_dashboard/devtools.js b/devtools/test_dashboard/devtools.js
@@ -19,10 +19,6 @@ var Tabs = {
             // use local topojson files
             topojsonURL: '../../node_modules/sane-topojson/dist/',
 
-            // register mapbox access token
-            // run `npm run preset` if you haven't yet
-            mapboxAccessToken: credentials.MAPBOX_ACCESS_TOKEN,
-
             // show all logs in console
             logging: 2
         });

diff --git a/lib/choroplethmapbox.js b/lib/choroplethmapbox.js
diff --git a/lib/choroplethmaplibre.js b/lib/choroplethmaplibre.js
@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('../src/traces/choroplethmaplibre');
diff --git a/lib/densitymapbox.js b/lib/densitymapbox.js
diff --git a/lib/densitymaplibre.js b/lib/densitymaplibre.js
@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('../src/traces/densitymaplibre');
diff --git a/lib/index-mapbox.js b/lib/index-mapbox.js
@@ -4,9 +4,9 @@ var Plotly = require('./core');
 
 Plotly.register([
     // traces
-    require('./scattermapbox'),
-    require('./choroplethmapbox'),
-    require('./densitymapbox'),
+    require('./scattermaplibre'),
+    require('./choroplethmaplibre'),
+    require('./densitymaplibre'),
 
     // transforms
     require('./aggregate'),

diff --git a/lib/index-maplibre.js b/lib/index-maplibre.js
@@ -0,0 +1,21 @@
+'use strict';
+
+var Plotly = require('./core');
+
+Plotly.register([
+    // traces
+    require('./scattermaplibre'),
+    require('./choroplethmaplibre'),
+    require('./densitymaplibre'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars'),
+]);
+
+module.exports = Plotly;
diff --git a/lib/index-strict.js b/lib/index-strict.js
@@ -36,9 +36,9 @@ Plotly.register([
     require('./heatmapgl'),
     require('../src/traces/parcoords/strict'),
     require('./parcats'),
-    require('./scattermapbox'),
-    require('./choroplethmapbox'),
-    require('./densitymapbox'),
+    require('./scattermaplibre'),
+    require('./choroplethmaplibre'),
+    require('./densitymaplibre'),
     require('./sankey'),
     require('./indicator'),
     require('./table'),

diff --git a/lib/index.js b/lib/index.js
@@ -36,9 +36,9 @@ Plotly.register([
     require(&#
BD94
39;./heatmapgl'),
     require('./parcoords'),
     require('./parcats'),
-    require('./scattermapbox'),
-    require('./choroplethmapbox'),
-    require('./densitymapbox'),
+    require('./scattermaplibre'),
+    require('./choroplethmaplibre'),
+    require('./densitymaplibre'),
     require('./sankey'),
     require('./indicator'),
     require('./table'),

diff --git a/lib/locales/si.js b/lib/locales/si.js
diff --git a/lib/scattermapbox.js b/lib/scattermapbox.js
diff --git a/lib/scattermaplibre.js b/lib/scattermaplibre.js
@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('../src/traces/scattermaplibre');
diff --git a/src/components/fx/hover.js b/src/components/fx/hover.js
@@ -1555,7 +1555,7 @@ function getHoverLabelText(d, showCommonLabel, hovermode, fullLayout, t0, g) {
     if(d.zLabel !== undefined) {
         if(d.xLabel !== undefined) text += 'x: ' + d.xLabel + '<br>';
         if(d.yLabel !== undefined) text += 'y: ' + d.yLabel + '<br>';
-        if(d.trace.type !== 'choropleth' && d.trace.type !== 'choroplethmapbox') {
+        if(d.trace.type !== 'choropleth' && d.trace.type !== 'choroplethmaplibre') {
             text += (text ? 'z: ' : '') + d.zLabel;
         }
     } else if(showCommonLabel && d[h0 + 'Label'] === t0) {

diff --git a/src/components/fx/layout_defaults.js b/src/components/fx/layout_defaults.js
@@ -19,16 +19,16 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
     var dragMode = coerce('dragmode');
     if(dragMode === 'select') coerce('selectdirection');
 
-    // if only mapbox or geo subplots is present on graph,
+    // if only maplibre or geo subplots is present on graph,
     // reset 'zoom' dragmode to 'pan' until 'zoom' is implemented,
     // so that the correct modebar button is active
-    var hasMapbox = layoutOut._has('mapbox');
+    var hasMapLibre = layoutOut._has('maplibre');
     var hasGeo = layoutOut._has('geo');
     var len = layoutOut._basePlotModules.length;
 
     if(layoutOut.dragmode === 'zoom' && (
-        ((hasMapbox || hasGeo) && len === 1) ||
-        (hasMapbox && hasGeo && len === 2)
+        ((hasMapLibre || hasGeo) && len === 1) ||
+        (hasMapLibre && hasGeo && len === 2)
     )) {
         layoutOut.dragmode = 'pan';
     }

diff --git a/src/components/legend/style.js b/src/components/legend/style.js
@@ -541,13 +541,13 @@ module.exports = function style(s, gd, legend) {
                     useGradient = true;
                     break;
                 case 'choropleth' :
-                case 'choroplethmapbox' :
+                case 'choroplethmaplibre' :
                     ptsData = [
                         ['M-6,-6V6H6V-6Z']
                     ];
                     useGradient = true;
                     break;
-                case 'densitymapbox' :
+                case 'densitymaplibre' :
                     ptsData = [
                         ['M-6,0 a6,6 0 1,0 12,0 a 6,6 0 1,0 -12,0']
                     ];

diff --git a/src/components/modebar/buttons.js b/src/components/modebar/buttons.js
@@ -651,7 +651,7 @@ modeBarButtons.resetViews = {
         handleCamera3d(gd, ev);
 
         resetView(gd, 'geo');
-        resetView(gd, 'mapbox');
+        resetView(gd, 'maplibre');
     }
 };
 
@@ -684,42 +684,42 @@ function setSpikelineVisibility(gd) {
     return aobj;
 }
 
-modeBarButtons.resetViewMapbox = {
-    name: 'resetViewMapbox',
+modeBarButtons.resetViewMapLibre = {
+    name: 'resetViewMapLibre',
     _cat: 'resetView',
     title: function(gd) { return _(gd, 'Reset view'); },
     attr: 'reset',
     icon: Icons.home,
     click: function(gd) {
-        resetView(gd, 'mapbox');
+        resetView(gd, 'maplibre');
     }
 };
 
-modeBarButtons.zoomInMapbox = {
-    name: 'zoomInMapbox',
+modeBarButtons.zoomInMapLibre = {
+    name: 'zoomInMapLibre',
     _cat: 'zoomin',
     title: function(gd) { return _(gd, 'Zoom in'); },
     attr: 'zoom',
     val: 'in',
     icon: Icons.zoom_plus,
-    click: handleMapboxZoom
+    click: handleMapLibreZoom
 };
 
-modeBarButtons.zoomOutMapbox = {
-    name: 'zoomOutMapbox',
+modeBarButtons.zoomOutMapLibre = {
+    name: 'zoomOutMapLibre',
     _cat: 'zoomout',
     title: function(gd) { return _(gd, 'Zoom out'); },
     attr: 'zoom',
     val: 'out',
     icon: Icons.zoom_minus,
-    click: handleMapboxZoom
+    click: handleMapLibreZoom
 };
 
-function handleMapboxZoom(gd, ev) {
+function handleMapLibreZoom(gd, ev) {
     var button = ev.currentTarget;
     var val = button.getAttribute('data-val');
     var fullLayout = gd._fullLayout;
-    var subplotIds = fullLayout._subplots.mapbox || [];
+    var subplotIds = fullLayout._subplots.maplibre || [];
     var scalar = 1.05;
     var aObj = {};
 

diff --git a/src/components/modebar/manage.js b/src/components/modebar/manage.js
@@ -109,7 +109,7 @@ function getButtonGroups(gd) {
     var hasFunnelarea = fullLayout._has('funnelarea');
     var hasGL2D = fullLayout._has('gl2d');
     var hasTernary = fullLayout._has('ternary');
-    var hasMapbox = fullLayout._has('mapbox');
+    var hasMapLibre = fullLayout._has('maplibre');
     var hasPolar = fullLayout._has('polar');
     var hasSmith = fullLayout._has('smith');
     var hasSankey = fullLayout._has('sankey');
@@ -154,7 +154,7 @@ function getButtonGroups(gd) {
     var resetGroup = [];
     var dragModeGroup = [];
 
-    if((hasCartesian || hasGL2D || hasPie || hasFunnelarea || hasTernary) + hasGeo + hasGL3D + hasMapbox + hasPolar + hasSmith > 1) {
+    if((hasCartesian || hasGL2D || hasPie || hasFunnelarea || hasTernary) + hasGeo + hasGL3D + hasMapLibre + hasPolar + hasSmith > 1) {
         // graphs with more than one plot types get 'union buttons'
         // which reset the view or toggle hover labels across all subplots.
         hoverGroup = ['toggleHover'];
@@ -166,10 +166,10 @@ function getButtonGroups(gd) {
     } else if(hasGL3D) {
         hoverGroup = ['hoverClosest3d'];
         resetGroup = ['resetCameraDefault3d', 'resetCameraLastSave3d'];
-    } else if(hasMapbox) {
-        zoomGroup = ['zoomInMapbox', 'zoomOutMapbox'];
+    } else if(hasMapLibre) {
+        zoomGroup = ['zoomInMapLibre', 'zoomOutMapLibre'];
         hoverGroup = ['toggleHover'];
-        resetGroup = ['resetViewMapbox'];
+        resetGroup = ['resetViewMapLibre'];
     } else if(hasGL2D) {
         hoverGroup = ['hoverClosestGl2d'];
     } else if(hasPie) {
@@ -200,7 +200,7 @@ function getButtonGroups(gd) {
         dragModeGroup = ['zoom3d', 'pan3d', 'orbitRotation', 'tableRotation'];
     } else if(((hasCartesian || hasGL2D) && !allAxesFixed) || hasTernary) {
         dragModeGroup = ['zoom2d', 'pan2d'];
-    } else if(hasMapbox || hasGeo) {
+    } else if(hasMapLibre || hasGeo) {
         dragModeGroup = ['pan2d'];
     } else if(hasPolar) {
         dragModeGroup = ['zoom2d'];
@@ -228,7 +228,7 @@ function getButtonGroups(gd) {
                 if(DRAW_MODES.indexOf(b) !== -1) {
                     // accept pre-defined drag modes i.e. shape drawing features as string
                     if(
-                        fullLayout._has('mapbox') || // draw shapes in paper coordinate (could be improved in future to support data coordinate, when there is no pitch)
+                        fullLayout._has('maplibre') || // draw shapes in paper coordinate (could be improved in future to support data coordinate, when there is no pitch)
                         fullLayout._has('cartesian') // draw shapes in data coordinate
                     ) {
                         dragModeGroup.push(b);

diff --git a/src/components/selections/select.js b/src/components/selections/select.js
@@ -752,7 +752,7 @@ function clearSelectionsCache(dragOptions, immediateSelect) {
             var selections;
             if(
                 isSelectMode &&
-                !hasSubplot(dragOptions) // only allow cartesian - no mapbox for now
+                !hasSubplot(dragOptions) // only allow cartesian - no maplibre for now
             ) {
                 selections = newSelections(outlines, dragOptions);
             }
@@ -1549,7 +1549,7 @@ function getFillRangeItems(dragOptions) {
     var plotinfo = dragOptions.plotinfo;
 
     return (
-        plotinfo.fillRangeItems || // allow subplots (i.e. geo, mapbox, sankey) to override fillRangeItems routine
+        plotinfo.fillRangeItems || // allow subplots (i.e. geo, maplibre, sankey) to override fillRangeItems routine
         makeFillRangeItems(dragOptions.xaxes.concat(dragOptions.yaxes))
     );
 }

diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -517,7 +517,7 @@ function setPlotContext(gd, config) {
         szOut.cartesian = 1;
         szOut.gl3d = 1;
         szOut.geo = 1;
-        szOut.mapbox = 1;
+        szOut.maplibre = 1;
     } else if(typeof szIn === 'string') {
         var parts = szIn.split('+');
         for(i = 0; i < parts.length; i++) {
@@ -526,7 +526,7 @@ function setPlotContext(gd, config) {
     } else if(szIn !== false) {
         szOut.gl3d = 1;
         szOut.geo = 1;
-        szOut.mapbox = 1;
+        szOut.maplibre = 1;
     }
 }
 
@@ -2387,7 +2387,7 @@ var layoutUIControlPatterns = [
     {pattern: /^(ternary\d*\.[abc]axis)\.(min|title\.text)$/},
     {pattern: /^(polar\d*\.radialaxis)\.((auto)?range|angle|title\.text)/},
     {pattern: /^(polar\d*\.angularaxis)\.rotation/},
-    {pattern: /^(mapbox\d*)\.(center|zoom|bearing|pitch)/},
+    {pattern: /^(maplibre\d*)\.(center|zoom|bearing|pitch)/},
 
     {pattern: /^legend\.(x|y)$/, attr: 'editrevision'},
     {pattern: /^(shapes|annotations)/, attr: 'editrevision'},

diff --git a/src/plot_api/plot_config.js b/src/plot_api/plot_config.js
@@ -157,12 +157,12 @@ var configAttributes = {
 
     scrollZoom: {
         valType: 'flaglist',
-        flags: ['cartesian', 'gl3d', 'geo', 'mapbox'],
+        flags: ['cartesian', 'gl3d', 'geo', 'maplibre'],
         extras: [true, false],
-        dflt: 'gl3d+geo+mapbox',
+        dflt: 'gl3d+geo+maplibre',
         description: [
             'Determines whether mouse wheel or two-finger scroll zooms is enable.',
-            'Turned on by default for gl3d, geo and mapbox subplots',
+            'Turned on by default for gl3d, geo and maplibre subplots',
             '(as these subplot types do not have zoombox via pan),',
             'but turned off by default for cartesian subplots.',
             'Set `scrollZoom` to *false* to disable scrolling for all subplots.'
@@ -192,7 +192,7 @@ var configAttributes = {
             'This is the time interval (in ms) between first mousedown and',
             '2nd mouseup to constitute a double-click.',
             'This setting propagates to all on-subplot double clicks',
-            '(except for geo and mapbox) and on-legend double clicks.'
+            '(except for geo and maplibre) and on-legend double clicks.'
         ].join(' ')
     },
 
@@ -382,16 +382,6 @@ var configAttributes = {
         ].join(' ')
     },
 
-    mapboxAccessToken: {
-        valType: 'string',
-        dflt: null,
-        description: [
-            'Mapbox access token (required to plot mapbox trace types)',
-            'If using an Mapbox Atlas server, set this option to \'\'',
-            'so that plotly.js won\'t attempt to authenticate to the public Mapbox server.'
-        ].join(' ')
-    },
-
     logging: {
         valType: 'integer',
         min: 0,

diff --git a/src/plots/geo/geo.js b/src/plots/geo/geo.js
@@ -526,7 +526,7 @@ proto.updateFx = function(fullLayout, geoLayout) {
             }
 
             if(clickMode.indexOf('event') > -1) {
-                // TODO: like pie and mapbox, this doesn't support right-click
+                // TODO: like pie and maplibre, this doesn't support right-click
                 // actually this one is worse, as right-click starts a pan, or leaves
                 // select in a weird state.
                 // Also, only tangentially related, we should cancel hover during pan
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		'use strict';

		module.exports = require('../src/traces/choroplethmaplibre');