requestUpdate: Request Panel updates

In csoneson/iSEE: Interactive SummarizedExperiment Explorer

Request Panel updates

Description

Request a re-rendering of the Panel output via reactive variables.

Usage

.requestUpdate(panel_name, rObjects)

.requestCleanUpdate(panel_name, pObjects, rObjects)

.requestActiveSelectionUpdate(
  panel_name,
  session,
  pObjects,
  rObjects,
  update_output = TRUE
)

Arguments

panel_name	String containing the panel name.
rObjects	A reactive list of values generated in the iSEE app.
pObjects	An environment containing global parameters generated in the iSEE app.
session	The Shiny session object from the server function.
update_output	A logical scalar indicating whether to call .requestUpdate as well.

Details

.requestUpdate should be used in various observers to request a re-rendering of the panel, usually in response to user-driven parameter changes in .createObservers.

.requestCleanUpdate is used for changes to protected parameters that invalidate existing multiple selections, e.g., if the coordinates change in a DotPlot, existing brushes and lassos are usually not applicable.

.requestActiveSelectionUpdate should be used in the observer expression that implements the panel's multiple selection mechanism.

Value

.requestUpdate will modify rObjects to request a re-rendering of the specified panel.

.requestCleanUpdate will also remove all active/saved selections in the chosen panel.

.requestActiveSelectionUpdate will modify rObjects to indicate that the active multiple selection for panel_name has changed. If update_output=TRUE, it will also request a re-rendering of the panel.

All functions will invisibly return NULL.

Author(s)

Aaron Lun

See Also

.createProtectedParameterObservers, for examples where the update-requesting functions are used.

csoneson/iSEE documentation built on May 5, 2024, 12:41 p.m.