Skip to contents

Give a floating sidebar section a place and size; it is kept inside the window.

Usage

cellucid_layout_panel_place(viewer, panel, left, top, width, height)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

panel

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

left

Distance of its left edge from the left of the window, in CSS pixels. A number. Required.

top

Distance of its top edge from the top of the window, in CSS pixels. A number. Required.

width

Width in CSS pixels (kept at least its smallest working width). A number (more than 0). Required.

height

Height in CSS pixels (kept at least its header and first row). A number (more than 0). 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.panel.place (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_panel_place(viewer, height = 1,
      left = 0, panel = "Visualization", top = 0, width = 1)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}