Render persistent manual plot layout edits across re-renders

Render-step companion to setup_manual_edits(). Call this inside your module's plotly::renderPlotly() on the freshly rebuilt figure, immediately before returning it.

Usage

finalize_manual_edits(
  fig,
  plot_source,
  store,
  session,
  regen_keys = character(0)
)

fig: A plotly figure object, typically the result of your plotting pipeline. If NULL, it is returned unchanged.
plot_source: Character scalar. The same plotly event source id passed to setup_manual_edits(); assigned to fig$x$source.
store: The list returned by setup_manual_edits().
session: The module's session object, used to namespace the colorbar drag input.
regen_keys: Character vector of annotation keys (e.g. "axis:y") whose text is regenerated on every rebuild and must not be overwritten by a captured edit. Pass the axis side(s) carrying an active data adjustment so the freshly built label (e.g. "log2(units)") always wins, while the captured position still persists. Defaults to none (all captured props are restored, the pre-existing behaviour).

The finalized plotly figure, ready to be returned from plotly::renderPlotly().

It performs four jobs:

tags the figure with the module's plotly event source so its plotly_relayout events are captured by setup_manual_edits();
restores any manually repositioned legend, annotations, axis titles, and colorbar captured so far;
records the figure so future relayout events can be matched to stable annotation keys (surviving re-ordering on rebuild); and
attaches the JavaScript listener that forwards colorbar drags.

Restored edits are applied under shiny::isolate() so re-applying them never triggers an additional re-render.

Jared Andrews

if (FALSE) { # \dontrun{
# Inside renderPlotly(), after building `fig`:
fig <- finalize_manual_edits(fig, plot_source, edit_store, session)
fig
} # }