Skip to main content

Layouts

⚠️ Note that this Layouts API accessible via the io.layouts.v2 object is designed to replace the legacy Layouts API accessible via the io.layouts object. The legacy Layouts API is still supported, but will be entirely removed in a future release. It's highly recommended to migrate to the new Layouts API. When Layout sharing is enabled, the legacy Layouts API is unreliable and you must use the new Layouts API instead.

The Layouts API allows you to save the arrangement and context of any set of apps running in io.Connect Desktop as a named Layout and later restore it. You can also choose a default Global Layout which io.Connect Desktop will load upon startup.

The Layouts API supports different types of Layouts - Global, App Default, Workspace. All its methods are asynchronous and Layouts are identified by their IDs. When Layout sharing is enabled, users can share Layouts with other users and groups via io.Manager.

The Layouts API is accessible via the io.layouts.v2 object.

Available since io.Connect Desktop 10.5 &@interopio/desktop 6.23.0.