turn off on panel

R/FilteredData.R

@@ -519,6 +519,7 @@ FilteredData <- R6::R6Class( # nolint
         )
       }
       logger::log_trace("FilteredData$set_filter_state initialized, dataname: { paste(names(state), collapse = ' ') }")
+
       invisible(NULL)
     },
 
@@ -529,6 +530,8 @@ FilteredData <- R6::R6Class( # nolint
     #'
     #' @return `NULL`
     remove_filter_state = function(state) {
+      checkmate::assert_subset(names(state), self$datanames())
+
       logger::log_trace("FilteredData$remove_filter_state called, dataname: { paste(names(state), collapse = ' ') }")
 
       for (dataname in names(state)) {
@@ -537,6 +540,7 @@ FilteredData <- R6::R6Class( # nolint
       }
 
       logger::log_trace("FilteredData$remove_filter_state done, dataname: { paste(names(state), collapse = ' ') }")
+
       invisible(NULL)
     },
 
@@ -586,6 +590,33 @@ FilteredData <- R6::R6Class( # nolint
     restore_state_from_bookmark = function(state, check_data_hash = TRUE) {
       stop("Pure virtual method")
     },
+    #' @description disable the filter panel
+    filter_panel_disable = function() {
+      private$filter_turn <- FALSE
+      shinyjs::disable("filter_add_vars")
+      shinyjs::disable("filter_active_vars")
+      private$cached_states <- self$get_filter_state()
+      self$remove_all_filter_states()
+      invisible(NULL)
+    },
+    #' @description enable the filter panel
+    filter_panel_enable = function() {
+      private$filter_turn <- TRUE
+      shinyjs::enable("filter_add_vars")
+      shinyjs::enable("filter_active_vars")
+      if (length(private$cached_states) && (length(self$get_filter_state()) == 0)) {
+        self$set_filter_state(private$cached_states)
+      }
+      invisible(NULL)
+    },
+    #' @description get the state of filter panel, if it is activated
+    get_filter_turn = function() {
+      private$filter_turn
+    },
+    #' @description get the id of the filter panel ui
+    get_filter_panel_ui_id = function() {
+      private$filter_panel_ui_id
+    },
 
     # shiny modules -----
 
@@ -602,6 +633,22 @@ FilteredData <- R6::R6Class( # nolint
       div(
         id = ns(NULL), # used for hiding / showing
         include_css_files(pattern = "filter-panel"),
+        div(
+          id = ns("switch-button"),
+          class = "flex justify-content-right",
+          div(
+            title = "Active Filtering",
+            shinyWidgets::prettySwitch(
+              ns("filter_turn_onoff"),
+              label = "",
+              status = "success",
+              fill = TRUE,
+              value = TRUE,
+              inline = FALSE,
+              width = 30
+            )
+          )
+        ),
         div(
           id = ns("filters_overview"), # not used, can be used to customize CSS behavior
           class = "well",
@@ -772,6 +819,20 @@ FilteredData <- R6::R6Class( # nolint
             }
           )
 
+          private$filter_panel_ui_id <- session$ns(NULL)
+          observeEvent(
+            eventExpr = input[["filter_turn_onoff"]],
+            handlerExpr = {
+              if (isTRUE(input[["filter_turn_onoff"]])) {
+                self$filter_panel_enable()
+                logger::log_trace("Enable the Filtered Panel with the filter_panel_enable method")
+              } else {
+                self$filter_panel_disable()
+                logger::log_trace("Disable the Filtered Panel with the filter_panel_enable method")
+              }
+            }, ignoreNULL = TRUE
+          )
+
           observeEvent(
             eventExpr = active_datanames(),
             handlerExpr = {
@@ -904,6 +965,12 @@ FilteredData <- R6::R6Class( # nolint
     # private attributes ----
     filtered_datasets = list(),
 
+    # turn on / off filter panel
+    filter_turn = TRUE,
+
+    # filter panel ui id
+    filter_panel_ui_id = character(0),
+
     # whether the datasets had a reproducibility check
     .check = FALSE,
 
@@ -915,6 +982,7 @@ FilteredData <- R6::R6Class( # nolint
 
     # reactive i.e. filtered data
     reactive_data = list(),
+    cached_states = NULL,
 
     # we implement these functions as checks rather than returning logicals so they can
     # give informative error messages immediately

R/filter_panel_api.R

@@ -62,7 +62,11 @@ FilterPanelAPI <- R6::R6Class( # nolint
     #'
     #' @return `NULL`
     set_filter_state = function(filter) {
-      private$filtered_data$set_filter_state(filter)
+      if (private$filtered_data$get_filter_turn()) {
+        private$filtered_data$set_filter_state(filter)
+      } else {
+        warning("Filter Panel is turn off so the action can not be applied with api.")
+      }
       invisible(NULL)
     },
 
@@ -73,7 +77,11 @@ FilterPanelAPI <- R6::R6Class( # nolint
     #'
     #' @return `NULL`
     remove_filter_state = function(filter) {
-      private$filtered_data$remove_filter_state(filter)
+      if (private$filtered_data$get_filter_turn()) {
+        private$filtered_data$remove_filter_state(filter)
+      } else {
+        warning("Filter Panel is turn off so the action can not be applied with api.")
+      }
       invisible(NULL)
     },
 
@@ -83,8 +91,26 @@ FilterPanelAPI <- R6::R6Class( # nolint
     #'
     #' @return `NULL`
     remove_all_filter_states = function(datanames) {
-      datanames_to_remove <- if (missing(datanames)) private$filtered_data$datanames() else datanames
-      private$filtered_data$remove_all_filter_states(datanames = datanames_to_remove)
+      if (private$filtered_data$get_filter_turn()) {
+        datanames_to_remove <- if (missing(datanames)) private$filtered_data$datanames() else datanames
+        private$filtered_data$remove_all_filter_states(datanames = datanames_to_remove)
+      } else {
+        warning("Filter Panel is turn off so the action can not be applied with api.")
+      }
+      invisible(NULL)
+    },
+    #' @description Toggle the state of the Filter Panel turn on/off button.
+    #' @param id (`character(1)`)\cr
+    #'  `id` to the toggle button.
+    #'
+    #' @return `NULL`
+    filter_panel_toggle = function() {
+      shinyjs::runjs(
+        sprintf(
+          '$("#%s-filter_turn_onoff").click();',
+          private$filtered_data$get_filter_panel_ui_id()
+        )
+      )
       invisible(NULL)
     }
   ),

inst/css/filter-panel.css

@@ -4,6 +4,10 @@
   position: relative;
 }
 
+.inline-block {
+  position: inline-block;
+}
+
 .flex {
   display: flex;
 }
@@ -40,10 +44,18 @@
   margin-bottom: 1rem;
 }
 
+.mr-4 {
+  margin-right: 1rem;
+}
+
 .justify-content-center {
   justify-content: center;
 }
 
+.justify-content-right {
+  justify-content: right;
+}
+
 .date_reset_button {
   padding: 0;
   padding-top: 4px;

tests/testthat/test-FilteredData.R

@@ -576,3 +576,67 @@ testthat::test_that("get_data assert the `filtered` argument is logical(1)", {
     regexp = "Assertion on 'filtered' failed: Must be of type 'logical flag', not 'character'"
   )
 })
+
+testthat::test_that("filter_panel_disable", {
+  filtered_data <- FilteredData$new(data_objects = list("iris" = list(dataset = iris)), join_keys = NULL)
+  filtered_data$set_filter_state(list(iris = list(Sepal.Width = c(3, 4))))
+  shiny::testServer(
+    filtered_data$srv_filter_panel,
+    expr = {
+      filtered_data$filter_panel_disable()
+      testthat::expect_length(filtered_data$get_filter_state(), 0)
+    }
+  )
+})
+
+testthat::test_that("filter_panel_enable", {
+  filtered_data <- FilteredData$new(data_objects = list("iris" = list(dataset = iris)), join_keys = NULL)
+  filtered_data$set_filter_state(list(iris = list(Sepal.Width = c(3, 4))))
+  shiny::testServer(
+    filtered_data$srv_filter_panel,
+    expr = {
+      filtered_data$filter_panel_enable()
+      testthat::expect_length(filtered_data$get_filter_state(), 1)
+      testthat::expect_equal(filtered_data$get_filter_state()$iris$Sepal.Width$selected, c(3, 4))
+    }
+  )
+})
+
+testthat::test_that("filter_panel_disable and filter_panel_enable", {
+  filtered_data <- FilteredData$new(data_objects = list("iris" = list(dataset = iris)), join_keys = NULL)
+  filtered_data$set_filter_state(list(iris = list(Sepal.Width = c(3, 4))))
+  shiny::testServer(
+    filtered_data$srv_filter_panel,
+    expr = {
+      testthat::expect_length(filtered_data$get_filter_state(), 1)
+      testthat::expect_true(filtered_data$get_filter_turn())
+      filtered_data$filter_panel_disable()
+      testthat::expect_length(filtered_data$get_filter_state(), 0)
+      testthat::expect_false(filtered_data$get_filter_turn())
+      filtered_data$filter_panel_enable()
+      testthat::expect_length(filtered_data$get_filter_state(), 1)
+      testthat::expect_true(filtered_data$get_filter_turn())
+    }
+  )
+})
+
+testthat::test_that("turn filed by default equal to TRUE", {
+  filtered_data <- FilteredData$new(data_objects = list("iris" = list(dataset = iris)), join_keys = NULL)
+  testthat::expect_true(filtered_data$get_filter_turn())
+})
+
+testthat::test_that("get_filter_panel_ui_id - empty when no shiny session", {
+  filtered_data <- FilteredData$new(data_objects = list("iris" = list(dataset = iris)), join_keys = NULL)
+  testthat::expect_length(filtered_data$get_filter_panel_ui_id(), 0)
+})
+
+testthat::test_that("get_filter_panel_ui_id - non-empty when in shiny session", {
+  filtered_data <- FilteredData$new(data_objects = list("iris" = list(dataset = iris)), join_keys = NULL)
+  shiny::testServer(
+    filtered_data$srv_filter_panel,
+    expr = {
+      testthat::expect_length(filtered_data$get_filter_panel_ui_id(), 1)
+    }
+  )
+})
+