R/animate.R

In sigmajs: Interface to 'Sigma.js' Graph Visualization Library

#' Animate 
#' 
#' Animate graph components.
#'
#' @param sg An object of class \code{sigmajs}as intatiated by \code{\link{sigmajs}}.
#' @param mapping Variables to map animation to.
#' @param options Animations options.
#' @param delay Delay in milliseconds before animation is triggered.
#' 
#' @details You can animate, \code{x}, \code{y}, \code{size} and \code{color}.
#'
#' @examples
#' # generate graph
#' nodes <- sg_make_nodes(20)
#' edges <- sg_make_edges(nodes, 30)
#' 
#' # add transition
#' n <- nrow(nodes)
#' nodes$to_x <- runif(n, 5, 10)
#' nodes$to_y <- runif(n, 5, 10)
#' nodes$to_size <- runif(n, 5, 10)
#' 
#' sigmajs() %>%
#'   sg_nodes(nodes, id, label, size, color, to_x, to_y, to_size) %>%
#'   sg_edges(edges, id, source, target) %>% 
#'   sg_animate(mapping = list(x = "to_x", y = "to_y", size = "to_size"))
#' 
#' @seealso \href{https://github.com/jacomyal/sigma.js/tree/master/plugins/sigma.plugins.animate}{official documentation}
#' 
#' @return An object of class \code{htmlwidget} which renders the visualisation on print.
#'
#' @rdname animation
#' @export
sg_animate <- function(sg, mapping, options = list(easing = "cubicInOut"), delay = 5000) {

	if (missing(sg) || missing(mapping))
		stop("missing sg or mapping", call. = FALSE)

  .test_sg(sg)

	sg$x$animateLoop <- FALSE
	sg$x$animateOptions <- options
	sg$x$animateMapping <- mapping
	sg$x$animateDelay <- delay

	sg
}