Skip to contents

Show or hide a highlight group

cellucid_highlight_group_toggle.Rd

Turn one group of a page on or off; a group that is off highlights nothing.

Usage

cellucid_highlight_group_toggle(viewer, group, enabled, page)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

group

A highlight group, by its label as the group list shows it (without the cell count). Text (at least 1 character). Required.

enabled

true to show the group, false to hide it. TRUE or FALSE. Required.

page

The group's page, by name; omitted, the page shown. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

Value

A cellucid_action_request, at once and invisibly: the action is sent now, or when the viewer's channel opens. cellucid_action_result(request) returns its outcome (what it did, as names, counts and ids), or NULL when it had nothing to report; request$step is the history step it made.

Details

The viewer's action highlight.group.toggle (Highlights). It changes the viewer's state: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: highlights.

See also

cellucid_act() sends any action by its type, and cellucid_action_result() collects its answer.

Examples

if (interactive() && requireNamespace("SeuratObject", quietly = TRUE)) {
  data("pbmc_small", package = "SeuratObject")
  viewer <- cellucid_view(SeuratObject::UpdateSeuratObject(pbmc_small))
  request <- cellucid_highlight_group_toggle(viewer,
      enabled = FALSE, group = "x")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}