Skip to contents

Change a setting

cellucid_setting_set.Rd

Set one render, navigation, overlay or tool setting of the sidebar; settings.list names each, with its kind, range and choices.

Usage

cellucid_setting_set(viewer, setting, value)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

setting

The setting's id, as settings.list gives it. Text (at least 1 character). Required.

value

A number for a slider, true or false for a switch, an option value for a choice, #rrggbb for a colour. Text or a number or 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 setting.set (Settings). 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: settings, 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_setting_set(viewer, setting = "point-size",
      value = 20)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}