createMultiSelectionEffectObserver: Create an observer for multiple selection effect
In iSEE: Interactive SummarizedExperiment Explorer

Description Usage Arguments Details Value Author(s) See Also

Create an observer to trigger rerendering upon changes to the (typically visual) effect for multiple selections.

.createMultiSelectionEffectObserver(
  plot_name,
  by_field,
  type_field,
  saved_field,
  input,
  session,
  pObjects,
  rObjects
)

`plot_name`	String containing the encoded name of the current panel.
`by_field`	String with the name of the slot containing the name of the transmitting panel.
`type_field`	String with the name of the slot containing the type of selection to receive (i.e., `"Saved"`, `"Active"` or `"Union"`).
`saved_field`	String with the name of the slot containing the saved history of selections.
`input`	The Shiny input object from the server function.
`session`	The Shiny session object from the server function.
`pObjects`	An environment containing global parameters generated in the `iSEE` app.
`rObjects`	A reactive list of values generated in the `iSEE` app.

The selection effect is expected to be stored in the SelectionEffect slot of the current panel. Changes to the specified effect will trigger rerendering of the current panel if there was a multiple selection transmitted from an upstream panel. If the specified effect changes to or from “Restrict”, all children of the current panel will also be rerendered.

This function is typically called within a .createObservers method It is exported for use in subclasses as the selection effect is not a property of the Panel class (given that not all panels are visual) and thus needs to be called separately for each subclass rather than in the parent's method.

An observer for the input corresponding to "SelectEffect" is created in the current Shiny session. A NULL is invisibly returned.

Aaron Lun

.createObservers, where this function is usually called - see, for example, the methods for ColumnDotPlot, RowDotPlot and ComplexHeatmapPlot.

iSEE documentation built on Feb. 3, 2021, 2:01 a.m.