Skip to content
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

Jump to bottom

Fix *toggleothers* behavior for graphs with traces not in legend #4406

Merged
merged 1 commit into from
Dec 4, 2019
Merged

Fix *toggleothers* behavior for graphs with traces not in legend #4406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 3 deletions src/components/legend/handle_click.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,12 @@ module.exports = function handleClick(g, gd, numClicks) {
} else if(mode === 'toggleothers') {
// Compute the clicked index. expandedIndex does what we want for expanded traces
// but also culls hidden traces. That means we have some work to do.
var isClicked, isInGroup, otherState;
var isClicked, isInGroup, notInLegend, otherState;
var isIsolated = true;
for(i = 0; i < fullData.length; i++) {
isClicked = fullData[i] === fullTrace;
if(isClicked) continue;
notInLegend = fullData[i].showlegend !== true;
if(isClicked || notInLegend) continue;

isInGroup = (hasLegendgroup && fullData[i].legendgroup === legendgroup);

Expand All @@ -194,8 +195,10 @@ module.exports = function handleClick(g, gd, numClicks) {
case true:
otherState = isIsolated ? true : 'legendonly';
isClicked = fullData[i] === fullTrace;
// N.B. consider traces that have a set legendgroup as toggleable
notInLegend = (fullData[i].showlegend !== true && !fullData[i].legendgroup);
isInGroup = isClicked || (hasLegendgroup && fullData[i].legendgroup === legendgroup);
setVisibility(fullData[i], isInGroup ? true : otherState);
setVisibility(fullData[i], (isInGroup || notInLegend) ? true : otherState);
break;
}
}
Expand Down
47 changes: 47 additions & 0 deletions test/jasmine/tests/legend_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1519,6 +1519,53 @@ describe('legend interaction', function() {
});
});

describe('legend visibility with *showlegend:false* traces', function() {
beforeEach(function(done) {
Plotly.plot(gd, [
{y: [1, 2, 3]},
{y: [2, 3, 1]},
{type: 'heatmap', z: [[1, 2], [3, 4]], showscale: false}
])
.then(done);
});

it('isolate trace in legend, ignore trace that is not in legend', function(done) {
Promise.resolve()
.then(click(0, 2))
.then(assertVisible([true, 'legendonly', true]))
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This used to result [true. 'legendonly', 'legendonly']

.then(click(0, 2))
.then(assertVisible([true, true, true]))
.catch(failTest).then(done);
});

it('isolate trace in legend, ignore trace that is not in legend (2)', function(done) {
Promise.resolve()
.then(click(1, 2))
.then(assertVisible(['legendonly', true, true]))
Copy link
Contributor Author

@etpinard etpinard Dec 3, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

This one used to result ['legendonly', true, 'legendonly']

.then(click(1, 2))
.then(assertVisible([true, true, true]))
.catch(failTest).then(done);
});

it('isolate trace in legend AND trace in associated legendgroup', function(done) {
Plotly.restyle(gd, 'legendgroup', ['group', '', 'group'])
.then(click(0, 2))
.then(assertVisible([true, 'legendonly', true]))
.then(click(0, 2))
.then(assertVisible([true, true, true]))
.catch(failTest).then(done);
});

it('isolate trace in legend, hide trace not in legend that has set legendgroup', function(done) {
Plotly.restyle(gd, 'legendgroup', ['group', '', 'group'])
.then(click(1, 2))
.then(assertVisible(['legendonly', true, 'legendonly']))
.then(click(1, 2))
.then(assertVisible([true, true, true]))
.catch(failTest).then(done);
});
});

describe('custom legend click/doubleclick handlers', function() {
var fig, to;

Expand Down