BoxBuilderinterface
An object describing a builder used to create workspace boxes
5 Methods
addColumn()⚓︎
(definition?: BoxDefinition) => BoxBuilder
Adds a new column to the calling box. Returns the new column.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | x | x |
addGroup()⚓︎
(definition?: BoxDefinition) => BoxBuilder
Adds a new group to the calling box. Returns the new group.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | x | x |
addRow()⚓︎
(definition?: BoxDefinition) => BoxBuilder
Adds a new row to the calling box. Returns the new row.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | BoxDefinition | x | x |
addWindow()⚓︎
(definition: WorkspaceWindowDefinition) => BoxBuilder
Adds a new window to the calling box. Returns the immediate parent box of the window.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| definition⚓︎ | WorkspaceWindowDefinition | x |
serialize()⚓︎
() => BoxDefinition
Returns the JSON object which describes the full structure of the box.