@interopio/desktop API Reference

Options for saving a Layout.

Properties (10)

Property Type Default Required Description
accessInfo⚓︎ SaveLayoutAccessInfo x x

Access information for the Layout. Available only when Layout sharing is enabled.
context⚓︎ unknown x x

Context to be saved with the Layout.
id⚓︎ string x x

ID of an existing Layout to overwrite. If not specified and Layout sharing is disabled, a Layout with the same name and type will be overwritten if it exists, or a new Layout will be created. If not specified and Layout sharing is enabled, a new Layout will be created (unless you already have a private Layout with the same name and type, in which case the operation will fail), so you must specify the ID to overwrite an existing 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.
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⚓︎ object 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. The supported types for this operation are "Global" and "Workspace".