start proxy draft

Author: DivadNojnarg

DESCRIPTION

@@ -13,4 +13,6 @@ RoxygenNote: 7.3.2
 URL: https://github.com/cynkra/shinyG6
 BugReports: https://github.com/cynkra/shinyG6/issues
 Imports: 
-    htmlwidgets
+    htmlwidgets,
+    shiny
+

NAMESPACE

@@ -28,6 +28,8 @@ export(g6Output)
 export(g6_behaviors)
 export(g6_options)
 export(g6_plugins)
+export(g6_proxy)
+export(g6_remove_nodes)
 export(grid_line)
 export(history)
 export(hover_activate)
@@ -46,3 +48,5 @@ export(toolbar)
 export(tooltip)
 export(watermark)
 export(zoom_canvas)
+import(htmlwidgets)
+importFrom(stats,setNames)

R/pkg.R

@@ -0,0 +1,6 @@
+#' @keywords internal
+"_PACKAGE"
+
+#' @importFrom stats setNames
+#' @import htmlwidgets
+NULL

R/proxy.R

@@ -0,0 +1,70 @@
+#' Create a proxy object to modify an existing g6 graph instance
+#'
+#' This function creates a proxy object that can be used to update an existing g6 graph
+#' instance after it has been rendered in the UI. The proxy allows for server-side
+#' modifications of the graph without completely re-rendering it.
+#'
+#' @param id Character string matching the ID of the g6 graph instance to be modified.
+#' @param session The Shiny session object within which the graph exists.
+#'   By default, this uses the current reactive domain.
+#'
+#' @return A proxy object of class "g6_proxy" that can be used with g6 proxy methods
+#'   such as `g6_add_nodes()`, `g6_remove_nodes()`, etc.
+#'
+#' @details
+#' This function must be called from within a Shiny server function. The returned
+#' proxy object contains a reference to the session and the ID of the graph to be
+#' modified.
+#'
+#' @export
+g6_proxy <- function(id, session = shiny::getDefaultReactiveDomain()) {
+  if (is.null(session)) {
+    stop(
+      "g6_proxy must be called from the server function of a Shiny app"
+    )
+  }
+
+  structure(
+    list(id = id, session = session),
+    class = "g6_proxy"
+  )
+}
+
+#' Remove nodes from a g6 graph via proxy
+#'
+#' This function removes one or more nodes from an existing g6 graph instance
+#' using a proxy object. This allows updating the graph without completely
+#' re-rendering it. When a node is removed, its connected edges are also removed.
+#'
+#' @param graph A g6_proxy object created with \code{\link{g6_proxy}}.
+#' @param ids Character vector or list containing the IDs of the nodes to be removed.
+#'   If a single ID is provided, it will be converted to a list internally.
+#'
+#' @return The g6_proxy object (invisibly), allowing for method chaining.
+#'
+#' @details
+#' This function can only be used with a g6_proxy object within a Shiny application.
+#' It will not work with regular g6 objects outside of Shiny.
+#'
+#' Under the hood, this function uses the G6 removeNode method, which
+#' removes the specified node and all its related edges from the graph.
+#' See \url{https://g6.antv.antgroup.com/en/api/data#graphremovenodedata} for more details.
+#'
+#' @seealso \code{\link{g6_proxy}}
+#' @export
+g6_remove_nodes <- function(graph, ids) {
+  if (!any(class(graph) %in% "g6_proxy")) {
+    stop(
+      "Can't use g6_remove_nodes with g6 object. Only within shiny & using g6_proxy"
+    )
+  }
+
+  if (!is.null(ids)) {
+    if (length(ids) == 1) {
+      ids <- list(ids)
+    }
+  }
+
+  graph$session$sendCustomMessage(sprintf("%s_g6-remove-nodes", graph$id), ids)
+  graph
+}

inst/demo/app.R

@@ -73,12 +73,31 @@ combos <- list(
 )
 
 ui <- page_fluid(
-  g6Output("graph")
+  g6Output("graph"),
+  actionButton("remove", "Remove nodes")
 )
 
 server <- function(input, output, session) {
   output$graph <- renderG6({
-    g6(nodes, edges, combos, options = list(theme = "dark"))
+    g6(
+      nodes,
+      edges,
+      combos,
+      options = list(theme = "dark"),
+      behaviors = g6_behaviors(
+        zoom_canvas(),
+        drag_element(),
+        click_select(multiple = TRUE),
+        brush_select(immediately = TRUE)
+      ),
+      plugins = g6_plugins(
+        minimap()
+      )
+    )
+  })
+  observeEvent(input$remove, {
+    g6_proxy("graph") |>
+      g6_remove_nodes("node1")
   })
 
   observe({

inst/htmlwidgets/g6.js

@@ -44,6 +44,14 @@ HTMLWidgets.widget({
             // Modify node state
             Shiny.setInputValue(el.id + '-selected_edge', edgeData);
           })
+          Shiny.addCustomMessageHandler(el.id + '_g6-remove-nodes', (m) => {
+            try {
+              graph.removeNodeData(m);
+              graph.draw();
+            } catch (error) {
+              Shiny.notifications.show({ html: error, type: 'error' })
+            }
+          })
         }
 
         graph.render();