8000 debounce the turnOn callback by cpsievert · Pull Request #1277 · plotly/plotly.R · GitHub
[go: up one dir, main page]
Skip to content

debounce the turnOn callback #1277

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 4 commits into from
Jun 4, 2018
Merged

debounce the turnOn callback #1277

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
53cab09
debounce the turnOn callback
cpsievert Jun 4, 2018
3f05b98
update to plotly.js v1.38.2
cpsievert Jun 4, 2018
f3aa108
document
cpsievert Jun 4, 2018
0cf12e5
update news
cpsievert Jun 4, 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
Next Next commit
debounce the turnOn callback
  • Loading branch information
@cpsievert
cpsievert committed Jun 4, 2018
commit 53cab096231f3f306f798e098546f51ca495e475
9 changes: 7 additions & 2 deletions R/highlight.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@
#' @param opacityDim a number between 0 and 1 used to reduce the
#' opacity of non-selected traces (by multiplying with the existing opacity).
#' @param selected attributes of the selection, see [attrs_selected()].
#' @param debounce amount of time to wait before firing an event (in milliseconds).
#' This is especially useful when `on = "plotly_hover"` to avoid firing too many events
#' when users clickly move the mouse over relevant graphical marks.
#' @param ... currently not supported.
#' @export
#' @author Carson Sievert
Expand Down Expand Up @@ -80,7 +83,8 @@ highlight <- function(p, on = "plotly_click", off,
dynamic = FALSE, color = NULL,
selectize = FALSE, defaultValues = NULL,
opacityDim = getOption("opacityDim", 0.2),
selected = attrs_selected(), ...) {
selected = attrs_selected(), debounce = 1,
...) {

# currently ... is not-supported and will catch
# some arguments we supported at one point
Expand Down Expand Up @@ -154,7 +158,8 @@ highlight <- function(p, on = "plotly_click", off,
selectize = selectize,
defaultValues = defaultValues,
opacityDim = opacityDim,
selected = selected
selected = selected,
debounce = debounce
)

p
Expand Down
28 changes: 26 additions & 2 deletions inst/htmlwidgets/plotly.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ HTMLWidgets.widget({
selection.on("change", selectionChange);

// Set a crosstalk variable selection value, triggering an update
graphDiv.on(x.highlight.on, function turnOn(e) {
var turnOn = function(e) {
if (e) {
var selectedKeys = pointsToKeys(e.points);
// Keys are group names, values are array of selected keys from group.
Expand All @@ -470,7 +470,9 @@ HTMLWidgets.widget({
}
}
}
});
};

graphDiv.on(x.highlight.on, debounce(turnOn, x.highlight.debounce));

graphDiv.on(x.highlight.off, function turnOff(e) {
// remove any visual clues
Expand Down Expand Up @@ -878,3 +880,25 @@ function removeBrush(el) {
outlines[i].remove();
}
}


// https://davidwalsh.name/javascript-debounce-function

// Returns a function, that, as long as it continues to be invoked, will not
// be triggered. The function will be called after it stops being called for
// N milliseconds. If `immediate` is passed, trigger the function on the
// leading edge, instead of the trailing.
function debounce(func, wait, immediate) {
var timeout;
return function() {
var context = this, args = arguments;
var later = function() {
timeout = null;
if (!immediate) func.apply(context, args);
};
var callNow = immediate && !timeout;
clearTimeout(timeout);
timeout = setTimeout(later, wait);
if (callNow) func.apply(context, args);
};
};
0