Skip to content

Commit ccd68c6

Browse files
gvwilsongvwilson
authored
Merge pull request #7269 from my-tien/zeroline-layer
Property `zerolinelayer` for cartesian axes
2 parents bcbb64a + f759154 commit ccd68c6

File tree

11 files changed

+170
-6
lines changed

11 files changed

+170
-6
lines changed

‎draftlogs/7269_add.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- Add property `zerolinelayer` to cartesian axes to allow drawing zeroline above traces [[#7269](https://github.com/plotly/plotly.js/pull/7269)]

‎src/plots/cartesian/axes.js‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2365,6 +2365,7 @@ axes.draw = function(gd, arg, opts) {
23652365
if(plotinfo.minorGridlayer) plotinfo.minorGridlayer.selectAll('path').remove();
23662366
if(plotinfo.gridlayer) plotinfo.gridlayer.selectAll('path').remove();
23672367
if(plotinfo.zerolinelayer) plotinfo.zerolinelayer.selectAll('path').remove();
2368+
if(plotinfo.zerolinelayerAbove) plotinfo.zerolinelayerAbove.selectAll('path').remove();
23682369

23692370
fullLayout._infolayer.select('.g-' + xa._id + 'title').remove();
23702371
fullLayout._infolayer.select('.g-' + ya._id + 'title').remove();
@@ -2462,6 +2463,7 @@ axes.drawOne = function(gd, ax, opts) {
24622463
var axLetter = axId.charAt(0);
24632464
var counterLetter = axes.counterLetter(axId);
24642465
var mainPlotinfo = fullLayout._plots[ax._mainSubplot];
2466+
var zerolineIsAbove = ax.zerolinelayer === 'above traces';
24652467

24662468
// this happens when updating matched group with 'missing' axes
24672469
if(!mainPlotinfo) return;
@@ -2576,7 +2578,7 @@ axes.drawOne = function(gd, ax, opts) {
25762578
});
25772579
axes.drawZeroLine(gd, ax, {
25782580
counterAxis: counterAxis,
2579-
layer: plotinfo.zerolinelayer,
2581+
layer: zerolineIsAbove ? plotinfo.zerolinelayerAbove : plotinfo.zerolinelayer,
25802582
path: gridPath,
25812583
transFn: transTickFn
25822584
});
@@ -3555,6 +3557,7 @@ axes.drawLabels = function(gd, ax, opts) {
35553557

35563558
var fullLayout = gd._fullLayout;
35573559
var axId = ax._id;
3560+
var zerolineIsAbove = ax.zerolinelayer === 'above traces';
35583561
var cls = opts.cls || axId + 'tick';
35593562

35603563
var vals = opts.vals.filter(function(d) { return d.text; });
@@ -3763,8 +3766,10 @@ axes.drawLabels = function(gd, ax, opts) {
37633766
var mainPlotinfo = fullLayout._plots[ax._mainSubplot];
37643767

37653768
var sel;
3766-
if(e.K === ZERO_PATH.K) sel = mainPlotinfo.zerolinelayer.selectAll('.' + ax._id + 'zl');
3767-
else if(e.K === MINORGRID_PATH.K) sel = mainPlotinfo.minorGridlayer.selectAll('.' + ax._id);
3769+
if(e.K === ZERO_PATH.K) {
3770+
var zerolineLayer = zerolineIsAbove ? mainPlotinfo.zerolinelayerAbove : mainPlotinfo.zerolinelayer;
3771+
sel = zerolineLayer.selectAll('.' + ax._id + 'zl');
3772+
} else if(e.K === MINORGRID_PATH.K) sel = mainPlotinfo.minorGridlayer.selectAll('.' + ax._id);
37683773
else if(e.K === GRID_PATH.K) sel = mainPlotinfo.gridlayer.selectAll('.' + ax._id);
37693774
else sel = mainPlotinfo[ax._id.charAt(0) + 'axislayer'];
37703775

‎src/plots/cartesian/index.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,12 @@ function makeSubplotLayer(gd, plotinfo) {
614614
plotinfo.overplot = ensureSingle(plotgroup, 'g', 'overplot');
615615
plotinfo.plot = ensureSingle(plotinfo.overplot, 'g', id);
616616

617+
if(mainplotinfo && hasMultipleZ) {
618+
plotinfo.zerolinelayerAbove = mainplotinfo.zerolinelayerAbove;
619+
} else {
620+
plotinfo.zerolinelayerAbove = ensureSingle(plotgroup, 'g', 'zerolinelayer-above');
621+
}
622+
617623
if(!hasZ) {
618624
plotinfo.xlines = ensureSingle(plotgroup, 'path', 'xlines-above');
619625
plotinfo.ylines = ensureSingle(plotgroup, 'path', 'ylines-above');
@@ -643,6 +649,7 @@ function makeSubplotLayer(gd, plotinfo) {
643649
plotinfo.minorGridlayer = mainplotinfo.minorGridlayer;
644650
plotinfo.gridlayer = mainplotinfo.gridlayer;
645651
plotinfo.zerolinelayer = mainplotinfo.zerolinelayer;
652+
plotinfo.zerolinelayerAbove = mainplotinfo.zerolinelayerAbove;
646653

647654
ensureSingle(mainplotinfo.overlinesBelow, 'path', xId);
648655
ensureSingle(mainplotinfo.overlinesBelow, 'path', yId);

‎src/plots/cartesian/layout_attributes.js‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1016,6 +1016,19 @@ module.exports = {
10161016
editType: 'ticks',
10171017
description: 'Sets the line color of the zero line.'
10181018
},
1019+
zerolinelayer: {
1020+
valType: 'enumerated',
1021+
values: ['above traces', 'below traces'],
1022+
dflt: 'below traces',
1023+
editType: 'plot',
1024+
description: [
1025+
'Sets the layer on which this zeroline is displayed.',
1026+
'If *above traces*, this zeroline is displayed above all the subplot\'s traces',
1027+
'If *below traces*, this zeroline is displayed below all the subplot\'s traces,',
1028+
'but above the grid lines. Limitation: *zerolinelayer* currently has no effect',
1029+
'if the *zorder* property is set on any trace.'
1030+
].join(' ')
1031+
},
10191032
zerolinewidth: {
10201033
valType: 'number',
10211034
dflt: 1,

‎src/plots/cartesian/line_grid_defaults.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,13 @@ module.exports = function handleLineGridDefaults(containerIn, containerOut, coer
6767
}
6868

6969
if(!opts.noZeroLine) {
70+
var zeroLineLayer = coerce2('zerolinelayer');
7071
var zeroLineColor = coerce2('zerolinecolor', dfltColor);
7172
var zeroLineWidth = coerce2('zerolinewidth');
7273
var showZeroLine = coerce('zeroline', opts.showGrid || !!zeroLineColor || !!zeroLineWidth);
7374

7475
if(!showZeroLine) {
76+
delete containerOut.zerolinelayer;
7577
delete containerOut.zerolinecolor;
7678
delete containerOut.zerolinewidth;
7779
}

‎test/image/baselines/zzz_zerolinelayer_above.png‎

27.1 KB
Loading

‎test/image/baselines/zzz_zerolinelayer_below.png‎

27.7 KB
Loading

‎test/image/mocks/zzz_zerolinelayer_above.json‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"data": [
3+
{
4+
"type": "bar",
5+
"x": [-1, 0, 2, 3],
6+
"y": [-1, 2, -3, 4],
7+
"name": "xy"
8+
},
9+
{
10+
"line": {
11+
"width": 10
12+
},
13+
"mode": "lines",
14+
"x": [-1, 0, 2, 3],
15+
"y": [-3, 1, -1, 2],
16+
"xaxis": "x2",
17+
"yaxis": "y2",
18+
"name": "x2y2"
19+
}
20+
],
21+
"layout": {
22+
"title": {
23+
"text": "All zerolines above traces (x/x2: pink, y/y2: black)"
24+
},
25+
"width": 600,
26+
"height": 400,
27+
"xaxis": {
28+
"zeroline": true,
29+
"zerolinewidth": 5,
30+
"zerolinecolor": "pink",
31+
"zerolinelayer": "above traces"
32+
},
33+
"xaxis2": {
34+
"overlaying": "x",
35+
"zeroline": true,
36+
"zerolinewidth": 5,
37+
"zerolinecolor": "pink",
38+
"zerolinelayer": "above traces",
39+
"side": "top"
40+
},
41+
"yaxis": {
42+
"zeroline": true,
43+
"zerolinewidth": 5,
44+
"zerolinecolor": "black",
45+
"zerolinelayer": "above traces",
46+
"range": [-1, 4]
47+
},
48+
"yaxis2": {
49+
"zeroline": true,
50+
"zerolinewidth": 5,
51+
"zerolinecolor": "black",
52+
"zerolinelayer": "above traces",
53+
"range": [-3, 2],
54+
"overlaying": "y",
55+
"side": "right"
56+
}
57+
}
58+
}

‎test/image/mocks/zzz_zerolinelayer_below.json‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"data": [
3+
{
4+
"type": "bar",
5+
"x": [-1, 0, 2, 3],
6+
"y": [-1, 2, -3, 4],
7+
"name": "xy"
8+
},
9+
{
10+
"line": {
11+
"width": 10
12+
},
13+
"mode": "lines",
14+
"x": [-1, 0, 2, 3],
15+
"y": [-3, 1, -1, 2],
16+
"xaxis": "x2",
17+
"yaxis": "y2",
18+
"name": "x2y2"
19+
}
20+
],
21+
"layout": {
22+
"title": {
23+
"text": "All zerolines below traces (x/x2: pink, y/y2: black)"
24+
},
25+
"width": 600,
26+
"height": 400,
27+
"xaxis": {
28+
"zeroline": true,
29+
"zerolinewidth": 5,
30+
"zerolinecolor": "pink",
31+
"zerolinelayer": "below traces"
32+
},
33+
"xaxis2": {
34+
"overlaying": "x",
35+
"zeroline": true,
36+
"zerolinewidth": 5,
37+
"zerolinecolor": "pink",
38+
"zerolinelayer": "below traces",
39+
"side": "top"
40+
},
41+
"yaxis": {
42+
"zeroline": true,
43+
"zerolinewidth": 5,
44+
"zerolinecolor": "black",
45+
"zerolinelayer": "below traces",
46+
"range": [-1, 4]
47+
},
48+
"yaxis2": {
49+
"zeroline": true,
50+
"zerolinewidth": 5,
51+
"zerolinecolor": "black",
52+
"zerolinelayer": "below traces",
53+
"range": [-3, 2],
54+
"overlaying": "y",
55+
"side": "right"
56+
}
57+
}
58+
}

‎test/jasmine/tests/splom_test.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -799,7 +799,7 @@ describe('Test splom interactions:', function() {
799799
.then(function() {
800800
_assert({
801801
subplotCnt: 25,
802-
innerSubplotNodeCnt: 18,
802+
innerSubplotNodeCnt: 19,
803803
hasSplomGrid: false,
804804
bgCnt: 0
805805
});
@@ -819,7 +819,7 @@ describe('Test splom interactions:', function() {
819819
// grid layer would be above xaxis layer,
820820
// if we didn't clear subplot children.
821821
expect(gridIndex).toBe(2, '<g.gridlayer> index');
822-
expect(xaxisIndex).toBe(15, '<g.xaxislayer-above> index');
822+
expect(xaxisIndex).toBe(16, '<g.xaxislayer-above> index');
823823

824824
return Plotly.restyle(gd, 'dimensions', [dimsLarge]);
825825
})
@@ -831,7 +831,7 @@ describe('Test splom interactions:', function() {
831831
// new subplots though have reduced number of children.
832832
innerSubplotNodeCnt: function(d) {
833833
var p = d.match(SUBPLOT_PATTERN);
834-
return (p[1] > 5 || p[2] > 5) ? 4 : 18;
834+
return (p[1] > 5 || p[2] > 5) ? 4 : 19;
835835
},
836836
hasSplomGrid: true,
837837
bgCnt: 0

0 commit comments

Comments
 (0)