Merge pull request #2127 from rstudio/feat-rows-hide

feat: add the `rows_hide()` and `rows_unhide()` functions

Author: rich-iannone

NAMESPACE

@@ -206,6 +206,8 @@ export(row_group)
 export(row_group_order)
 export(row_order)
 export(rows_add)
+export(rows_hide)
+export(rows_unhide)
 export(starts_with)
 export(stub)
 export(sub_large_vals)

R/dt_groups_rows.R

@@ -56,7 +56,8 @@ dt_groups_rows_build <- function(data, context) {
     table_body <- dt_data_get(data = data)
     # For multiple stub columns, use the rightmost (primary) column for rowname
     primary_stub_var <- stub_var[length(stub_var)]
-    stub_df[["rowname"]] <- as.character(table_body[[primary_stub_var]])
+    # Use rownum_i to get the correct row values (handles hidden rows)
+    stub_df[["rowname"]] <- as.character(table_body[[primary_stub_var]][stub_df$rownum_i])
   }
   # what happens if dt_stub_df doesn't exist?
 
@@ -87,6 +88,10 @@ dt_groups_rows_build <- function(data, context) {
     groups_rows[i, "row_end"] <- max(rows_matched)
   }
 
+  # Remove groups that have no visible rows (row_start/row_end are NA)
+  # This can happen when all rows in a group are hidden via rows_hide()
+  groups_rows <- groups_rows[!is.na(groups_rows$row_start), ]
+
   # Join `built_group_label` values to the `groups_rows` table
   if (nrow(groups_rows) > 0) {
 

R/dt_rows_hidden.R

@@ -0,0 +1,79 @@
+#------------------------------------------------------------------------------#
+#
+#                /$$
+#               | $$
+#     /$$$$$$  /$$$$$$
+#    /$$__  $$|_  $$_/
+#   | $$  \ $$  | $$
+#   | $$  | $$  | $$ /$$
+#   |  $$$$$$$  |  $$$$/
+#    \____  $$   \___/
+#    /$$  \ $$
+#   |  $$$$$$/
+#    \______/
+#
+#  This file is part of the 'rstudio/gt' project.
+#
+#  Copyright (c) 2018-2026 gt authors
+#
+#  For full copyright and license information, please look at
+#  https://gt.rstudio.com/LICENSE.html
+#
+#------------------------------------------------------------------------------#
+
+
+.dt_rows_hidden_key <- "_rows_hidden"
+
+dt_rows_hidden_get <- function(data) {
+  dt__get(data, .dt_rows_hidden_key)
+}
+
+dt_rows_hidden_set <- function(data, rows_hidden) {
+  dt__set(data, .dt_rows_hidden_key, rows_hidden)
+}
+
+dt_rows_hidden_init <- function(data) {
+  dt_rows_hidden_set(data = data, rows_hidden = integer(0L))
+}
+
+#' Add rows to the hidden rows list
+#'
+#' @param data The gt table data object.
+#' @param rows Integer vector of row indices to hide.
+#'
+#' @noRd
+dt_rows_hidden_add <- function(data, rows) {
+
+  existing_hidden <- dt_rows_hidden_get(data = data)
+
+  # Combine and keep unique values
+
+  rows_hidden <- sort(unique(c(existing_hidden, rows)))
+
+  dt_rows_hidden_set(data = data, rows_hidden = rows_hidden)
+}
+
+#' Remove rows from the hidden rows list (unhide them)
+#'
+#' @param data The gt table data object.
+#' @param rows Integer vector of row indices to unhide.
+#'
+#' @noRd
+dt_rows_hidden_remove <- function(data, rows) {
+
+  existing_hidden <- dt_rows_hidden_get(data = data)
+
+  # Remove specified rows from hidden list
+  rows_hidden <- setdiff(existing_hidden, rows)
+
+  dt_rows_hidden_set(data = data, rows_hidden = rows_hidden)
+}
+
+#' Check if any rows are hidden
+#'
+#' @param data The gt table data object.
+#'
+#' @noRd
+dt_rows_hidden_exist <- function(data) {
+  length(dt_rows_hidden_get(data = data)) > 0
+}

R/dt_stub_df.R

@@ -246,9 +246,33 @@ reorder_stub_df <- function(data) {
   # Then, apply any row ordering directives
   stub_df <- apply_row_order_directives(data = data, stub_df = stub_df)
 
+  # Finally, filter out any hidden rows
+  stub_df <- filter_hidden_rows(data = data, stub_df = stub_df)
+
   dt_stub_df_set(data = data, stub_df = stub_df)
 }
 
+# Function to filter out hidden rows from stub_df
+filter_hidden_rows <- function(data, stub_df) {
+
+  # Get the hidden rows
+
+  hidden_rows <- dt_rows_hidden_get(data = data)
+
+  # If there are no hidden rows, return stub_df unchanged
+  if (length(hidden_rows) == 0) {
+    return(stub_df)
+  }
+
+  # Filter out rows where rownum_i is in the hidden list
+  stub_df <- stub_df[!stub_df$rownum_i %in% hidden_rows, ]
+
+  # Reset row names
+  rownames(stub_df) <- NULL
+
+  stub_df
+}
+
 # Function to apply the lazy row ordering directives captured by `row_order()`
 apply_row_order_directives <- function(data, stub_df) {
 

R/gt.R

@@ -389,6 +389,7 @@ gt <- function(
     )
   data <- dt_row_groups_init(data = data)
   data <- dt_row_order_init(data = data)
+  data <- dt_rows_hidden_init(data = data)
   data <- dt_heading_init(data = data)
   data <- dt_spanners_init(data = data)
   data <- dt_stubhead_init(data = data)