Skip to content

Rewrite legend visibility toggling #2022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 20, 2017
Merged

Rewrite legend visibility toggling #2022

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5cc7dc6
Rewrite legend visibility toggling
rreusser Sep 19, 2017
6b8dd49
Lint-fix
rreusser Sep 19, 2017
f17d763
Add overlooked test
rreusser Sep 19, 2017
c729353
Fix small PR review issues for legend interactions
rreusser Sep 20, 2017
f8a78a2
Remove unused code in legend interactions
rreusser Sep 20, 2017
d23c24d
Move legend click handler to separate file
rreusser Sep 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
190 changes: 152 additions & 38 deletions src/components/legend/draw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,26 +480,76 @@ function setupTraceToggle(g, gd) {

function handleClick(g, gd, numClicks) {
if(gd._dragged || gd._editing) return;

var hiddenSlices = gd._fullLayout.hiddenlabels ?
gd._fullLayout.hiddenlabels.slice() :
[];

var legendItem = g.data()[0][0],
fullData = gd._fullData,
trace = legendItem.trace,
legendgroup = trace.legendgroup,
traceIndicesInGroup = [],
tracei,
newVisible;
var legendItem = g.data()[0][0];
var fullData = gd._fullData;
var fullTrace = legendItem.trace;
var legendgroup = fullTrace.legendgroup;

var i, j, carr, key, keys, val;
var attrUpdate = {};
var attrIndices = [];
var carrs = [];
var carrIdx = [];

function insertUpdate(traceIndex, key, value) {
var attrIndex = attrIndices.indexOf(traceIndex);
var valueArray = attrUpdate[key];
if(!valueArray) {
valueArray = attrUpdate[key] = [];
}

if(attrIndices.indexOf(traceIndex) === -1) {
attrIndices.push(traceIndex);
attrIndex = attrIndices.length - 1;
}

valueArray[attrIndex] = value;

return attrIndex;
}

function setVisibility(fullTrace, visibility) {
var fullInput = fullTrace._fullInput;
if(Registry.hasTransform(fullInput, 'groupby')) {
var carr = carrs[fullInput.index];
if(!carr) {
var groupbyIndices = Registry.getTransformIndices(fullInput, 'groupby');
var lastGroupbyIndex = groupbyIndices[groupbyIndices.length - 1];
carr = Lib.keyedContainer(fullInput, 'transforms[' + lastGroupbyIndex + '].styles', 'target', 'value.visible');
Copy link
Contributor

Choose a reason for hiding this comment

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

keyedContainer for the win 🏆

By the way, is carr short for container array?

Copy link
Contributor

Choose a reason for hiding this comment

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

... no need to rename carr to something more explicit, I'm just curious.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it's somewhat of a holdover. It's not great. Maybe kcont?

Copy link
Contributor

@etpinard etpinard Sep 20, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

carr or kcont, your call.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

kcont. ✅

carrs[fullInput.index] = carr;
}

// If not specified, assume visible:
var curState = carr.get(fullTrace._group) || true;
Copy link
Contributor

Choose a reason for hiding this comment

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

Why does this happen?

Copy link
Contributor

Choose a reason for hiding this comment

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

this === that || true fallback.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. This isn't a great conditional. If it's really fullData, it should always be present and what it means to be. I think I'll just remove this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Haha couldn't remove it. Modified it to be a bit more targeted/explicit. The issue is that the container doesn't always have visible defined. "Oh, so just use fullTrace.visible." That didn't work either. Broke some tests. Aimed for some middle ground that passes all the tests.


if(curState !== false) {
// true -> legendonly. All others toggle to true:
carr.set(fullTrace._group, visibility);
}
carrIdx[fullInput.index] = insertUpdate(fullInput.index, 'visible', fullInput.visible === false ? false : true);
} else {
// false -> false (not possible since will not be visible in legend)
Copy link
Contributor

Choose a reason for hiding this comment

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

👌

// true -> legendonly
// legendonly -> true
var nextVisibility = fullInput.visible === false ? false : visibility;

insertUpdate(fullInput.index, 'visible', nextVisibility);
}
}

if(numClicks === 1 && SHOWISOLATETIP && gd.data && gd._context.showTips) {
Lib.notifier('Double click on legend to isolate individual trace', 'long');
SHOWISOLATETIP = false;
} else {
SHOWISOLATETIP = false;
}
if(Registry.traceIs(trace, 'pie')) {

if(Registry.traceIs(fullTrace, 'pie')) {
var thisLabel = legendItem.label,
thisLabelIndex = hiddenSlices.indexOf(thisLabel);

Expand All @@ -520,52 +570,116 @@ function handleClick(g, gd, numClicks) {

Plotly.relayout(gd, 'hiddenlabels', hiddenSlices);
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can return early after Plotly.relayout for pie traces.

Copy link
Contributor

@etpinard etpinard Sep 20, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Ignore ⤴️ I misread the if block levels.

} else {
var allTraces = [],
traceVisibility = [],
i;

for(i = 0; i < fullData.length; i++) {
allTraces.push(i);
// Allow the legendonly state through for *all* trace types (including
// carpet for which it's overridden with true/false in supplyDefaults)
traceVisibility.push(
Registry.traceIs(fullData[i], 'notLegendIsolatable') ? true : 'legendonly'
);
}

if(legendgroup === '') {
traceIndicesInGroup = [trace.index];
traceVisibility[trace.index] = true;
} else {
var hasLegendgroup = legendgroup && legendgroup.length;
var traceIndicesInGroup = [];
var tracei;
if(hasLegendgroup) {
for(i = 0; i < fullData.length; i++) {
tracei = fullData[i];
if(!tracei.visible) continue;
if(tracei.legendgroup === legendgroup) {
traceIndicesInGroup.push(tracei.index);
traceVisibility[allTraces.indexOf(i)] = true;
traceIndicesInGroup.push(i);
}
}
}

if(numClicks === 1) {
newVisible = trace.visible === true ? 'legendonly' : true;
Plotly.restyle(gd, 'visible', newVisible, traceIndicesInGroup);
var nextVisibility;

switch(fullTrace.visible) {
case true:
nextVisibility = 'legendonly';
break;
case false:
nextVisibility = false;
break;
default:
Copy link
Contributor

@etpinard etpinard Sep 20, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

🔪 that default: ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

✅

case 'legendonly':
nextVisibility = true;
break;
}

if(hasLegendgroup) {
for(i = 0; i < fullData.length; i++) {
if(fullData[i].visible && fullData[i].legendgroup === legendgroup) {
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe fullData[i].visible !== false instead of fullData[i].visible would be best, to make things more explicit. It is easy to forget that visible supports two truthy values.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

✅

setVisibility(fullData[i], nextVisibility);
}
}
} else {
setVisibility(fullTrace, nextVisibility);
}
} else if(numClicks === 2) {
var sameAsLast = true;
// 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 clickedIndex, isIsolated, isClicked, isInGroup, otherState;
for(clickedIndex = 0; clickedIndex < fullData.length; clickedIndex++) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't clickedIndex simply fullTrace.index?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's see… it might be. I need to think about this just a bit. fullTrace.index vs. fullTrace._fullInput.index vs. fullTrace._expandedIndex obey slightly different rules. I think more often that not the answer was to avoid at all costs needing the index at all. I'll give the above a try.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, good catch. clickedIndex isn't actually used at all, which was the end result of trying to get this right (i.e. don't use it at all). I've removed this code.

if(fullData[clickedIndex] === fullTrace) break;
}

isIsolated = true;
for(i = 0; i < fullData.length; i++) {
if(fullData[i].visible !== traceVisibility[i]) {
sameAsLast = false;
isClicked = fullData[i] === fullTrace;
if(isClicked) continue;

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

if(!isInGroup && fullData[i].visible === true && !Registry.traceIs(fullData[i], 'notLegendIsolatable')) {
isIsolated = false;
break;
}
}
if(sameAsLast) {
traceVisibility = true;
}
var visibilityUpdates = [];

for(i = 0; i < fullData.length; i++) {
visibilityUpdates.push(allTraces[i]);
// False is sticky; we don't change it.
if(fullData[i].visible === false) continue;

if(Registry.traceIs(fullData[i], 'notLegendIsolatable')) {
continue;
}

switch(fullTrace.visible) {
case 'legendonly':
setVisibility(fullData[i], true);
break;
case true:
otherState = isIsolated ? true : 'legendonly';
isClicked = fullData[i] === fullTrace;
isInGroup = isClicked || (hasLegendgroup && fullData[i].legendgroup === legendgroup);
setVisibility(fullData[i], isInGroup ? true : otherState);
break;
}
}
}

for(i = 0; i < carrs.length; i++) {
carr = carrs[i];
if(!carr) continue;
var update = carr.constructUpdate();

var updateKeys = Object.keys(update);
for(j = 0; j < updateKeys.length; j++) {
key = updateKeys[j];
val = attrUpdate[key] = attrUpdate[key] || [];
val[carrIdx[i]] = update[key];
}
}

// The length of the value arrays should be equal and any unspecified
// values should be explicitly undefined for them to get properly culled
// as updates and not accidentally reset to the default value. This fills
// out sparse arrays with the required number of undefined values:
Copy link
Contributor

Choose a reason for hiding this comment

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

Very nice touch 👌

keys = Object.keys(attrUpdate);
for(i = 0; i < keys.length; i++) {
key = keys[i];
for(j = 0; j < attrIndices.length; j++) {
// Use hasOwnPropety to protect against falsey values:
if(!attrUpdate[key].hasOwnProperty(j)) {
attrUpdate[key][j] = undefined;
}
}
Plotly.restyle(gd, 'visible', traceVisibility, visibilityUpdates);
}

Plotly.restyle(gd, attrUpdate, attrIndices);
}
}

Expand Down
Loading