@interopio/desktop API Reference

Options for saving a new Layout.

Properties (8)

Property Type Default Required Description
context⚓︎ any x x

Context to be saved with the Layout.
ignoreContexts⚓︎ boolean x x

If true, the context objects of individual io.Connect Windows and Workspaces participating in the Global Layout won't be saved when the Layout is saved. You can still use the context property to provide context data to be saved for the Global Layout itself. Valid only for Global Layouts. Available since io.Connect Desktop 9.9.
ignoreInstances⚓︎ string[] x x

Only if the Layout type is "Global". The instances with the provided IDs will be ignored.
instances⚓︎ string[] x x

Only if the Layout type is "Global". The instances with the provided IDs will be saved.
metadata⚓︎ any x x

Metadata to be saved with the Layout.
name⚓︎ string x

Name for the Layout.
setAsCurrent⚓︎ boolean x x

If true, will set the saved Layout as the current Global Layout.
type⚓︎ LayoutType "Global" x

Type of the Layout.