Added documentation for the new clickAction argument.

Merge branch 'dev'

# Conflicts:
#	DESCRIPTION

R/chorddiag.R

@@ -65,6 +65,7 @@
 #'   triangle pointing from source to target.
 #' @param precision Integer number of significant digits to be used for tooltip
 #'   display.
+#' @param clickAction character string containing JavaScript code to be executed on a mouse click so that shiny can get the sourceIndex and targetIndex for the purpose of filtering the data on other visualizations
 #'
 #' @source Based on \url{http://bl.ocks.org/mbostock/4062006} with several
 #'   modifications.
@@ -105,7 +106,8 @@ chorddiag <- function(data,
                       tooltipUnit = NULL,
                       tooltipFontsize = 12,
                       tooltipGroupConnector = " &#x25B6; ",
-                      precision = NULL) {
+                      precision = NULL,
+                      clickAction = NULL) {
 
     if (!is.matrix(data))
         stop("'data' must be a matrix class object.")
@@ -206,7 +208,8 @@ chorddiag <- function(data,
                                  tooltipFontsize = tooltipFontsize,
                                  tooltipUnit = tooltipUnit,
                                  tooltipGroupConnector = tooltipGroupConnector,
-                                 precision = precision))
+                                 precision = precision,
+                                 clickAction = clickAction))
     params = Filter(Negate(is.null), params)
 
     # create widget

inst/examples/shiny/server.R

@@ -19,6 +19,12 @@ shinyServer(function(input, output) {
                   groupColors = groupColors,
                   groupnamePadding = input$groupnamePadding,
                   showTicks = input$showTicks,
-                  margin = input$margin)
+                  margin = input$margin,
+                  clickAction = "Shiny.onInputChange('sourceIndex', d.source.index+1);
+                                Shiny.onInputChange('targetIndex', d.target.index+1);")
     )
+
+    output$shiny_return <- renderPrint({
+        paste0(groupNames[input$sourceIndex], " <-> ", groupNames[input$targetIndex])
+    })
 })

inst/examples/shiny/ui.R

@@ -12,7 +12,8 @@ shinyUI(fluidPage(
         ),
 
         mainPanel(
-            chorddiagOutput('chorddiag', height = '600px')
+            chorddiagOutput('chorddiag', height = '600px'),
+            verbatimTextOutput("shiny_return")
         )
     )
 ))

inst/htmlwidgets/chorddiag.js

@@ -217,7 +217,8 @@ HTMLWidgets.widget({
           .on("mouseout", function(d) {
               if (showTooltips) chordTip.hide(d);
               return chordFade(d, 1);
-          });
+          })
+          .on("click", click);
 
     // create group labels
     if (showGroupnames) {
@@ -338,6 +339,10 @@ HTMLWidgets.widget({
         var mult = Math.pow(10, sig - Math.floor(Math.log(n) / Math.LN10) - 1);
         return Math.round(n * mult) / mult;
     }
+
+    function click(d) {
+      return eval(options.clickAction);
+    }
 
   }  // end renderValue function