add clickAction in d3tree2 as point of discussion for #9

R/d3tree2.R

@@ -18,6 +18,10 @@
 #'           default is \code{"name"}.
 #' @param valueField \code{character} of the name of the field containing the value on which
 #'           you would like your treemap based.  The default is \code{"size"}.
+#' @param clickAction \code{character} or \code{htmlwidgets::JS} to provide additional
+#'           actions to perform when a tree node/cell is clicked.  The JavaScript function should
+#'           expect one argument, which will be the \code{object} of the node clicked, so the form
+#'           should look something like \code{function(d){ console.log(d) }}.
 #' @param width,height a valid \code{CSS} size for the width and height of the container.
 #'           Percentage values work also by supplying as \code{character} such as \code{width = "100\%"}
 #'
@@ -74,6 +78,7 @@ d3tree2 <- function(
   , celltext = "name"
   , id = "id"
   , valueField = "size"
+  , clickAction = NULL
   , width = NULL
   , height = NULL
 ) {
@@ -108,6 +113,11 @@ d3tree2 <- function(
   # accept list
   #  here we shouldn't need to do anything
 
+  # convert clickAction if character to htmlwidgets::JS
+  if(is.character(clickAction) && !inherits(clickAction,"JS_EVAL")){
+    clickAction <- htmlwidgets::JS(clickAction)
+  }
+
   # forward options using x
   x = list(
     data = data
@@ -117,6 +127,7 @@ d3tree2 <- function(
       celltext = celltext
       ,id = id
       ,valueField = valueField
+      ,clickAction = clickAction
     )
   )
 

inst/htmlwidgets/d3tree2.js

@@ -273,6 +273,11 @@ HTMLWidgets.widget({
           Shiny.onInputChange(el.id + '_click', {name:d[celltext]})
         }
 
+        // check for additional clickAction to perform
+        if( x.options.clickAction && typeof x.options.clickAction === "function" ){
+          x.options.clickAction(d);
+        }
+
         return g;
       }
 

man/d3tree2.Rd

@@ -5,7 +5,7 @@
 \title{Create an Interactive Treemap (Version 2)}
 \usage{
 d3tree2(data = NULL, rootname = NULL, celltext = "name", id = "id",
-  valueField = "size", width = NULL, height = NULL)
+  valueField = "size", clickAction = NULL, width = NULL, height = NULL)
 }
 \arguments{
 \item{data}{the data to be plotted as either
@@ -26,6 +26,11 @@ default is \code{"name"}.}
 \item{valueField}{\code{character} of the name of the field containing the value on which
 you would like your treemap based.  The default is \code{"size"}.}
 
+\item{clickAction}{\code{character} or \code{htmlwidgets::JS} to provide additional
+actions to perform when a tree node/cell is clicked.  The JavaScript function should
+expect one argument, which will be the \code{object} of the node clicked, so the form
+should look something like \code{function(d){ console.log(d) }}.}
+
 \item{width,height}{a valid \code{CSS} size for the width and height of the container.
           Percentage values work also by supplying as \code{character} such as \code{width = "100\%"}}
 }