BoxSummaryinterface
An object containing the summary of a workspace box
Properties (12)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowDrop⚓︎ | boolean | x | x | Indicates if dropping windows inside this box is allowed |
| frameId⚓︎ | string | x | The unique string identifier of the frame containing this box |
|
| height⚓︎ | number | x | x | Returns the current height of the box, can be undefined if the API is used with old versions of Enterprise or Core |
| id⚓︎ | string | x | An unique string identifier of this box |
|
| isMaximized⚓︎ | boolean | x | x | Returns whether or not the box is maximized |
| maxHeight⚓︎ | number | x | x | Returns the maximum height of the box, calculated by the size constraints of the elements inside it |
| maxWidth⚓︎ | number | x | x | Returns the maximum width of the box, calculated by the size constraints of the elements inside it |
| minHeight⚓︎ | number | x | x | Returns the minimum height of the box, calculated by the size constraints of the elements inside it |
| minWidth⚓︎ | number | x | x | Returns the minimum width of the box, calculated by the size constraints of the elements inside it |
| positionIndex⚓︎ | number | x | An number representing the positing of this box relative to it's siblings |
|
| width⚓︎ | number | x | x | Returns the current width of the box, can be undefined if the API is used with old versions of Enterprise or Core |
| workspaceId⚓︎ | string | x | The unique string identifier of the workspace containing this box |