visInteraction {visNetwork} | R Documentation |
Network visualization interaction
Description
Network visualization interaction. For full documentation, have a look at visDocumentation.
Usage
visInteraction(
graph,
dragNodes = NULL,
dragView = NULL,
hideEdgesOnDrag = NULL,
hideEdgesOnZoom = NULL,
hideNodesOnDrag = NULL,
hover = NULL,
hoverConnectedEdges = NULL,
keyboard = NULL,
multiselect = NULL,
navigationButtons = NULL,
selectable = NULL,
selectConnectedEdges = NULL,
tooltipDelay = NULL,
tooltipStay = 300,
tooltipStyle = NULL,
zoomView = NULL,
zoomSpeed = 1
)
Arguments
graph |
: a visNetwork object |
dragNodes |
: Boolean. Default to true. When true, the nodes that are not fixed can be dragged by the user. |
dragView |
: Boolean. Default to true. When true, the view can be dragged around by the user. |
hideEdgesOnDrag |
: Boolean. Default to false. When true, the edges are not drawn when dragging the view. This can greatly speed up responsiveness on dragging, improving user experience. |
hideEdgesOnZoom |
: Boolean. Default to false. When true, the edges are not drawn when zooming the view. This can greatly speed up responsiveness on zooming, improving user experience. |
hideNodesOnDrag |
: Boolean. Default to false. When true, the nodes are not drawn when dragging the view. This can greatly speed up responsiveness on dragging, improving user experience. |
hover |
: Boolean. Default to false. When true, the nodes use their hover colors when the mouse moves over them. |
hoverConnectedEdges |
: Boolean. Default to true. When true, on hovering over a node, it's connecting edges are highlighted. |
keyboard |
: Just a Boolean, or a named list. When true, the keyboard shortcuts are enabled with the default settings. For further customization, you can supply an object.
|
multiselect |
: Boolean. Default to false. When true, a longheld click (or touch) as well as a control-click will add to the selection. |
navigationButtons |
: Boolean. Default to false. When true, navigation buttons are drawn on the network canvas. These are HTML buttons and can be completely customized using CSS. |
selectable |
: Boolean. Default to true When true, the nodes and edges can be selected by the user. |
selectConnectedEdges |
: Boolean. Default to true. When true, on selecting a node, its connecting edges are highlighted. |
tooltipDelay |
: Number. Default to 300. When nodes or edges have a defined 'title' field, this can be shown as a pop-up tooltip. The tooltip itself is an HTML element that can be fully styled using CSS. The delay is the amount of time in milliseconds it takes before the tooltip is shown. |
tooltipStay |
: Number. Default to 300. This is the amount of time in milliseconds it takes before the tooltip is hidden. |
tooltipStyle |
: Character. HTML style of tooltip. You must use 'position: fixed;visibility:hidden;'. |
zoomView |
: Boolean. Default to true. When true, the user can zoom in. |
zoomSpeed |
: Number. Default to 1. How fast/rough or slow/precise zooming is. |
References
See online documentation https://datastorm-open.github.io/visNetwork/
See Also
visNodes for nodes options, visEdges for edges options, visGroups for groups options, visLegend for adding legend, visOptions for custom option, visLayout & visHierarchicalLayout for layout, visPhysics for control physics, visInteraction for interaction, visNetworkProxy & visFocus & visFit for animation within shiny, visDocumentation, visEvents, visConfigure ...
Examples
nodes <- data.frame(id = 1:10,
title = '<a target="_blank" href="https://github.com/datastorm-open/visNetwork">github</a>')
edges <- data.frame(from = round(runif(8)*10), to = round(runif(8)*10))
# custom tooltip
# default value : 'position: fixed;visibility:hidden;padding: 5px;font-family: verdana;
# font-size:14px;font-color:#000000;background-color: #f5f4ed;-moz-border-radius: 3px;*
# -webkit-border-radius: 3px;border-radius: 3px; border: 1px solid #808074;
# box-shadow: 3px 3px 10px rgba(0, 0, 0, 0.2);max-width:400px;word-break: break-all'
visNetwork(nodes, edges) %>%
visInteraction(tooltipStyle = 'position: fixed;visibility:hidden;padding: 5px;white-space: nowrap;
font-family: cursive;font-size:18px;font-color:purple;background-color: red;')
nodes <- data.frame(id = 1:3)
edges <- data.frame(from = c(1,2), to = c(1,3))
# frozen network
visNetwork(nodes, edges) %>%
visInteraction(dragNodes = FALSE, dragView = FALSE, zoomView = FALSE)
visNetwork(nodes, edges) %>%
visInteraction(hideEdgesOnDrag = TRUE)
visNetwork(nodes, edges) %>%
visInteraction(hover = TRUE)
# navigation button
visNetwork(nodes, edges) %>%
visInteraction(navigationButtons = TRUE)
visNetwork(nodes, edges) %>%
visInteraction(selectConnectedEdges = FALSE)
visNetwork(nodes, edges) %>%
visInteraction(multiselect = TRUE)
visNetwork(nodes, edges) %>%
visInteraction(keyboard = TRUE)