Skip to contents

Set the view layout

cellucid_view_layout_set.Rd

Show every view side by side (grid) or the selected view alone (single).

Usage

cellucid_view_layout_set(viewer, layout)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

layout

"grid" or "single". One of "grid", "single". 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 view.layout.set (Views). It changes what the viewer shows: one step of the viewer's history, labelled as R's, undone like any other. The state it can change: views.

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_view_layout_set(viewer, layout = "grid")
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}