Skip to contents

Open or close a section

cellucid_layout_section_open.Rd

Open or close a section of the sidebar (docked or floating).

Usage

cellucid_layout_section_open(viewer, section, open)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

section

A sidebar section by its title (Visualization, Navigation, ...) or its id. Text (at least 1 character). Required.

open

True opens it, false closes it. TRUE or FALSE. Required.

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 layout.section.open (Layout). It changes the viewer's layout: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: layout.

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_layout_section_open(viewer, open = FALSE,
      section = "Visualization")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}