WorkspaceSummaryinterface
An object describing the basic details of a workspace
Properties (30)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowDrop⚓︎ | boolean | x | x | Indicates if dropping outsize windows to the workspace is allowed |
| allowDropBottom⚓︎ | boolean | x | x | Indicates if dropping windows in the bottom-most zone of the workspace is allowed |
| allowDropLeft⚓︎ | boolean | x | x | Indicates if dropping windows in the left-most zone of the workspace is allowed |
| allowDropRight⚓︎ | boolean | x | x | Indicates if dropping windows in the right-most zone of the workspace is allowed |
| allowDropTop⚓︎ | boolean | x | x | Indicates if dropping windows in the top-most zone of the workspace is allowed |
| allowExtract⚓︎ | boolean | x | x | Indicates if extracting windows from the workspace is allowed |
| allowSplitters⚓︎ | boolean | x | x | Indicates if dragging of splitters is allowed in the workspace |
| allowSystemHibernation⚓︎ | boolean | x | x | Indicates whether the Workspace can be hibernated via the platform configuration.
This setting doesn't apply to programmatic hibernation via the |
| allowWindowReorder⚓︎ | boolean | x | x | Indicates if reordering windows in the workspace is allowed |
| allowWorkspaceTabExtract⚓︎ | boolean | x | x | Controls whether the workspace tab can be extracted. Available only in io.Connect Desktop. |
| allowWorkspaceTabReorder⚓︎ | boolean | x | x | Controls whether the workspace tab can be reordered |
| frameId⚓︎ | string | x | The string id of the frame containing this workspace |
|
| height⚓︎ | number | x | x | Returns the current height of the workspace |
| id⚓︎ | string | x | An unique string identifier of the workspace |
|
| isHibernated⚓︎ | boolean | x | x | Indicates if the workspace is hibernated |
| isSelected⚓︎ | boolean | x | x | Indicates if the workspace is selected in its frame. Can be undefined if using with an older version of io.Connect Desktop or io.Connect Browser. |
| layoutName⚓︎ | string | undefined | x | The name of the originating layout of the current workspace if any |
|
| loadingStrategy⚓︎ | LoadingStrategy | x | x | Indicates the loading strategy for the Workspace. Available only in io.Connect Desktop. |
| maxHeight⚓︎ | number | x | x | Returns the maximum height of the workspace, calculated by the constraints of all elements inside it |
| maxWidth⚓︎ | number | x | x | Returns the maximum width of the workspace, calculated by the constraints of all elements inside it |
| minHeight⚓︎ | number | x | x | Returns the minimum height of the workspace, calculated by the constraints of all elements inside it |
| minWidth⚓︎ | number | x | x | Returns the minimum width of the workspace, calculated by the constraints of all elements inside it |
| positionIndex⚓︎ | number | x | The position of this workspace regarding it's siblings |
|
| showAddWindowButtons⚓︎ | boolean | x | x | Indicates if the window add buttons within this workspace are visible to the user |
| showCloseButton⚓︎ | boolean | x | x | Indicates if the close button for this workspace is visible to the user |
| showEjectButtons⚓︎ | boolean | x | x | Indicates if the eject buttons of the windows within this workspace are visible to the user |
| showSaveButton⚓︎ | boolean | x | x | Indicates if the save button for this workspace is visible to the user |
| showWindowCloseButtons⚓︎ | boolean | x | x | Indicates if the close buttons of the windows within this workspace are visible to the user |
| title⚓︎ | string | x | The title of the workspace |
|
| width⚓︎ | number | x | x | Returns the current width of the workspace |