# WorkspaceBuilder

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

**Source**: https://docs.interop.io/desktop/reference/javascript/workspaces/workspacebuilder/index.html

An object describing a builder user to create workspaces

## Methods

### addColumn

Adds a new column to the calling workspace. Returns the new column.

```ts
(definition?: BoxDefinition) => BoxBuilder
```

**Parameters**

- **`definition`** (`BoxDefinition`, optional)

**Returns**: `BoxBuilder`

### addGroup

Adds a new group to the calling workspace. Returns the new group.

```ts
(definition?: BoxDefinition) => BoxBuilder
```

**Parameters**

- **`definition`** (`BoxDefinition`, optional)

**Returns**: `BoxBuilder`

### addRow

Adds a new row to the calling workspace. Returns the new row.

```ts
(definition?: BoxDefinition) => BoxBuilder
```

**Parameters**

- **`definition`** (`BoxDefinition`, optional)

**Returns**: `BoxBuilder`

### addWindow

Adds a new window to the calling workspace. Returns the calling workspace.

```ts
(definition: WorkspaceWindowDefinition) => WorkspaceBuilder
```

**Parameters**

- **`definition`** (`WorkspaceWindowDefinition`, required)

**Returns**: `WorkspaceBuilder`

### create

Creates a new workspace using the builder as a blueprint for structure and contents.

```ts
(config?: WorkspaceCreateConfig) => Promise<Workspace>
```

**Parameters**

- **`config`** (`WorkspaceCreateConfig`, optional)
  An object containing workspace creating options.

**Returns**: `Promise<Workspace>`

## Related types

- [BoxBuilder](https://docs.interop.io/desktop/reference/javascript/workspaces/boxbuilder/index.md)
- [BoxDefinition](https://docs.interop.io/desktop/reference/javascript/workspaces/boxdefinition/index.md)
- [Workspace](https://docs.interop.io/desktop/reference/javascript/workspaces/workspace/index.md)
- [WorkspaceCreateConfig](https://docs.interop.io/desktop/reference/javascript/workspaces/workspacecreateconfig/index.md)
- [WorkspaceWindowDefinition](https://docs.interop.io/desktop/reference/javascript/workspaces/workspacewindowdefinition/index.md)