Show a step

Show the state after any step of the tracker in use, on any branch, as clicking it in the timeline does; nothing is undone or lost. Name exactly one of step, bookmark or at.

Usage

cellucid_history_jump(viewer, at, bookmark, step)

Arguments

viewer

A viewer cellucid_view() or cellucid_serve() returned.

at

A time (milliseconds since 1970): show the last step at or before it on the branch shown. A number. Left out unless given (the viewer then chooses as its own control does).

bookmark

A bookmark's name (any case): show the step it marks. Text (at least 1 character). Left out unless given (the viewer then chooses as its own control does).

step

A step of the tracker in use, by its id (history_get lists the steps). Text. 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: a list of head (The step shown now).

Details

The viewer's action history.jump (History). It moves the viewer's history, as the person's Undo, Redo or a click on a step does: it makes no step of the history.

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_history_jump(viewer)
  print(request)
  # cellucid_action_result(request) waits for its outcome.
  cellucid_stop(viewer)
}