# SaveLayoutOptions

**Kind**: interface | **Module**: [Layouts](https://docs.interop.io/desktop/reference/javascript/layouts/index.md)

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

Options for saving a Layout.

## Properties

- **`accessInfo`** (`LayoutsV2.SaveLayoutAccessInfo`, optional)
  Access information for the Layout. Available only when Layout sharing is enabled.
- **`context`** (`unknown`, optional)
  Context to be saved with the Layout.
- **`id`** (`string`, optional)
  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`, optional)
  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[]`, optional)
  Only if the Layout type is `"Global"`. The instances with the provided IDs will be ignored.
- **`instances`** (`string[]`, optional)
  Only if the Layout type is `"Global"`. The instances with the provided IDs will be saved.
- **`metadata`** (`object`, optional)
  Metadata to be saved with the Layout.
- **`name`** (`string`, required)
  Name for the Layout.
- **`setAsCurrent`** (`boolean`, optional)
  If `true`, will set the saved Layout as the current Global Layout.
- **`type`** (`LayoutType`, optional) default: `"Global"`
  Type of the Layout. The supported types for this operation are `"Global"` and `"Workspace"`.

## Related types

- [LayoutType](https://docs.interop.io/desktop/reference/javascript/layouts/layouttype/index.md)
- [SaveLayoutAccessInfo](https://docs.interop.io/desktop/reference/javascript/layouts/savelayoutaccessinfo/index.md)