Skip to contents

Work with all of a figure's layout scene objects (scene, scene2, scene3, ...). select_scenes() returns them as a named list, update_scenes() updates their properties like update_layout() does, and for_each_scene() replaces each one with the result of fn. The base object (e.g. scene) is always included, even if it has not been set yet.

Usage

select_scenes(fig, selector = NULL, row = NULL, col = NULL)

update_scenes(
  fig,
  patch = NULL,
  ...,
  selector = NULL,
  row = NULL,
  col = NULL,
  overwrite = FALSE
)

for_each_scene(fig, fn, selector = NULL, row = NULL, col = NULL)

Arguments

fig

A go_figure object.

selector

Which objects to use: NULL (all), indices into the matching objects, a named list of property values that must all match, or a function that takes an object and returns TRUE or FALSE.

row, col

Only objects in this subplot grid row and/or column (figures created with make_subplots() only).

patch

A named list or go_layout_scene() object of property updates.

...

Further named updates (names may use magic underscores).

overwrite

If TRUE, replace nested objects instead of merging.

fn

A function that takes an object and returns the modified object. If it returns anything other than a list, the object is left unchanged.

Value

select_scenes() returns a named list of go_layout_scene() objects; the others return the modified figure.