# Layouts Legacy

**Kind**: module | **Library**: @interopio/desktop | **Access**: `io.layouts`

**Source**: https://docs.interop.io/desktop/reference/javascript/layouts legacy/index.html

>  Note that the Layouts API accessible via the `io.layouts` object is now considered a legacy API. A new and fully asynchronous [Layouts API](../layouts/index.html#API) accessible via the `io.layouts.v2` object has been introduced.
> 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 library supports different types of Layouts - Global, App Default, Workspace.

The Layouts API is accessible via the [`io.layouts`](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/api/index.md) object.

## Interfaces

- [API](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/api/index.md): Legacy Layouts API.
- [Configuration](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/configuration/index.md): Configuration for the Layouts library.
- [GetContentsOptions](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/getcontentsoptions/index.md): Options for retrieving the contents of Global or Workspace Layouts via the `getLayoutContents()` method.
- [GetRestoredLayoutsInfoResult](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/getrestoredlayoutsinforesult/index.md): Describes the currently active Layout (ID, type, name and participating app instances), as well as any previously active Layouts that still have running instances of their participating apps.
- [HibernateResult](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/hibernateresult/index.md): Describes the result returned from hibernating a Layout.
- [HibernationOptions](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/hibernationoptions/index.md): Options for hibernating Layouts.
- [ImportLayoutResult](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/importlayoutresult/index.md): Describes the result returned from importing Layouts.
- [Layout](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/layout/index.md): Describes a Layout.
- [LayoutComponent](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/layoutcomponent/index.md): Describes a Layout component - an app participating in the Layout and its state.
- [LayoutContents](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/layoutcontents/index.md): Describes the contents of Global or Workspace Layouts retrieved via the `getLayoutContents()` method.
- [LayoutModifiedEvent](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/layoutmodifiedevent/index.md): Describes a modified Layout and the reason for its modification.
- [LayoutResult](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/layoutresult/index.md): Describes the base result returned by methods for
- [LayoutSummary](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/layoutsummary/index.md): Summarized description of a Layout.
- [NewLayoutOptions](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/newlayoutoptions/index.md): Options for saving a new Layout.
- [ResetLayoutOptions](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/resetlayoutoptions/index.md): Options for resetting a Layout.
- [RestoredInstance](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/restoredinstance/index.md): Describes an app instance participating in a restored or resumed Layout.
- [RestoredLayoutDetails](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/restoredlayoutdetails/index.md): Describes a currently active Layout, or a previously active Layout that may still have running instances of its participating apps.
- [RestoredLayoutInstanceInfo](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/restoredlayoutinstanceinfo/index.md): Describes an app instance participating in a Layout.
- [RestoreOptions](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/restoreoptions/index.md): Options for restoring a Layout.
- [RestoreResumeResult](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/restoreresumeresult/index.md): Describes the result returned from restoring or resuming a Layout.
- [ResumeOptions](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/resumeoptions/index.md): Options for resuming a Layout.
- [SaveRequestContext](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/saverequestcontext/index.md): Context passed as an argument to the callback for handling Layout save request events.
- [SaveRequestResponse](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/saverequestresponse/index.md): Result returned in response to a request for saving a Layout.

## Type Aliases

- [ImportMode](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/importmode/index.md): Mode for importing Layouts.
- [LayoutType](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/layouttype/index.md): The supported Layout types are `"Global"`, `"ApplicationDefault"` and `"Workspace"`.
- [Mode](https://docs.interop.io/desktop/reference/javascript/layouts%20legacy/mode/index.md): Layouts library initialization mode: