WorkflowBuilderActions
WorkflowBuilderActions =
object
Imperative action surface for a custom layout that omits
<WorkflowBuilder.TopBar />. Mirrors every command the built-in app bar
exposes (save, modal openers, read-only and theme toggles) and adds
programmatic layout-direction control, which the bar itself does not offer.
Stable across renders while the active integration and the mounted React Flow instance are stable (layout actions close over the fit-view callback, which is keyed on that instance).
Properties
Section titled “Properties”openExport
Section titled “openExport”openExport: () =>
void
Open the export-diagram modal.
Returns
Section titled “Returns”void
openImport
Section titled “openImport”openImport: () =>
void
Open the import-diagram modal.
Returns
Section titled “Returns”void
openSettings
Section titled “openSettings”openSettings: () =>
void
Open the built-in workflow settings modal.
Returns
Section titled “Returns”void
save: () =>
Promise<DidSaveStatus>
Persist the current diagram through the active integration strategy.
Returns
Section titled “Returns”Promise<DidSaveStatus>
setLayoutDirection
Section titled “setLayoutDirection”setLayoutDirection: (
direction) =>void
Set the diagram layout direction ('RIGHT' ↔ 'DOWN'). Idempotent:
setting the same direction twice is a no-op. Position reflow is only
offered on toggleLayoutDirection, where it is unambiguous.
Parameters
Section titled “Parameters”direction
Section titled “direction”Returns
Section titled “Returns”void
setReadOnly
Section titled “setReadOnly”setReadOnly: (
value) =>void
Set read-only mode explicitly.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
setTheme
Section titled “setTheme”setTheme: (
theme) =>void
Set the editor theme explicitly.
Parameters
Section titled “Parameters”Theme
Returns
Section titled “Returns”void
toggleDarkMode
Section titled “toggleDarkMode”toggleDarkMode: () =>
void
Flip the editor theme between 'light' and 'dark'.
Returns
Section titled “Returns”void
toggleLayoutDirection
Section titled “toggleLayoutDirection”toggleLayoutDirection: (
options?) =>void
Flip the diagram layout direction. Pass options.flipPositions to also
reflow node coordinates and/or options.fitView to re-fit the view
afterwards.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”void
toggleReadOnly
Section titled “toggleReadOnly”toggleReadOnly: () =>
void
Flip read-only mode.
Returns
Section titled “Returns”void