Skip to content

Fix shapes and images referencing a missing subplot #1481

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 3 commits into from
Mar 16, 2017
Merged

Fix shapes and images referencing a missing subplot #1481

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd62f54
fix images and shapes that reference missing subplots
alexcjohnson Mar 15, 2017
7146543
clean up image sources to avoid extraneous log messages
alexcjohnson Mar 15, 2017
9369bc3
:hocho: commented-out code
alexcjohnson Mar 15, 2017
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
9 changes: 9 additions & 0 deletions src/components/images/draw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ module.exports = function draw(gd) {
subplot = img.xref + img.yref;

var plotinfo = fullLayout._plots[subplot];

if(!plotinfo) {
// Fall back to _imageLowerLayer in case the requested subplot doesn't exist.
// This can happen if you reference the image to an x / y axis combination
// that doesn't have any data on it (and layer is below)
imageDataBelow.push(img);
continue;
}

if(plotinfo.mainplot) {
subplot = plotinfo.mainplot.id;
}
Expand Down
15 changes: 11 additions & 4 deletions src/components/shapes/draw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,17 @@ function drawOne(gd, index) {
drawShape(gd._fullLayout._shapeLowerLayer);
}
else {
var plotinfo = gd._fullLayout._plots[options.xref + options.yref],
mainPlot = plotinfo.mainplot || plotinfo;

drawShape(mainPlot.shapelayer);
var plotinfo = gd._fullLayout._plots[options.xref + options.yref];
if(plotinfo) {
var mainPlot = plotinfo.mainplot || plotinfo;
drawShape(mainPlot.shapelayer);
}
else {
// Fall back to _shapeLowerLayer in case the requested subplot doesn't exist.
// This can happen if you reference the shape to an x / y axis combination
// that doesn't have any data on it (and layer is below)
drawShape(gd._fullLayout._shapeLowerLayer);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

I see that annotations don't need a similar fix. @alexcjohnson Can I ask why?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Annotations don't have the concept of layer. They're always on top.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. That makes sense 👍

}
}

function drawShape(shapeLayer) {
Expand Down
37 changes: 31 additions & 6 deletions test/jasmine/tests/layout_images_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ describe('Layout images', function() {
it('should draw images on the right layers', function() {

Plotly.plot(gd, data, { images: [{
source: 'imageabove',
source: jsLogo,
Copy link
Collaborator Author

@alexcjohnson alexcjohnson Mar 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were generating 404 warnings when you run the tests, which seem distracting and unnecessary, so I just put in jsLogo everywhere.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice touch 👌

layer: 'above'
}]});

Expand All @@ -116,7 +116,7 @@ describe('Layout images', function() {
destroyGraphDiv();
gd = createGraphDiv();
Plotly.plot(gd, data, { images: [{
source: 'imagebelow',
source: jsLogo,
layer: 'below'
}]});

Expand All @@ -125,7 +125,7 @@ describe('Layout images', function() {
destroyGraphDiv();
gd = createGraphDiv();
Plotly.plot(gd, data, { images: [{
source: 'imagesubplot',
source: jsLogo,
layer: 'below',
xref: 'x',
yref: 'y'
Expand All @@ -134,12 +134,37 @@ describe('Layout images', function() {
checkLayers(0, 0, 1);
});

it('should fall back on imageLowerLayer for below missing subplots', function() {
Plotly.newPlot(gd, [
{x: [1, 3], y: [1, 3]},
{x: [1, 3], y: [1, 3], xaxis: 'x2', yaxis: 'y2'}
], {
xaxis: {domain: [0, 0.5]},
yaxis: {domain: [0, 0.5]},
xaxis2: {domain: [0.5, 1], anchor: 'y2'},
yaxis2: {domain: [0.5, 1], anchor: 'x2'},
images: [{
source: jsLogo,
layer: 'below',
xref: 'x',
yref: 'y2'
}, {
source: jsLogo,
layer: 'below',
xref: 'x2',
yref: 'y'
}]
});

checkLayers(0, 2, 0);
});

describe('with anchors and sizing', function() {

function testAspectRatio(xAnchor, yAnchor, sizing, expected) {
var anchorName = xAnchor + yAnchor;
// var anchorName = xAnchor + yAnchor;
Plotly.plot(gd, data, { images: [{
source: anchorName,
source: jsLogo,
xanchor: xAnchor,
yanchor: yAnchor,
sizing: sizing
Expand Down Expand Up @@ -405,7 +430,7 @@ describe('images log/linear axis changes', function() {
],
layout: {
images: [{
source: 'https://images.plot.ly/language-icons/api-home/python-logo.png',
source: pythonLogo,
x: 1,
y: 1,
xref: 'x',
Expand Down
157 changes: 100 additions & 57 deletions test/jasmine/tests/shapes_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,75 +103,75 @@ describe('Test shapes defaults:', function() {
});
});

describe('Test shapes:', function() {
'use strict';
function countShapesInLowerLayer(gd) {
return gd._fullLayout.shapes.filter(isShapeInLowerLayer).length;
}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved these helpers to the root level so I could use them in a different describe block (which wants to set up a different plot in gd)


var mock = require('@mocks/shapes.json');
var gd;
function countShapesInUpperLayer(gd) {
return gd._fullLayout.shapes.filter(isShapeInUpperLayer).length;
}

beforeEach(function(done) {
gd = createGraphDiv();
function countShapesInSubplots(gd) {
return gd._fullLayout.shapes.filter(isShapeInSubplot).length;
}

var mockData = Lib.extendDeep([], mock.data),
mockLayout = Lib.extendDeep({}, mock.layout);
function isShapeInUpperLayer(shape) {
return shape.layer !== 'below';
}

Plotly.plot(gd, mockData, mockLayout).then(done);
});
function isShapeInLowerLayer(shape) {
return (shape.xref === 'paper' && shape.yref === 'paper') &&
!isShapeInUpperLayer(shape);
}

afterEach(destroyGraphDiv);
function isShapeInSubplot(shape) {
return !isShapeInUpperLayer(shape) && !isShapeInLowerLayer(shape);
}

function countShapesInLowerLayer() {
return gd._fullLayout.shapes.filter(isShapeInLowerLayer).length;
}
function countShapeLowerLayerNodes() {
return d3.selectAll('.layer-below > .shapelayer').size();
}

function countShapesInUpperLayer() {
return gd._fullLayout.shapes.filter(isShapeInUpperLayer).length;
}
function countShapeUpperLayerNodes() {
return d3.selectAll('.layer-above > .shapelayer').size();
}

function countShapesInSubplots() {
return gd._fullLayout.shapes.filter(isShapeInSubplot).length;
}
function countShapeLayerNodesInSubplots() {
return d3.selectAll('.layer-subplot').size();
}

function isShapeInUpperLayer(shape) {
return shape.layer !== 'below';
}
function countSubplots(gd) {
return Object.keys(gd._fullLayout._plots || {}).length;
}

function isShapeInLowerLayer(shape) {
return (shape.xref === 'paper' && shape.yref === 'paper') &&
!isShapeInUpperLayer(shape);
}
function countShapePathsInLowerLayer() {
return d3.selectAll('.layer-below > .shapelayer > path').size();
}

function isShapeInSubplot(shape) {
return !isShapeInUpperLayer(shape) && !isShapeInLowerLayer(shape);
}
function countShapePathsInUpperLayer() {
return d3.selectAll('.layer-above > .shapelayer > path').size();
}

function countShapeLowerLayerNodes() {
return d3.selectAll('.layer-below > .shapelayer').size();
}
function countShapePathsInSubplots() {
return d3.selectAll('.layer-subplot > .shapelayer > path').size();
}

function countShapeUpperLayerNodes() {
return d3.selectAll('.layer-above > .shapelayer').size();
}
describe('Test shapes:', function() {
'use strict';

function countShapeLayerNodesInSubplots() {
return d3.selectAll('.layer-subplot').size();
}
var mock = require('@mocks/shapes.json');
var gd;

function countSubplots(gd) {
return Object.keys(gd._fullLayout._plots || {}).length;
}
beforeEach(function(done) {
gd = createGraphDiv();

function countShapePathsInLowerLayer() {
return d3.selectAll('.layer-below > .shapelayer > path').size();
}
var mockData = Lib.extendDeep([], mock.data),
mockLayout = Lib.extendDeep({}, mock.layout);

function countShapePathsInUpperLayer() {
return d3.selectAll('.layer-above > .shapelayer > path').size();
}
Plotly.plot(gd, mockData, mockLayout).then(done);
});

function countShapePathsInSubplots() {
return d3.selectAll('.layer-subplot > .shapelayer > path').size();
}
afterEach(destroyGraphDiv);

describe('*shapeLowerLayer*', function() {
it('has one node', function() {
Expand All @@ -180,14 +180,14 @@ describe('Test shapes:', function() {

it('has as many *path* nodes as shapes in the lower layer', function() {
expect(countShapePathsInLowerLayer())
.toEqual(countShapesInLowerLayer());
.toEqual(countShapesInLowerLayer(gd));
});

it('should be able to get relayout', function(done) {
Plotly.relayout(gd, {height: 200, width: 400}).then(function() {
expect(countShapeLowerLayerNodes()).toEqual(1);
expect(countShapePathsInLowerLayer())
.toEqual(countShapesInLowerLayer());
.toEqual(countShapesInLowerLayer(gd));
})
.catch(failTest)
.then(done);
Expand All @@ -201,14 +201,14 @@ describe('Test shapes:', function() {

it('has as many *path* nodes as shapes in the upper layer', function() {
expect(countShapePathsInUpperLayer())
.toEqual(countShapesInUpperLayer());
.toEqual(countShapesInUpperLayer(gd));
});

it('should be able to get relayout', function(done) {
Plotly.relayout(gd, {height: 200, width: 400}).then(function() {
expect(countShapeUpperLayerNodes()).toEqual(1);
expect(countShapePathsInUpperLayer())
.toEqual(countShapesInUpperLayer());
.toEqual(countShapesInUpperLayer(gd));
})
.catch(failTest)
.then(done);
Expand All @@ -223,15 +223,15 @@ describe('Test shapes:', function() {

it('has as many *path* nodes as shapes in the subplot', function() {
expect(countShapePathsInSubplots())
.toEqual(countShapesInSubplots());
.toEqual(countShapesInSubplots(gd));
});

it('should be able to get relayout', function(done) {
Plotly.relayout(gd, {height: 200, width: 400}).then(function() {
expect(countShapeLayerNodesInSubplots())
.toEqual(countSubplots(gd));
expect(countShapePathsInSubplots())
.toEqual(countShapesInSubplots());
.toEqual(countShapesInSubplots(gd));
})
.catch(failTest)
.then(done);
Expand Down Expand Up @@ -464,6 +464,49 @@ describe('shapes axis reference changes', function() {
});
});

describe('shapes edge cases', function() {
'use strict';

var gd;

beforeAll(function() {
jasmine.addMatchers(customMatchers);
});

beforeEach(function() { gd = createGraphDiv(); });

afterEach(destroyGraphDiv);

it('falls back on shapeLowerLayer for below missing subplots', function(done) {
Plotly.newPlot(gd, [
{x: [1, 3], y: [1, 3]},
{x: [1, 3], y: [1, 3], xaxis: 'x2', yaxis: 'y2'}
], {
xaxis: {domain: [0, 0.5]},
yaxis: {domain: [0, 0.5]},
xaxis2: {domain: [0.5, 1], anchor: 'y2'},
yaxis2: {domain: [0.5, 1], anchor: 'x2'},
shapes: [{
x0: 1, x1: 2, y0: 1, y1: 2, type: 'circle',
layer: 'below',
xref: 'x',
yref: 'y2'
}, {
x0: 1, x1: 2, y0: 1, y1: 2, type: 'circle',
layer: 'below',
xref: 'x2',
yref: 'y'
}]
}).then(function() {
expect(countShapePathsInLowerLayer()).toBe(2);
expect(countShapePathsInUpperLayer()).toBe(0);
expect(countShapePathsInSubplots()).toBe(0);
})
.catch(failTest)
.then(done);
});
});

describe('shapes autosize', function() {
'use strict';

Expand Down