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

Add legend click interaction attrs #3862

Merged
merged 4 commits into from
May 21, 2019
Merged

Add legend click interaction attrs #3862

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a03e4e6
add legend itemclick and itemdoubleclick attrs
etpinard May 14, 2019
88e566a
fix typo in itemclick, itemdoubleclick attr descriptions
etpinard May 15, 2019
8190738
improve itemclick / itemdoubleclick tests
etpinard May 15, 2019
bde19ee
replace 'focus' -> 'toggleothers'
etpinard May 17, 2019
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: 27 additions & 0 deletions src/components/legend/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,33 @@ module.exports = {
].join(' ')
},

itemclick: {
valType: 'enumerated',
values: ['toggle', 'focus', false],
dflt: 'toggle',
role: 'info',
editType: 'legend',
description: [
'Determines the behavior on legend item click.',
'*toggle* toggles the visible of the item clicked on the graph.',
antoinerg marked this conversation as resolved.
Show resolved Hide resolved
'*focus* makes the clicked item the sole visible item on the graph.',
'*false* disable legend item click interactions.'
].join(' ')
},
itemdoubleclick: {
antoinerg marked this conversation as resolved.
Show resolved Hide resolved
valType: 'enumerated',
values: ['toggle', 'focus', false],
dflt: 'focus',
role: 'info',
editType: 'legend',
description: [
'Determines the behavior on legend item double-click.',
'*toggle* toggles the visible of the item clicked on the graph.',
antoinerg marked this conversation as resolved.
Show resolved Hide resolved
'*focus* makes the clicked item the sole visible item on the graph.',
'*false* disable legend item double-click interactions.'
].join(' ')
},

x: {
valType: 'number',
min: -2,
Expand Down
3 changes: 3 additions & 0 deletions src/components/legend/defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@ module.exports = function legendDefaults(layoutIn, layoutOut, fullData) {

coerce('itemsizing');

coerce('itemclick');
coerce('itemdoubleclick');

coerce('x', defaultX);
coerce('xanchor', defaultXAnchor);
coerce('y', defaultY);
Expand Down
38 changes: 25 additions & 13 deletions src/components/legend/handle_click.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,29 @@ var Registry = require('../../registry');
var SHOWISOLATETIP = true;

module.exports = function handleClick(g, gd, numClicks) {
var fullLayout = gd._fullLayout;

if(gd._dragged || gd._editing) return;

var hiddenSlices = gd._fullLayout.hiddenlabels ?
gd._fullLayout.hiddenlabels.slice() :
var itemClick = fullLayout.legend.itemclick;
var itemDoubleClick = fullLayout.legend.itemdoubleclick;

if(numClicks === 1 && itemClick === 'toggle' && itemDoubleClick === 'focus' &&
SHOWISOLATETIP && gd.data && gd._context.showTips
) {
Lib.notifier(Lib._(gd, 'Double-click on legend to isolate one trace'), 'long');
SHOWISOLATETIP = false;
} else {
SHOWISOLATETIP = false;
}

var mode;
if(numClicks === 1) mode = itemClick;
else if(numClicks === 2) mode = itemDoubleClick;
if(!mode) return;

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

var legendItem = g.data()[0][0];
Expand Down Expand Up @@ -85,21 +104,14 @@ module.exports = function handleClick(g, gd, numClicks) {
}
}

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

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

if(numClicks === 1) {
if(mode === 'toggle') {
if(thisLabelIndex === -1) hiddenSlices.push(thisLabel);
else hiddenSlices.splice(thisLabelIndex, 1);
} else if(numClicks === 2) {
} else if(mode === 'focus') {
hiddenSlices = [];
gd.calcdata[0].forEach(function(d) {
if(thisLabel !== d.label) {
Expand All @@ -126,7 +138,7 @@ module.exports = function handleClick(g, gd, numClicks) {
}
}

if(numClicks === 1) {
if(mode === 'toggle') {
var nextVisibility;

switch(fullTrace.visible) {
Expand All @@ -150,7 +162,7 @@ module.exports = function handleClick(g, gd, numClicks) {
} else {
setVisibility(fullTrace, nextVisibility);
}
} else if(numClicks === 2) {
} else if(mode === 'focus') {
// 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;
Expand Down
63 changes: 62 additions & 1 deletion test/jasmine/tests/legend_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1067,7 +1067,6 @@ describe('legend interaction', function() {
});
});


describe('editable mode interactions', function() {
var gd;

Expand Down Expand Up @@ -1667,6 +1666,68 @@ describe('legend interaction', function() {
.then(done);
});
});

describe('should honor *itemclick* and *itemdoubleclick* settings', function() {
var _assert;

function run() {
return Promise.resolve()
.then(click(0, 1)).then(_assert(['legendonly', true]))
.then(click(0, 1)).then(_assert([true, true]))
.then(click(0, 2)).then(_assert([true, 'legendonly']))
.then(click(0, 2)).then(_assert([true, true]))
.then(function() {
return Plotly.relayout(gd, {
'legend.itemclick': false,
'legend.itemdoubleclick': false
});
})
.then(click(0, 1)).then(_assert([true, true]))
.then(click(0, 2)).then(_assert([true, true]))
.then(function() {
return Plotly.relayout(gd, {
'legend.itemclick': 'focus',
'legend.itemdoubleclick': 'toggle'
});
})
.then(click(0, 1)).then(_assert([true, 'legendonly']))
.then(click(0, 1)).then(_assert([true, true]))
.then(click(0, 2)).then(_assert(['legendonly', true]))
.then(click(0, 2)).then(_assert([true, true]));
}

it('- regular trace case', function(done) {
_assert = assertVisible;

Plotly.plot(gd, [
{ y: [1, 2, 1] },
{ y: [2, 1, 2] }
antoinerg marked this conversation as resolved.
Show resolved Hide resolved
])
.then(run)
.catch(failTest)
.then(done);
});

it('- pie case', function(done) {
_assert = function(exp) {
return function() {
var actual = [];
if(exp[0] === 'legendonly') actual.push('B');
if(exp[1] === 'legendonly') actual.push('A');
expect(actual).toEqual(gd._fullLayout.hiddenlabels || []);
};
};

Plotly.plot(gd, [{
type: 'pie',
labels: ['A', 'B'],
values: [1, 2]
}])
.then(run)
.catch(failTest)
.then(done);
});
});
});
});

Expand Down