Skip to content

Fix reordering of mapbox raster/image layers on update #5269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 13, 2020
Merged

Fix reordering of mapbox raster/image layers on update #5269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0d1db3f
Refactor to extract lookupBelow and findFollowingMapboxLayerId functions
jonmmease Nov 12, 2020
82fbdcd
Reorder layer in updateImage to match what updateLayer would do
jonmmease Nov 12, 2020
e240ce6
Handle layer.source as arrays in equality check
jonmmease Nov 12, 2020
4054735
Extend the updateImage mapbox test to check layer order
jonmmease Nov 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions src/plots/mapbox/layers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ proto.needsNewSource = function(opts) {
// stay safe and make new source on type changes
return (
this.sourceType !== opts.sourcetype ||
this.source !== opts.source ||
JSON.stringify(this.source) !== JSON.stringify(opts.source) ||
this.layerType !== opts.type
);
};
Expand All @@ -85,11 +85,23 @@ proto.needsNewLayer = function(opts) {
);
};

proto.lookupBelow = function() {
return this.subplot.belowLookup['layout-' + this.index];
};

proto.updateImage = function(opts) {
var map = this.subplot.map;
map.getSource(this.idSource).updateImage({
url: opts.source, coordinates: opts.coordinates
});

// Since the `updateImage` control flow doesn't call updateLayer,
// We need to take care of moving the image layer to match the location
// where updateLayer would have placed it.
var _below = this.findFollowingMapboxLayerId(this.lookupBelow());
if(_below !== null) {
this.subplot.map.moveLayer(this.idLayer, _below);
}
};

proto.updateSource = function(opts) {
Expand All @@ -107,29 +119,29 @@ proto.updateSource = function(opts) {
map.addSource(this.idSource, sourceOpts);
};

proto.updateLayer = function(opts) {
var subplot = this.subplot;
var convertedOpts = convertOpts(opts);

var below = this.subplot.belowLookup['layout-' + this.index];
var _below;

proto.findFollowingMapboxLayerId = function(below) {
if(below === 'traces') {
var mapLayers = subplot.getMapLayers();
var mapLayers = this.subplot.getMapLayers();

// find id of first plotly trace layer
for(var i = 0; i < mapLayers.length; i++) {
var layerId = mapLayers[i].id;
if(typeof layerId === 'string' &&
layerId.indexOf(constants.traceLayerPrefix) === 0
) {
_below = layerId;
below = layerId;
break;
}
}
} else {
_below = below;
}
return below;
};

proto.updateLayer = function(opts) {
var subplot = this.subplot;
var convertedOpts = convertOpts(opts);
var below = this.lookupBelow();
var _below = this.findFollowingMapboxLayerId(below);

this.removeLayer();

Expand Down
28 changes: 25 additions & 3 deletions test/jasmine/tests/mapbox_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -948,10 +948,15 @@ describe('@noCI, mapbox plots', function() {
layout: {
mapbox: {
layers: [{
'sourcetype': 'raster',
'source': ['https://a.tile.openstreetmap.org/{z}/{x}/{y}.png'],
'below': 'traces',
}, {
'sourcetype': 'image',
'coordinates': coords,
'source': source
}]
'source': source,
'below': 'traces',
}],
}
}
};
Expand All @@ -970,7 +975,7 @@ describe('@noCI, mapbox plots', function() {
Plotly.react(gd, makeFigure(redImage)).then(function() {
var mapbox = gd._fullLayout.mapbox._subplot;
map = mapbox.map;
layerSource = map.getSource(mapbox.layerList[0].idSource);
layerSource = map.getSource(mapbox.layerList[1].idSource);

spyOn(layerSource, 'updateImage').and.callThrough();
spyOn(map, 'removeSource').and.callThrough();
Expand All @@ -981,6 +986,23 @@ describe('@noCI, mapbox plots', function() {
{url: greenImage, coordinates: coords}
);
expect(map.removeSource).not.toHaveBeenCalled();

// Check order of layers
var mapbox = gd._fullLayout.mapbox._subplot;
var mapboxLayers = mapbox.getMapLayers();
var plotlyjsLayers = mapbox.layerList;

var indexLower = mapboxLayers.findIndex(function(layer) {
return layer.id === 'plotly-layout-layer-' + plotlyjsLayers[0].uid;
});

var indexUpper = mapboxLayers.findIndex(function(layer) {
return layer.id === 'plotly-layout-layer-' + plotlyjsLayers[1].uid;
});

expect(indexLower).toBeGreaterThan(-1);
expect(indexUpper).toBeGreaterThan(0);
expect(indexUpper).toBe(indexLower + 1);
})
.catch(failTest)
.then(done);
Expand Down