Skip to content

Fix hover label coloring on white bgcolor#3048

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
etpinard merged 2 commits into from
Sep 25, 2018
Merged

Fix hover label coloring on white bgcolor #3048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45e7a3d
contrast common hover label font color w/ bgcolor
etpinard Sep 24, 2018
864f941
do not use hoverlabel.bgcolor for "name" part of hover label
etpinard Sep 24, 2018
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
27 changes: 18 additions & 9 deletions src/components/fx/hover.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -703,6 +703,7 @@ function createHoverText(hoverData, opts, gd) {

var commonBgColor = commonLabelOpts.bgcolor || Color.defaultLine;
var commonStroke = commonLabelOpts.bordercolor || Color.contrast(commonBgColor);
var contrastColor = Color.contrast(commonBgColor);

lpath.style({
fill: commonBgColor,
Expand All@@ -713,7 +714,7 @@ function createHoverText(hoverData, opts, gd) {
.call(Drawing.font,
commonLabelOpts.font.family || fontFamily,
commonLabelOpts.font.size || fontSize,
commonLabelOpts.font.color || Color.background
commonLabelOpts.font.color || contrastColor
)
.call(svgTextUtils.positionText, 0, 0)
.call(svgTextUtils.convertToTspans, gd);
Expand DownExpand Up@@ -795,12 +796,20 @@ function createHoverText(hoverData, opts, gd) {
var name = '';
var text = '';

// combine possible non-opaque trace color with bgColor
var baseColor = Color.opacity(d.color) ? d.color : Color.defaultLine;
var traceColor = Color.combine(baseColor, bgColor);

// combine possible non-opaque trace color with bgColor
var color0 = d.bgcolor || d.color;
// color for 'nums' part of the label
var numsColor = Color.combine(
Color.opacity(color0) ? color0 : Color.defaultLine,
bgColor
);
// color for 'name' part of the label
var nameColor = Color.combine(
Color.opacity(d.color) ? d.color : Color.defaultLine,
bgColor
);
// find a contrasting color for border and text
var contrastColor = d.borderColor || Color.contrast(traceColor);
var contrastColor = d.borderColor || Color.contrast(numsColor);

// to get custom 'name' labels pass cleanPoint
if(d.nameOverride !== undefined) d.name = d.nameOverride;
Expand DownExpand Up@@ -869,7 +878,7 @@ function createHoverText(hoverData, opts, gd) {
tx2.call(Drawing.font,
d.fontFamily || fontFamily,
d.fontSize || fontSize,
traceColor)
nameColor)
.text(name)
.attr('data-notex', 1)
.call(svgTextUtils.positionText, 0, 0)
Expand All@@ -883,7 +892,7 @@ function createHoverText(hoverData, opts, gd) {

g.select('path')
.style({
fill: traceColor,
fill: numsColor,
stroke: contrastColor
});
var tbb = tx.node().getBoundingClientRect();
Expand DownExpand Up@@ -1189,7 +1198,7 @@ function cleanPoint(d, hovermode) {
}

fill('hoverinfo', 'hi', 'hoverinfo');
fill('color', 'hbg', 'hoverlabel.bgcolor');
fill('bgcolor', 'hbg', 'hoverlabel.bgcolor');
fill('borderColor', 'hbc', 'hoverlabel.bordercolor');
fill('fontFamily', 'htf', 'hoverlabel.font.family');
fill('fontSize', 'hts', 'hoverlabel.font.size');
Expand Down
74 changes: 70 additions & 4 deletions test/jasmine/tests/hover_label_test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2062,7 +2062,7 @@ describe('Test hover label custom styling:', function() {
});
assertCommonLabel({
path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
text: [13, 'Arial', 'rgb(255, 255, 255)']

@alexcjohnsonalexcjohnsonSep 25, 2018

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Ha yeah, that would be a problem! FWIW, we'd have had a chance anyway of catching this bug when we wrote the test if it said something like

path: {bg: 'rgb(255, 255, 255)', border: 'rgb(68, 68, 68)'}, // or fill & line...
text: [13, 'Arial', 'rgb(255, 255, 255)']

So it'd be immediately obvious that the path bg matches the font color, and the font cannot be seen!
As it is path has two colors so it's unclear what they mean. text is unambiguous because all items are different types, so it's OK as an array, though still perhaps awkward as you need to know the order to write the test.

text: [13, 'Arial', 'rgb(68, 68, 68)']
});
})
.then(function() {
Expand All@@ -2074,7 +2074,7 @@ describe('Test hover label custom styling:', function() {
});
assertCommonLabel({
path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
text: [13, 'Arial', 'rgb(255, 255, 255)']
text: [13, 'Arial', 'rgb(68, 68, 68)']
});
})
.then(function() {
Expand All@@ -2086,7 +2086,7 @@ describe('Test hover label custom styling:', function() {
});
assertCommonLabel({
path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
text: [13, 'Arial', 'rgb(255, 255, 255)']
text: [13, 'Arial', 'rgb(68, 68, 68)']
});

// test arrayOk case
Expand All@@ -2113,7 +2113,7 @@ describe('Test hover label custom styling:', function() {
assertPtLabel(null);
assertCommonLabel({
path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
text: [13, 'Arial', 'rgb(255, 255, 255)']
text: [13, 'Arial', 'rgb(68, 68, 68)']
});

// test base case
Expand DownExpand Up@@ -2203,6 +2203,72 @@ describe('Test hover label custom styling:', function() {
.then(done);
});

it('should work for x/y cartesian traces (multi-trace case)', function(done) {
var gd = createGraphDiv();

function assertNameLabel(expectation) {
var g = d3.selectAll('g.hovertext > text.name');

if(expectation === null) {
expect(g.size()).toBe(0);
} else {
g.each(function(_, i) {
var textStyle = window.getComputedStyle(this);
expect(textStyle.fill).toBe(expectation.color[i]);
});
}
}

Plotly.plot(gd, [{
x: [1, 2, 3],
y: [1, 2, 1],
}, {
x: [1, 2, 3],
y: [4, 5, 4],
}], {
hovermode: 'x',
})
.then(function() {
_hover(gd, { xval: gd._fullData[0].x[0] });
assertNameLabel({
color: ['rgb(31, 119, 180)', 'rgb(255, 127, 14)']
});
return Plotly.restyle(gd, 'marker.color', ['red', 'blue']);
})
.then(function() {
_hover(gd, { xval: gd._fullData[0].x[0] });
assertNameLabel({
color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
});
return Plotly.relayout(gd, 'hoverlabel.bgcolor', 'white');
})
.then(function() {
_hover(gd, { xval: gd._fullData[0].x[0] });
// should not affect the name font color
assertNameLabel({
color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
});
return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0.1)', 'rgba(0,0,255,0.1)']);
})
.then(function() {
_hover(gd, { xval: gd._fullData[0].x[0] });
// should blend with plot_bgcolor
assertNameLabel({
color: ['rgb(255, 179, 179)', 'rgb(179, 179, 255)']
});
return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0)', 'rgba(0,0,255,0)']);
})
.then(function() {
_hover(gd, { xval: gd._fullData[0].x[0] });
// uses default line color when opacity=0
assertNameLabel({
color: ['rgb(68, 68, 68)', 'rgb(68, 68, 68)']
});
})
.catch(failTest)
.then(done);
});

it('should work for 2d z cartesian traces', function(done) {
var gd = createGraphDiv();

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Fix hover label coloring on white bgcolor by etpinard · Pull Request #3048 · plotly/plotly.js · GitHub
Skip to content
Fix hover label coloring on white bgcolor#3048

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

etpinard
merged 2 commits into

from

Sep 25, 2018
 Merged


Fix hover label coloring on white bgcolor
#3048
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
45e7a3d

contrast common hover label font color w/ bgcolor


etpinard Sep 24, 2018
864f941

do not use hoverlabel.bgcolor for "name" part of hover label


etpinard Sep 24, 2018

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


27 changes: 18 additions & 9 deletions
src/components/fx/hover.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -703,6 +703,7 @@ function createHoverText(hoverData, opts, gd) {

 var commonBgColor = commonLabelOpts.bgcolor || Color.defaultLine;
 var commonStroke = commonLabelOpts.bordercolor || Color.contrast(commonBgColor);
 var contrastColor = Color.contrast(commonBgColor);

 lpath.style({
 fill: commonBgColor,
Expand All@@ -713,7 +714,7 @@ function createHoverText(hoverData, opts, gd) {
 .call(Drawing.font,
 commonLabelOpts.font.family || fontFamily,
 commonLabelOpts.font.size || fontSize,
 commonLabelOpts.font.color || Color.background
 commonLabelOpts.font.color || contrastColor
 )
 .call(svgTextUtils.positionText, 0, 0)
 .call(svgTextUtils.convertToTspans, gd);
Expand DownExpand Up@@ -795,12 +796,20 @@ function createHoverText(hoverData, opts, gd) {
 var name = '';
 var text = '';

 // combine possible non-opaque trace color with bgColor
 var baseColor = Color.opacity(d.color) ? d.color : Color.defaultLine;
 var traceColor = Color.combine(baseColor, bgColor);

 // combine possible non-opaque trace color with bgColor
 var color0 = d.bgcolor || d.color;
 // color for 'nums' part of the label
 var numsColor = Color.combine(
 Color.opacity(color0) ? color0 : Color.defaultLine,
 bgColor
 );
 // color for 'name' part of the label
 var nameColor = Color.combine(
 Color.opacity(d.color) ? d.color : Color.defaultLine,
 bgColor
 );
 // find a contrasting color for border and text
 var contrastColor = d.borderColor || Color.contrast(traceColor);
 var contrastColor = d.borderColor || Color.contrast(numsColor);

 // to get custom 'name' labels pass cleanPoint
 if(d.nameOverride !== undefined) d.name = d.nameOverride;
Expand DownExpand Up@@ -869,7 +878,7 @@ function createHoverText(hoverData, opts, gd) {
 tx2.call(Drawing.font,
 d.fontFamily || fontFamily,
 d.fontSize || fontSize,
traceColor)
nameColor)
 .text(name)
 .attr('data-notex', 1)
 .call(svgTextUtils.positionText, 0, 0)
Expand All@@ -883,7 +892,7 @@ function createHoverText(hoverData, opts, gd) {

 g.select('path')
 .style({
 fill: traceColor,
 fill: numsColor,
 stroke: contrastColor
 });
 var tbb = tx.node().getBoundingClientRect();
Expand DownExpand Up@@ -1189,7 +1198,7 @@ function cleanPoint(d, hovermode) {
 }

 fill('hoverinfo', 'hi', 'hoverinfo');
 fill('color', 'hbg', 'hoverlabel.bgcolor');
 fill('bgcolor', 'hbg', 'hoverlabel.bgcolor');
 fill('borderColor', 'hbc', 'hoverlabel.bordercolor');
 fill('fontFamily', 'htf', 'hoverlabel.font.family');
 fill('fontSize', 'hts', 'hoverlabel.font.size');
Expand Down

74 changes: 70 additions & 4 deletions
test/jasmine/tests/hover_label_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2062,7 +2062,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
@alexcjohnsonalexcjohnsonSep 25, 2018

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Ha yeah, that would be a problem! FWIW, we'd have had a chance anyway of catching this bug when we wrote the test if it said something like
path: {bg: 'rgb(255, 255, 255)', border: 'rgb(68, 68, 68)'}, // or fill & line...
text: [13, 'Arial', 'rgb(255, 255, 255)']

So it'd be immediately obvious that the path bg matches the font color, and the font cannot be seen!

As it is path has two colors so it's unclear what they mean. text is unambiguous because all items are different types, so it's OK as an array, though still perhaps awkward as you need to know the order to write the test.
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2074,7 +2074,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2086,7 +2086,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test arrayOk case
Expand All@@ -2113,7 +2113,7 @@ describe('Test hover label custom styling:', function() {
 assertPtLabel(null);
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test base case
Expand DownExpand Up@@ -2203,6 +2203,72 @@ describe('Test hover label custom styling:', function() {
 .then(done);
 });

 it('should work for x/y cartesian traces (multi-trace case)', function(done) {
 var gd = createGraphDiv();

 function assertNameLabel(expectation) {
 var g = d3.selectAll('g.hovertext > text.name');

 if(expectation === null) {
 expect(g.size()).toBe(0);
 } else {
 g.each(function(_, i) {
 var textStyle = window.getComputedStyle(this);
 expect(textStyle.fill).toBe(expectation.color[i]);
 });
 }
 }

 Plotly.plot(gd, [{
 x: [1, 2, 3],
 y: [1, 2, 1],
 }, {
 x: [1, 2, 3],
 y: [4, 5, 4],
 }], {
 hovermode: 'x',
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(31, 119, 180)', 'rgb(255, 127, 14)']
 });
 return Plotly.restyle(gd, 'marker.color', ['red', 'blue']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.relayout(gd, 'hoverlabel.bgcolor', 'white');
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should not affect the name font color
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0.1)', 'rgba(0,0,255,0.1)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should blend with plot_bgcolor
 assertNameLabel({
 color: ['rgb(255, 179, 179)', 'rgb(179, 179, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0)', 'rgba(0,0,255,0)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // uses default line color when opacity=0
 assertNameLabel({
 color: ['rgb(68, 68, 68)', 'rgb(68, 68, 68)']
 });
 })
 .catch(failTest)
 .then(done);
 });

 it('should work for 2d z cartesian traces', function(done) {
 var gd = createGraphDiv();

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix hover label coloring on white bgcolor by etpinard · Pull Request #3048 · plotly/plotly.js · GitHub
Skip to content
Fix hover label coloring on white bgcolor#3048

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

etpinard
merged 2 commits into

from

Sep 25, 2018
 Merged


Fix hover label coloring on white bgcolor
#3048
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
45e7a3d

contrast common hover label font color w/ bgcolor


etpinard Sep 24, 2018
864f941

do not use hoverlabel.bgcolor for "name" part of hover label


etpinard Sep 24, 2018

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


27 changes: 18 additions & 9 deletions
src/components/fx/hover.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -703,6 +703,7 @@ function createHoverText(hoverData, opts, gd) {

 var commonBgColor = commonLabelOpts.bgcolor || Color.defaultLine;
 var commonStroke = commonLabelOpts.bordercolor || Color.contrast(commonBgColor);
 var contrastColor = Color.contrast(commonBgColor);

 lpath.style({
 fill: commonBgColor,
Expand All@@ -713,7 +714,7 @@ function createHoverText(hoverData, opts, gd) {
 .call(Drawing.font,
 commonLabelOpts.font.family || fontFamily,
 commonLabelOpts.font.size || fontSize,
 commonLabelOpts.font.color || Color.background
 commonLabelOpts.font.color || contrastColor
 )
 .call(svgTextUtils.positionText, 0, 0)
 .call(svgTextUtils.convertToTspans, gd);
Expand DownExpand Up@@ -795,12 +796,20 @@ function createHoverText(hoverData, opts, gd) {
 var name = '';
 var text = '';

 // combine possible non-opaque trace color with bgColor
 var baseColor = Color.opacity(d.color) ? d.color : Color.defaultLine;
 var traceColor = Color.combine(baseColor, bgColor);

 // combine possible non-opaque trace color with bgColor
 var color0 = d.bgcolor || d.color;
 // color for 'nums' part of the label
 var numsColor = Color.combine(
 Color.opacity(color0) ? color0 : Color.defaultLine,
 bgColor
 );
 // color for 'name' part of the label
 var nameColor = Color.combine(
 Color.opacity(d.color) ? d.color : Color.defaultLine,
 bgColor
 );
 // find a contrasting color for border and text
 var contrastColor = d.borderColor || Color.contrast(traceColor);
 var contrastColor = d.borderColor || Color.contrast(numsColor);

 // to get custom 'name' labels pass cleanPoint
 if(d.nameOverride !== undefined) d.name = d.nameOverride;
Expand DownExpand Up@@ -869,7 +878,7 @@ function createHoverText(hoverData, opts, gd) {
 tx2.call(Drawing.font,
 d.fontFamily || fontFamily,
 d.fontSize || fontSize,
traceColor)
nameColor)
 .text(name)
 .attr('data-notex', 1)
 .call(svgTextUtils.positionText, 0, 0)
Expand All@@ -883,7 +892,7 @@ function createHoverText(hoverData, opts, gd) {

 g.select('path')
 .style({
 fill: traceColor,
 fill: numsColor,
 stroke: contrastColor
 });
 var tbb = tx.node().getBoundingClientRect();
Expand DownExpand Up@@ -1189,7 +1198,7 @@ function cleanPoint(d, hovermode) {
 }

 fill('hoverinfo', 'hi', 'hoverinfo');
 fill('color', 'hbg', 'hoverlabel.bgcolor');
 fill('bgcolor', 'hbg', 'hoverlabel.bgcolor');
 fill('borderColor', 'hbc', 'hoverlabel.bordercolor');
 fill('fontFamily', 'htf', 'hoverlabel.font.family');
 fill('fontSize', 'hts', 'hoverlabel.font.size');
Expand Down

74 changes: 70 additions & 4 deletions
test/jasmine/tests/hover_label_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2062,7 +2062,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
@alexcjohnsonalexcjohnsonSep 25, 2018

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Ha yeah, that would be a problem! FWIW, we'd have had a chance anyway of catching this bug when we wrote the test if it said something like
path: {bg: 'rgb(255, 255, 255)', border: 'rgb(68, 68, 68)'}, // or fill & line...
text: [13, 'Arial', 'rgb(255, 255, 255)']

So it'd be immediately obvious that the path bg matches the font color, and the font cannot be seen!

As it is path has two colors so it's unclear what they mean. text is unambiguous because all items are different types, so it's OK as an array, though still perhaps awkward as you need to know the order to write the test.
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2074,7 +2074,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2086,7 +2086,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test arrayOk case
Expand All@@ -2113,7 +2113,7 @@ describe('Test hover label custom styling:', function() {
 assertPtLabel(null);
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test base case
Expand DownExpand Up@@ -2203,6 +2203,72 @@ describe('Test hover label custom styling:', function() {
 .then(done);
 });

 it('should work for x/y cartesian traces (multi-trace case)', function(done) {
 var gd = createGraphDiv();

 function assertNameLabel(expectation) {
 var g = d3.selectAll('g.hovertext > text.name');

 if(expectation === null) {
 expect(g.size()).toBe(0);
 } else {
 g.each(function(_, i) {
 var textStyle = window.getComputedStyle(this);
 expect(textStyle.fill).toBe(expectation.color[i]);
 });
 }
 }

 Plotly.plot(gd, [{
 x: [1, 2, 3],
 y: [1, 2, 1],
 }, {
 x: [1, 2, 3],
 y: [4, 5, 4],
 }], {
 hovermode: 'x',
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(31, 119, 180)', 'rgb(255, 127, 14)']
 });
 return Plotly.restyle(gd, 'marker.color', ['red', 'blue']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.relayout(gd, 'hoverlabel.bgcolor', 'white');
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should not affect the name font color
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0.1)', 'rgba(0,0,255,0.1)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should blend with plot_bgcolor
 assertNameLabel({
 color: ['rgb(255, 179, 179)', 'rgb(179, 179, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0)', 'rgba(0,0,255,0)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // uses default line color when opacity=0
 assertNameLabel({
 color: ['rgb(68, 68, 68)', 'rgb(68, 68, 68)']
 });
 })
 .catch(failTest)
 .then(done);
 });

 it('should work for 2d z cartesian traces', function(done) {
 var gd = createGraphDiv();

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix hover label coloring on white bgcolor by etpinard · Pull Request #3048 · plotly/plotly.js · GitHub
Skip to content
Fix hover label coloring on white bgcolor#3048

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

etpinard
merged 2 commits into

from

Sep 25, 2018
 Merged


Fix hover label coloring on white bgcolor
#3048
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
45e7a3d

contrast common hover label font color w/ bgcolor


etpinard Sep 24, 2018
864f941

do not use hoverlabel.bgcolor for "name" part of hover label


etpinard Sep 24, 2018

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


27 changes: 18 additions & 9 deletions
src/components/fx/hover.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -703,6 +703,7 @@ function createHoverText(hoverData, opts, gd) {

 var commonBgColor = commonLabelOpts.bgcolor || Color.defaultLine;
 var commonStroke = commonLabelOpts.bordercolor || Color.contrast(commonBgColor);
 var contrastColor = Color.contrast(commonBgColor);

 lpath.style({
 fill: commonBgColor,
Expand All@@ -713,7 +714,7 @@ function createHoverText(hoverData, opts, gd) {
 .call(Drawing.font,
 commonLabelOpts.font.family || fontFamily,
 commonLabelOpts.font.size || fontSize,
 commonLabelOpts.font.color || Color.background
 commonLabelOpts.font.color || contrastColor
 )
 .call(svgTextUtils.positionText, 0, 0)
 .call(svgTextUtils.convertToTspans, gd);
Expand DownExpand Up@@ -795,12 +796,20 @@ function createHoverText(hoverData, opts, gd) {
 var name = '';
 var text = '';

 // combine possible non-opaque trace color with bgColor
 var baseColor = Color.opacity(d.color) ? d.color : Color.defaultLine;
 var traceColor = Color.combine(baseColor, bgColor);

 // combine possible non-opaque trace color with bgColor
 var color0 = d.bgcolor || d.color;
 // color for 'nums' part of the label
 var numsColor = Color.combine(
 Color.opacity(color0) ? color0 : Color.defaultLine,
 bgColor
 );
 // color for 'name' part of the label
 var nameColor = Color.combine(
 Color.opacity(d.color) ? d.color : Color.defaultLine,
 bgColor
 );
 // find a contrasting color for border and text
 var contrastColor = d.borderColor || Color.contrast(traceColor);
 var contrastColor = d.borderColor || Color.contrast(numsColor);

 // to get custom 'name' labels pass cleanPoint
 if(d.nameOverride !== undefined) d.name = d.nameOverride;
Expand DownExpand Up@@ -869,7 +878,7 @@ function createHoverText(hoverData, opts, gd) {
 tx2.call(Drawing.font,
 d.fontFamily || fontFamily,
 d.fontSize || fontSize,
traceColor)
nameColor)
 .text(name)
 .attr('data-notex', 1)
 .call(svgTextUtils.positionText, 0, 0)
Expand All@@ -883,7 +892,7 @@ function createHoverText(hoverData, opts, gd) {

 g.select('path')
 .style({
 fill: traceColor,
 fill: numsColor,
 stroke: contrastColor
 });
 var tbb = tx.node().getBoundingClientRect();
Expand DownExpand Up@@ -1189,7 +1198,7 @@ function cleanPoint(d, hovermode) {
 }

 fill('hoverinfo', 'hi', 'hoverinfo');
 fill('color', 'hbg', 'hoverlabel.bgcolor');
 fill('bgcolor', 'hbg', 'hoverlabel.bgcolor');
 fill('borderColor', 'hbc', 'hoverlabel.bordercolor');
 fill('fontFamily', 'htf', 'hoverlabel.font.family');
 fill('fontSize', 'hts', 'hoverlabel.font.size');
Expand Down

74 changes: 70 additions & 4 deletions
test/jasmine/tests/hover_label_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2062,7 +2062,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
@alexcjohnsonalexcjohnsonSep 25, 2018

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Ha yeah, that would be a problem! FWIW, we'd have had a chance anyway of catching this bug when we wrote the test if it said something like
path: {bg: 'rgb(255, 255, 255)', border: 'rgb(68, 68, 68)'}, // or fill & line...
text: [13, 'Arial', 'rgb(255, 255, 255)']

So it'd be immediately obvious that the path bg matches the font color, and the font cannot be seen!

As it is path has two colors so it's unclear what they mean. text is unambiguous because all items are different types, so it's OK as an array, though still perhaps awkward as you need to know the order to write the test.
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2074,7 +2074,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2086,7 +2086,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test arrayOk case
Expand All@@ -2113,7 +2113,7 @@ describe('Test hover label custom styling:', function() {
 assertPtLabel(null);
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test base case
Expand DownExpand Up@@ -2203,6 +2203,72 @@ describe('Test hover label custom styling:', function() {
 .then(done);
 });

 it('should work for x/y cartesian traces (multi-trace case)', function(done) {
 var gd = createGraphDiv();

 function assertNameLabel(expectation) {
 var g = d3.selectAll('g.hovertext > text.name');

 if(expectation === null) {
 expect(g.size()).toBe(0);
 } else {
 g.each(function(_, i) {
 var textStyle = window.getComputedStyle(this);
 expect(textStyle.fill).toBe(expectation.color[i]);
 });
 }
 }

 Plotly.plot(gd, [{
 x: [1, 2, 3],
 y: [1, 2, 1],
 }, {
 x: [1, 2, 3],
 y: [4, 5, 4],
 }], {
 hovermode: 'x',
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(31, 119, 180)', 'rgb(255, 127, 14)']
 });
 return Plotly.restyle(gd, 'marker.color', ['red', 'blue']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.relayout(gd, 'hoverlabel.bgcolor', 'white');
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should not affect the name font color
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0.1)', 'rgba(0,0,255,0.1)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should blend with plot_bgcolor
 assertNameLabel({
 color: ['rgb(255, 179, 179)', 'rgb(179, 179, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0)', 'rgba(0,0,255,0)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // uses default line color when opacity=0
 assertNameLabel({
 color: ['rgb(68, 68, 68)', 'rgb(68, 68, 68)']
 });
 })
 .catch(failTest)
 .then(done);
 });

 it('should work for 2d z cartesian traces', function(done) {
 var gd = createGraphDiv();

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Fix hover label coloring on white bgcolor by etpinard · Pull Request #3048 · plotly/plotly.js · GitHub
Skip to content
Fix hover label coloring on white bgcolor#3048

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

etpinard
merged 2 commits into

from

Sep 25, 2018
 Merged


Fix hover label coloring on white bgcolor
#3048
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
45e7a3d

contrast common hover label font color w/ bgcolor


etpinard Sep 24, 2018
864f941

do not use hoverlabel.bgcolor for "name" part of hover label


etpinard Sep 24, 2018

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


27 changes: 18 additions & 9 deletions
src/components/fx/hover.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -703,6 +703,7 @@ function createHoverText(hoverData, opts, gd) {

 var commonBgColor = commonLabelOpts.bgcolor || Color.defaultLine;
 var commonStroke = commonLabelOpts.bordercolor || Color.contrast(commonBgColor);
 var contrastColor = Color.contrast(commonBgColor);

 lpath.style({
 fill: commonBgColor,
Expand All@@ -713,7 +714,7 @@ function createHoverText(hoverData, opts, gd) {
 .call(Drawing.font,
 commonLabelOpts.font.family || fontFamily,
 commonLabelOpts.font.size || fontSize,
 commonLabelOpts.font.color || Color.background
 commonLabelOpts.font.color || contrastColor
 )
 .call(svgTextUtils.positionText, 0, 0)
 .call(svgTextUtils.convertToTspans, gd);
Expand DownExpand Up@@ -795,12 +796,20 @@ function createHoverText(hoverData, opts, gd) {
 var name = '';
 var text = '';

 // combine possible non-opaque trace color with bgColor
 var baseColor = Color.opacity(d.color) ? d.color : Color.defaultLine;
 var traceColor = Color.combine(baseColor, bgColor);

 // combine possible non-opaque trace color with bgColor
 var color0 = d.bgcolor || d.color;
 // color for 'nums' part of the label
 var numsColor = Color.combine(
 Color.opacity(color0) ? color0 : Color.defaultLine,
 bgColor
 );
 // color for 'name' part of the label
 var nameColor = Color.combine(
 Color.opacity(d.color) ? d.color : Color.defaultLine,
 bgColor
 );
 // find a contrasting color for border and text
 var contrastColor = d.borderColor || Color.contrast(traceColor);
 var contrastColor = d.borderColor || Color.contrast(numsColor);

 // to get custom 'name' labels pass cleanPoint
 if(d.nameOverride !== undefined) d.name = d.nameOverride;
Expand DownExpand Up@@ -869,7 +878,7 @@ function createHoverText(hoverData, opts, gd) {
 tx2.call(Drawing.font,
 d.fontFamily || fontFamily,
 d.fontSize || fontSize,
traceColor)
nameColor)
 .text(name)
 .attr('data-notex', 1)
 .call(svgTextUtils.positionText, 0, 0)
Expand All@@ -883,7 +892,7 @@ function createHoverText(hoverData, opts, gd) {

 g.select('path')
 .style({
 fill: traceColor,
 fill: numsColor,
 stroke: contrastColor
 });
 var tbb = tx.node().getBoundingClientRect();
Expand DownExpand Up@@ -1189,7 +1198,7 @@ function cleanPoint(d, hovermode) {
 }

 fill('hoverinfo', 'hi', 'hoverinfo');
 fill('color', 'hbg', 'hoverlabel.bgcolor');
 fill('bgcolor', 'hbg', 'hoverlabel.bgcolor');
 fill('borderColor', 'hbc', 'hoverlabel.bordercolor');
 fill('fontFamily', 'htf', 'hoverlabel.font.family');
 fill('fontSize', 'hts', 'hoverlabel.font.size');
Expand Down

74 changes: 70 additions & 4 deletions
test/jasmine/tests/hover_label_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2062,7 +2062,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
@alexcjohnsonalexcjohnsonSep 25, 2018

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Ha yeah, that would be a problem! FWIW, we'd have had a chance anyway of catching this bug when we wrote the test if it said something like
path: {bg: 'rgb(255, 255, 255)', border: 'rgb(68, 68, 68)'}, // or fill & line...
text: [13, 'Arial', 'rgb(255, 255, 255)']

So it'd be immediately obvious that the path bg matches the font color, and the font cannot be seen!

As it is path has two colors so it's unclear what they mean. text is unambiguous because all items are different types, so it's OK as an array, though still perhaps awkward as you need to know the order to write the test.
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2074,7 +2074,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2086,7 +2086,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test arrayOk case
Expand All@@ -2113,7 +2113,7 @@ describe('Test hover label custom styling:', function() {
 assertPtLabel(null);
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test base case
Expand DownExpand Up@@ -2203,6 +2203,72 @@ describe('Test hover label custom styling:', function() {
 .then(done);
 });

 it('should work for x/y cartesian traces (multi-trace case)', function(done) {
 var gd = createGraphDiv();

 function assertNameLabel(expectation) {
 var g = d3.selectAll('g.hovertext > text.name');

 if(expectation === null) {
 expect(g.size()).toBe(0);
 } else {
 g.each(function(_, i) {
 var textStyle = window.getComputedStyle(this);
 expect(textStyle.fill).toBe(expectation.color[i]);
 });
 }
 }

 Plotly.plot(gd, [{
 x: [1, 2, 3],
 y: [1, 2, 1],
 }, {
 x: [1, 2, 3],
 y: [4, 5, 4],
 }], {
 hovermode: 'x',
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(31, 119, 180)', 'rgb(255, 127, 14)']
 });
 return Plotly.restyle(gd, 'marker.color', ['red', 'blue']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.relayout(gd, 'hoverlabel.bgcolor', 'white');
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should not affect the name font color
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0.1)', 'rgba(0,0,255,0.1)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should blend with plot_bgcolor
 assertNameLabel({
 color: ['rgb(255, 179, 179)', 'rgb(179, 179, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0)', 'rgba(0,0,255,0)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // uses default line color when opacity=0
 assertNameLabel({
 color: ['rgb(68, 68, 68)', 'rgb(68, 68, 68)']
 });
 })
 .catch(failTest)
 .then(done);
 });

 it('should work for 2d z cartesian traces', function(done) {
 var gd = createGraphDiv();

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix hover label coloring on white bgcolor by etpinard · Pull Request #3048 · plotly/plotly.js · GitHub
Skip to content
Fix hover label coloring on white bgcolor#3048

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

etpinard
merged 2 commits into

from

Sep 25, 2018
 Merged


Fix hover label coloring on white bgcolor
#3048
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
45e7a3d

contrast common hover label font color w/ bgcolor


etpinard Sep 24, 2018
864f941

do not use hoverlabel.bgcolor for "name" part of hover label


etpinard Sep 24, 2018

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


27 changes: 18 additions & 9 deletions
src/components/fx/hover.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -703,6 +703,7 @@ function createHoverText(hoverData, opts, gd) {

 var commonBgColor = commonLabelOpts.bgcolor || Color.defaultLine;
 var commonStroke = commonLabelOpts.bordercolor || Color.contrast(commonBgColor);
 var contrastColor = Color.contrast(commonBgColor);

 lpath.style({
 fill: commonBgColor,
Expand All@@ -713,7 +714,7 @@ function createHoverText(hoverData, opts, gd) {
 .call(Drawing.font,
 commonLabelOpts.font.family || fontFamily,
 commonLabelOpts.font.size || fontSize,
 commonLabelOpts.font.color || Color.background
 commonLabelOpts.font.color || contrastColor
 )
 .call(svgTextUtils.positionText, 0, 0)
 .call(svgTextUtils.convertToTspans, gd);
Expand DownExpand Up@@ -795,12 +796,20 @@ function createHoverText(hoverData, opts, gd) {
 var name = '';
 var text = '';

 // combine possible non-opaque trace color with bgColor
 var baseColor = Color.opacity(d.color) ? d.color : Color.defaultLine;
 var traceColor = Color.combine(baseColor, bgColor);

 // combine possible non-opaque trace color with bgColor
 var color0 = d.bgcolor || d.color;
 // color for 'nums' part of the label
 var numsColor = Color.combine(
 Color.opacity(color0) ? color0 : Color.defaultLine,
 bgColor
 );
 // color for 'name' part of the label
 var nameColor = Color.combine(
 Color.opacity(d.color) ? d.color : Color.defaultLine,
 bgColor
 );
 // find a contrasting color for border and text
 var contrastColor = d.borderColor || Color.contrast(traceColor);
 var contrastColor = d.borderColor || Color.contrast(numsColor);

 // to get custom 'name' labels pass cleanPoint
 if(d.nameOverride !== undefined) d.name = d.nameOverride;
Expand DownExpand Up@@ -869,7 +878,7 @@ function createHoverText(hoverData, opts, gd) {
 tx2.call(Drawing.font,
 d.fontFamily || fontFamily,
 d.fontSize || fontSize,
traceColor)
nameColor)
 .text(name)
 .attr('data-notex', 1)
 .call(svgTextUtils.positionText, 0, 0)
Expand All@@ -883,7 +892,7 @@ function createHoverText(hoverData, opts, gd) {

 g.select('path')
 .style({
 fill: traceColor,
 fill: numsColor,
 stroke: contrastColor
 });
 var tbb = tx.node().getBoundingClientRect();
Expand DownExpand Up@@ -1189,7 +1198,7 @@ function cleanPoint(d, hovermode) {
 }

 fill('hoverinfo', 'hi', 'hoverinfo');
 fill('color', 'hbg', 'hoverlabel.bgcolor');
 fill('bgcolor', 'hbg', 'hoverlabel.bgcolor');
 fill('borderColor', 'hbc', 'hoverlabel.bordercolor');
 fill('fontFamily', 'htf', 'hoverlabel.font.family');
 fill('fontSize', 'hts', 'hoverlabel.font.size');
Expand Down

74 changes: 70 additions & 4 deletions
test/jasmine/tests/hover_label_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2062,7 +2062,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
@alexcjohnsonalexcjohnsonSep 25, 2018

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Ha yeah, that would be a problem! FWIW, we'd have had a chance anyway of catching this bug when we wrote the test if it said something like
path: {bg: 'rgb(255, 255, 255)', border: 'rgb(68, 68, 68)'}, // or fill & line...
text: [13, 'Arial', 'rgb(255, 255, 255)']

So it'd be immediately obvious that the path bg matches the font color, and the font cannot be seen!

As it is path has two colors so it's unclear what they mean. text is unambiguous because all items are different types, so it's OK as an array, though still perhaps awkward as you need to know the order to write the test.
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2074,7 +2074,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2086,7 +2086,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test arrayOk case
Expand All@@ -2113,7 +2113,7 @@ describe('Test hover label custom styling:', function() {
 assertPtLabel(null);
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test base case
Expand DownExpand Up@@ -2203,6 +2203,72 @@ describe('Test hover label custom styling:', function() {
 .then(done);
 });

 it('should work for x/y cartesian traces (multi-trace case)', function(done) {
 var gd = createGraphDiv();

 function assertNameLabel(expectation) {
 var g = d3.selectAll('g.hovertext > text.name');

 if(expectation === null) {
 expect(g.size()).toBe(0);
 } else {
 g.each(function(_, i) {
 var textStyle = window.getComputedStyle(this);
 expect(textStyle.fill).toBe(expectation.color[i]);
 });
 }
 }

 Plotly.plot(gd, [{
 x: [1, 2, 3],
 y: [1, 2, 1],
 }, {
 x: [1, 2, 3],
 y: [4, 5, 4],
 }], {
 hovermode: 'x',
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(31, 119, 180)', 'rgb(255, 127, 14)']
 });
 return Plotly.restyle(gd, 'marker.color', ['red', 'blue']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.relayout(gd, 'hoverlabel.bgcolor', 'white');
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should not affect the name font color
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0.1)', 'rgba(0,0,255,0.1)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should blend with plot_bgcolor
 assertNameLabel({
 color: ['rgb(255, 179, 179)', 'rgb(179, 179, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0)', 'rgba(0,0,255,0)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // uses default line color when opacity=0
 assertNameLabel({
 color: ['rgb(68, 68, 68)', 'rgb(68, 68, 68)']
 });
 })
 .catch(failTest)
 .then(done);
 });

 it('should work for 2d z cartesian traces', function(done) {
 var gd = createGraphDiv();

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix hover label coloring on white bgcolor by etpinard · Pull Request #3048 · plotly/plotly.js · GitHub
Skip to content
Fix hover label coloring on white bgcolor#3048

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

etpinard
merged 2 commits into

from

Sep 25, 2018
 Merged


Fix hover label coloring on white bgcolor
#3048
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
45e7a3d

contrast common hover label font color w/ bgcolor


etpinard Sep 24, 2018
864f941

do not use hoverlabel.bgcolor for "name" part of hover label


etpinard Sep 24, 2018

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


27 changes: 18 additions & 9 deletions
src/components/fx/hover.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -703,6 +703,7 @@ function createHoverText(hoverData, opts, gd) {

 var commonBgColor = commonLabelOpts.bgcolor || Color.defaultLine;
 var commonStroke = commonLabelOpts.bordercolor || Color.contrast(commonBgColor);
 var contrastColor = Color.contrast(commonBgColor);

 lpath.style({
 fill: commonBgColor,
Expand All@@ -713,7 +714,7 @@ function createHoverText(hoverData, opts, gd) {
 .call(Drawing.font,
 commonLabelOpts.font.family || fontFamily,
 commonLabelOpts.font.size || fontSize,
 commonLabelOpts.font.color || Color.background
 commonLabelOpts.font.color || contrastColor
 )
 .call(svgTextUtils.positionText, 0, 0)
 .call(svgTextUtils.convertToTspans, gd);
Expand DownExpand Up@@ -795,12 +796,20 @@ function createHoverText(hoverData, opts, gd) {
 var name = '';
 var text = '';

 // combine possible non-opaque trace color with bgColor
 var baseColor = Color.opacity(d.color) ? d.color : Color.defaultLine;
 var traceColor = Color.combine(baseColor, bgColor);

 // combine possible non-opaque trace color with bgColor
 var color0 = d.bgcolor || d.color;
 // color for 'nums' part of the label
 var numsColor = Color.combine(
 Color.opacity(color0) ? color0 : Color.defaultLine,
 bgColor
 );
 // color for 'name' part of the label
 var nameColor = Color.combine(
 Color.opacity(d.color) ? d.color : Color.defaultLine,
 bgColor
 );
 // find a contrasting color for border and text
 var contrastColor = d.borderColor || Color.contrast(traceColor);
 var contrastColor = d.borderColor || Color.contrast(numsColor);

 // to get custom 'name' labels pass cleanPoint
 if(d.nameOverride !== undefined) d.name = d.nameOverride;
Expand DownExpand Up@@ -869,7 +878,7 @@ function createHoverText(hoverData, opts, gd) {
 tx2.call(Drawing.font,
 d.fontFamily || fontFamily,
 d.fontSize || fontSize,
traceColor)
nameColor)
 .text(name)
 .attr('data-notex', 1)
 .call(svgTextUtils.positionText, 0, 0)
Expand All@@ -883,7 +892,7 @@ function createHoverText(hoverData, opts, gd) {

 g.select('path')
 .style({
 fill: traceColor,
 fill: numsColor,
 stroke: contrastColor
 });
 var tbb = tx.node().getBoundingClientRect();
Expand DownExpand Up@@ -1189,7 +1198,7 @@ function cleanPoint(d, hovermode) {
 }

 fill('hoverinfo', 'hi', 'hoverinfo');
 fill('color', 'hbg', 'hoverlabel.bgcolor');
 fill('bgcolor', 'hbg', 'hoverlabel.bgcolor');
 fill('borderColor', 'hbc', 'hoverlabel.bordercolor');
 fill('fontFamily', 'htf', 'hoverlabel.font.family');
 fill('fontSize', 'hts', 'hoverlabel.font.size');
Expand Down

74 changes: 70 additions & 4 deletions
test/jasmine/tests/hover_label_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2062,7 +2062,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
@alexcjohnsonalexcjohnsonSep 25, 2018

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Ha yeah, that would be a problem! FWIW, we'd have had a chance anyway of catching this bug when we wrote the test if it said something like
path: {bg: 'rgb(255, 255, 255)', border: 'rgb(68, 68, 68)'}, // or fill & line...
text: [13, 'Arial', 'rgb(255, 255, 255)']

So it'd be immediately obvious that the path bg matches the font color, and the font cannot be seen!

As it is path has two colors so it's unclear what they mean. text is unambiguous because all items are different types, so it's OK as an array, though still perhaps awkward as you need to know the order to write the test.
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2074,7 +2074,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2086,7 +2086,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test arrayOk case
Expand All@@ -2113,7 +2113,7 @@ describe('Test hover label custom styling:', function() {
 assertPtLabel(null);
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test base case
Expand DownExpand Up@@ -2203,6 +2203,72 @@ describe('Test hover label custom styling:', function() {
 .then(done);
 });

 it('should work for x/y cartesian traces (multi-trace case)', function(done) {
 var gd = createGraphDiv();

 function assertNameLabel(expectation) {
 var g = d3.selectAll('g.hovertext > text.name');

 if(expectation === null) {
 expect(g.size()).toBe(0);
 } else {
 g.each(function(_, i) {
 var textStyle = window.getComputedStyle(this);
 expect(textStyle.fill).toBe(expectation.color[i]);
 });
 }
 }

 Plotly.plot(gd, [{
 x: [1, 2, 3],
 y: [1, 2, 1],
 }, {
 x: [1, 2, 3],
 y: [4, 5, 4],
 }], {
 hovermode: 'x',
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(31, 119, 180)', 'rgb(255, 127, 14)']
 });
 return Plotly.restyle(gd, 'marker.color', ['red', 'blue']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.relayout(gd, 'hoverlabel.bgcolor', 'white');
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should not affect the name font color
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0.1)', 'rgba(0,0,255,0.1)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should blend with plot_bgcolor
 assertNameLabel({
 color: ['rgb(255, 179, 179)', 'rgb(179, 179, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0)', 'rgba(0,0,255,0)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // uses default line color when opacity=0
 assertNameLabel({
 color: ['rgb(68, 68, 68)', 'rgb(68, 68, 68)']
 });
 })
 .catch(failTest)
 .then(done);
 });

 it('should work for 2d z cartesian traces', function(done) {
 var gd = createGraphDiv();

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Fix hover label coloring on white bgcolor by etpinard · Pull Request #3048 · plotly/plotly.js · GitHub
Skip to content
Fix hover label coloring on white bgcolor#3048

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

etpinard
merged 2 commits into

from

Sep 25, 2018
 Merged


Fix hover label coloring on white bgcolor
#3048
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
45e7a3d

contrast common hover label font color w/ bgcolor


etpinard Sep 24, 2018
864f941

do not use hoverlabel.bgcolor for "name" part of hover label


etpinard Sep 24, 2018

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


27 changes: 18 additions & 9 deletions
src/components/fx/hover.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -703,6 +703,7 @@ function createHoverText(hoverData, opts, gd) {

 var commonBgColor = commonLabelOpts.bgcolor || Color.defaultLine;
 var commonStroke = commonLabelOpts.bordercolor || Color.contrast(commonBgColor);
 var contrastColor = Color.contrast(commonBgColor);

 lpath.style({
 fill: commonBgColor,
Expand All@@ -713,7 +714,7 @@ function createHoverText(hoverData, opts, gd) {
 .call(Drawing.font,
 commonLabelOpts.font.family || fontFamily,
 commonLabelOpts.font.size || fontSize,
 commonLabelOpts.font.color || Color.background
 commonLabelOpts.font.color || contrastColor
 )
 .call(svgTextUtils.positionText, 0, 0)
 .call(svgTextUtils.convertToTspans, gd);
Expand DownExpand Up@@ -795,12 +796,20 @@ function createHoverText(hoverData, opts, gd) {
 var name = '';
 var text = '';

 // combine possible non-opaque trace color with bgColor
 var baseColor = Color.opacity(d.color) ? d.color : Color.defaultLine;
 var traceColor = Color.combine(baseColor, bgColor);

 // combine possible non-opaque trace color with bgColor
 var color0 = d.bgcolor || d.color;
 // color for 'nums' part of the label
 var numsColor = Color.combine(
 Color.opacity(color0) ? color0 : Color.defaultLine,
 bgColor
 );
 // color for 'name' part of the label
 var nameColor = Color.combine(
 Color.opacity(d.color) ? d.color : Color.defaultLine,
 bgColor
 );
 // find a contrasting color for border and text
 var contrastColor = d.borderColor || Color.contrast(traceColor);
 var contrastColor = d.borderColor || Color.contrast(numsColor);

 // to get custom 'name' labels pass cleanPoint
 if(d.nameOverride !== undefined) d.name = d.nameOverride;
Expand DownExpand Up@@ -869,7 +878,7 @@ function createHoverText(hoverData, opts, gd) {
 tx2.call(Drawing.font,
 d.fontFamily || fontFamily,
 d.fontSize || fontSize,
traceColor)
nameColor)
 .text(name)
 .attr('data-notex', 1)
 .call(svgTextUtils.positionText, 0, 0)
Expand All@@ -883,7 +892,7 @@ function createHoverText(hoverData, opts, gd) {

 g.select('path')
 .style({
 fill: traceColor,
 fill: numsColor,
 stroke: contrastColor
 });
 var tbb = tx.node().getBoundingClientRect();
Expand DownExpand Up@@ -1189,7 +1198,7 @@ function cleanPoint(d, hovermode) {
 }

 fill('hoverinfo', 'hi', 'hoverinfo');
 fill('color', 'hbg', 'hoverlabel.bgcolor');
 fill('bgcolor', 'hbg', 'hoverlabel.bgcolor');
 fill('borderColor', 'hbc', 'hoverlabel.bordercolor');
 fill('fontFamily', 'htf', 'hoverlabel.font.family');
 fill('fontSize', 'hts', 'hoverlabel.font.size');
Expand Down

74 changes: 70 additions & 4 deletions
test/jasmine/tests/hover_label_test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2062,7 +2062,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
@alexcjohnsonalexcjohnsonSep 25, 2018

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Ha yeah, that would be a problem! FWIW, we'd have had a chance anyway of catching this bug when we wrote the test if it said something like
path: {bg: 'rgb(255, 255, 255)', border: 'rgb(68, 68, 68)'}, // or fill & line...
text: [13, 'Arial', 'rgb(255, 255, 255)']

So it'd be immediately obvious that the path bg matches the font color, and the font cannot be seen!

As it is path has two colors so it's unclear what they mean. text is unambiguous because all items are different types, so it's OK as an array, though still perhaps awkward as you need to know the order to write the test.
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2074,7 +2074,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });
 })
 .then(function() {
Expand All@@ -2086,7 +2086,7 @@ describe('Test hover label custom styling:', function() {
 });
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test arrayOk case
Expand All@@ -2113,7 +2113,7 @@ describe('Test hover label custom styling:', function() {
 assertPtLabel(null);
 assertCommonLabel({
 path: ['rgb(255, 255, 255)', 'rgb(68, 68, 68)'],
 text: [13, 'Arial', 'rgb(255, 255, 255)']
 text: [13, 'Arial', 'rgb(68, 68, 68)']
 });

 // test base case
Expand DownExpand Up@@ -2203,6 +2203,72 @@ describe('Test hover label custom styling:', function() {
 .then(done);
 });

 it('should work for x/y cartesian traces (multi-trace case)', function(done) {
 var gd = createGraphDiv();

 function assertNameLabel(expectation) {
 var g = d3.selectAll('g.hovertext > text.name');

 if(expectation === null) {
 expect(g.size()).toBe(0);
 } else {
 g.each(function(_, i) {
 var textStyle = window.getComputedStyle(this);
 expect(textStyle.fill).toBe(expectation.color[i]);
 });
 }
 }

 Plotly.plot(gd, [{
 x: [1, 2, 3],
 y: [1, 2, 1],
 }, {
 x: [1, 2, 3],
 y: [4, 5, 4],
 }], {
 hovermode: 'x',
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(31, 119, 180)', 'rgb(255, 127, 14)']
 });
 return Plotly.restyle(gd, 'marker.color', ['red', 'blue']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.relayout(gd, 'hoverlabel.bgcolor', 'white');
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should not affect the name font color
 assertNameLabel({
 color: ['rgb(255, 0, 0)', 'rgb(0, 0, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0.1)', 'rgba(0,0,255,0.1)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // should blend with plot_bgcolor
 assertNameLabel({
 color: ['rgb(255, 179, 179)', 'rgb(179, 179, 255)']
 });
 return Plotly.restyle(gd, 'marker.color', ['rgba(255,0,0,0)', 'rgba(0,0,255,0)']);
 })
 .then(function() {
 _hover(gd, { xval: gd._fullData[0].x[0] });
 // uses default line color when opacity=0
 assertNameLabel({
 color: ['rgb(68, 68, 68)', 'rgb(68, 68, 68)']
 });
 })
 .catch(failTest)
 .then(done);
 });

 it('should work for 2d z cartesian traces', function(done) {
 var gd = createGraphDiv();

Expand Down