Skip to content

Provide room for large computed margins #5237

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.

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 6 commits into from
Nov 4, 2020
Merged
Changes from all commits
Commits
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
46 changes: 34 additions & 12 deletions src/plots/plots.js
Original file line number Diff line number Diff line change
@@ -1864,6 +1864,9 @@ function initMargins(fullLayout) {
if(!fullLayout._pushmarginIds) fullLayout._pushmarginIds = {};
}

var minFinalWidth = 64; // could possibly be exposed as layout.margin.minfinalwidth
var minFinalHeight = 64; // could possibly be exposed as layout.margin.minfinalheight

/**
* autoMargin: called by components that may need to expand the margins to
* be rendered on-plot.
@@ -1881,6 +1884,10 @@ function initMargins(fullLayout) {
*/
plots.autoMargin = function(gd, id, o) {
var fullLayout = gd._fullLayout;
var width = fullLayout.width;
var height = fullLayout.height;
var maxSpaceW = Math.max(0, width - minFinalWidth);
var maxSpaceH = Math.max(0, height - minFinalHeight);

var pushMargin = fullLayout._pushmargin;
var pushMarginIds = fullLayout._pushmarginIds;
@@ -1900,13 +1907,15 @@ plots.autoMargin = function(gd, id, o) {

// if the item is too big, just give it enough automargin to
// make sure you can still grab it and bring it back
if(o.l + o.r > fullLayout.width * 0.5) {
Lib.log('Margin push', id, 'is too big in x, dropping');
o.l = o.r = 0;
var rW = (o.l + o.r) / maxSpaceW;
if(rW > 1) {
o.l /= rW;
o.r /= rW;
}
if(o.b + o.t > fullLayout.height * 0.5) {
Lib.log('Margin push', id, 'is too big in y, dropping');
o.b = o.t = 0;
var rH = (o.t + o.b) / maxSpaceH;
if(rH > 1) {
o.t /= rH;
o.b /= rH;
}

var xl = o.xl !== undefined ? o.xl : o.x;
@@ -1931,6 +1940,11 @@ plots.autoMargin = function(gd, id, o) {

plots.doAutoMargin = function(gd) {
var fullLayout = gd._fullLayout;
var width = fullLayout.width;
var height = fullLayout.height;
var maxSpaceW = Math.max(0, width - minFinalWidth);
var maxSpaceH = Math.max(0, height - minFinalHeight);

if(!fullLayout._size) fullLayout._size = {};
initMargins(fullLayout);

@@ -1945,8 +1959,6 @@ plots.doAutoMargin = function(gd) {
var mr = margin.r;
var mt = margin.t;
var mb = margin.b;
var width = fullLayout.width;
var height = fullLayout.height;
var pushMargin = fullLayout._pushmargin;
var pushMarginIds = fullLayout._pushmarginIds;

@@ -1978,11 +1990,10 @@ plots.doAutoMargin = function(gd) {
if(isNumeric(pl) && pushMargin[k2].r) {
var fr = pushMargin[k2].r.val;
var pr = pushMargin[k2].r.size;

if(fr > fl) {
var newL = (pl * fr + (pr - width) * fl) / (fr - fl);
var newR = (pr * (1 - fl) + (pl - width) * (1 - fr)) / (fr - fl);
if(newL >= 0 && newR >= 0 && width - (newL + newR) > 0 && newL + newR > ml + mr) {
if(newL + newR > ml + mr) {
ml = newL;
mr = newR;
}
@@ -1992,11 +2003,10 @@ plots.doAutoMargin = function(gd) {
if(isNumeric(pb) && pushMargin[k2].t) {
var ft = pushMargin[k2].t.val;
var pt = pushMargin[k2].t.size;

if(ft > fb) {
var newB = (pb * ft + (pt - height) * fb) / (ft - fb);
var newT = (pt * (1 - fb) + (pb - height) * (1 - ft)) / (ft - fb);
if(newB >= 0 && newT >= 0 && height - (newT + newB) > 0 && newB + newT > mb + mt) {
if(newB + newT > mb + mt) {
mb = newB;
mt = newT;
}
@@ -2006,6 +2016,18 @@ plots.doAutoMargin = function(gd) {
}
}

var rW = (ml + mr) / maxSpaceW;
if(rW > 1) {
ml /= rW;
mr /= rW;
}

var rH = (mb + mt) / maxSpaceH;
if(rH > 1) {
mb /= rH;
mt /= rH;
}

gs.l = Math.round(ml);
gs.r = Math.round(mr);
gs.t = Math.round(mt);
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added test/image/baselines/automargin-large-margins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified test/image/baselines/legend_small_horizontal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions test/image/mocks/automargin-large-margins-both-sides.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"data": [{
"name": "< D E A T H >",
"marker": { "color": "red" },
"y": [
"Antonio Vivaldi",
"Johann Sebastian Bach",
"Wolfgang Amadeus Mozart",
"Ludwig van Beethoven"
],
"x": [
"1741",
"1750",
"1791",
"1827"
]
},
{
"name": "< B I R T H >",
"marker": { "color": "blue" },
"y": [
"Antonio Vivaldi",
"Johann Sebastian Bach",
"Wolfgang Amadeus Mozart",
"Ludwig van Beethoven"
],
"x": [
"1678",
"1685",
"1756",
"1770"
]
}],
"layout": {
"title": {
"text": "Longest and shortest<br>names and time periods"
},
"width": 200,
"height": 200,
"margin": {
"t": 80,
"b": 20,
"l": 20,
"r": 20
},
"xaxis": {
"type": "date",
"automargin": true
},
"yaxis": {
"automargin": true
}
}
}
55 changes: 55 additions & 0 deletions test/image/mocks/automargin-large-margins-horizontal.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"data": [{
"name": "< D E A T H >",
"marker": { "color": "red" },
"y": [
"Antonio Vivaldi",
"Johann Sebastian Bach",
"Wolfgang Amadeus Mozart",
"Ludwig van Beethoven"
],
"x": [
"1741",
"1750",
"1791",
"1827"
]
},
{
"name": "< B I R T H >",
"marker": { "color": "blue" },
"y": [
"Antonio Vivaldi",
"Johann Sebastian Bach",
"Wolfgang Amadeus Mozart",
"Ludwig van Beethoven"
],
"x": [
"1678",
"1685",
"1756",
"1770"
]
}],
"layout": {
"showlegend": false,
"title": {
"text": "Longest and shortest<br>names and time periods"
},
"width": 240,
"height": 200,
"margin": {
"t": 80,
"b": 20,
"l": 20,
"r": 20
},
"xaxis": {
"type": "date",
"automargin": true
},
"yaxis": {
"automargin": true
}
}
}
54 changes: 54 additions & 0 deletions test/image/mocks/automargin-large-margins.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"data": [{
"name": "< D E A T H >",
"marker": { "color": "red" },
"x": [
"Antonio Vivaldi",
"Johann Sebastian Bach",
"Wolfgang Amadeus Mozart",
"Ludwig van Beethoven"
],
"y": [
"1741",
"1750",
"1791",
"1827"
]
},
{
"name": "< B I R T H >",
"marker": { "color": "blue" },
"x": [
"Antonio Vivaldi",
"Johann Sebastian Bach",
"Wolfgang Amadeus Mozart",
"Ludwig van Beethoven"
],
"y": [
"1678",
"1685",
"1756",
"1770"
]
}],
"layout": {
"title": {
"text": "Longest and shortest<br>names and time periods"
},
"width": 240,
"height": 300,
"margin": {
"t": 80,
"b": 20,
"l": 20,
"r": 20
},
"yaxis": {
"type": "date",
"automargin": true
},
"xaxis": {
"automargin": true
}
}
}
4 changes: 2 additions & 2 deletions test/jasmine/tests/axes_test.js
Original file line number Diff line number Diff line change
@@ -3856,7 +3856,7 @@ describe('Test axes', function() {
.then(function() { return Plotly.relayout(gd, 'height', 100); })
.then(function() {
_assert('after relayout to *small* height', {
bottomLowerBound: 30,
bottomLowerBound: 15,
totalHeight: 100
});
})
@@ -3896,7 +3896,7 @@ describe('Test axes', function() {
.then(function() { return Plotly.relayout(gd, 'width', 100); })
.then(function() {
_assert('after relayout to *small* width', {
leftLowerBound: 30,
leftLowerBound: 15,
totalWidth: 100
});
})
2 changes: 1 addition & 1 deletion test/jasmine/tests/indicator_test.js
Original file line number Diff line number Diff line change
@@ -171,7 +171,7 @@ describe('Indicator plot', function() {
return Plotly.relayout(gd, {width: 200, height: 200});
})
.then(function() {
checkNumbersScale(0.2, 'should scale down');
checkNumbersScale(0.4794007490636704, 'should scale down');
return Plotly.relayout(gd, {width: 400, height: 400});
})
.then(function() {
2 changes: 1 addition & 1 deletion test/jasmine/tests/legend_scroll_test.js
Original file line number Diff line number Diff line change
@@ -405,7 +405,7 @@ describe('The legend', function() {
expect(countLegendClipPaths(gd)).toBe(1);

// clippath resized to new height less than new plot height
expect(+legendHeight).toBe(getPlotHeight(gd));
expect(+legendHeight).toBeGreaterThan(getPlotHeight(gd));
expect(+legendHeight).toBeLessThan(+origLegendHeight);

done();
6 changes: 6 additions & 0 deletions test/jasmine/tests/mock_test.js
Original file line number Diff line number Diff line change
@@ -39,6 +39,9 @@ var list = [
'annotations',
'annotations-autorange',
'arrow-markers',
'automargin-large-margins',
'automargin-large-margins-both-sides',
'automargin-large-margins-horizontal',
'automargin-mirror-all',
'automargin-mirror-allticks',
'automargin-multiline-titles',
@@ -1103,6 +1106,9 @@ figs['animation_bar'] = require('@mocks/animation_bar');
// figs['annotations'] = require('@mocks/annotations');
// figs['annotations-autorange'] = require('@mocks/annotations-autorange');
figs['arrow-markers'] = require('@mocks/arrow-markers');
figs['automargin-large-margins'] = require('@mocks/automargin-large-margins');
figs['automargin-large-margins-both-sides'] = require('@mocks/automargin-large-margins-both-sides');
figs['automargin-large-margins-horizontal'] = require('@mocks/automargin-large-margins-horizontal');
figs['automargin-mirror-all'] = require('@mocks/automargin-mirror-all');
figs['automargin-mirror-allticks'] = require('@mocks/automargin-mirror-allticks');
figs['automargin-multiline-titles'] = require('@mocks/automargin-multiline-titles');