Skip to contents

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

Usage

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

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

for_each_ternary(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_ternary() 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_ternaries() returns a named list of go_layout_ternary() objects; the others return the modified figure.