WorkspaceWindowSummaryinterface
An object describing the basic details of a workspace window
Properties (21)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowExtract⚓︎ | boolean | x | x | Show whether or not the user can extract the specified window |
| allowReorder⚓︎ | boolean | x | x | Show whether or not the user can reorder the specified window |
| appName⚓︎ | string | x | The application name of the window if it was registered as an application |
|
| elementId⚓︎ | string | x | An unique string identifier of the workspace element that hosts the window |
|
| focused⚓︎ | boolean | x | A flag showing whether or not the window has focus |
|
| frameId⚓︎ | string | x | The string id of the frame containing this window |
|
| height⚓︎ | number | x | x | Indicates the current height of the window |
| id⚓︎ | string | undefined | x | An unique string identifier of the window |
|
| isLoaded⚓︎ | boolean | x | A flag showing whether or not the window's content is loaded |
|
| isMaximized⚓︎ | boolean | x | A flag showing whether or not the window is maximized within it's box |
|
| isSelected⚓︎ | boolean | x | A flag showing whether or not the window is selected |
|
| maxHeight⚓︎ | number | x | x | Indicates the configured maximum height of the window |
| maxWidth⚓︎ | number | x | x | Indicates the configured maximum width of the window |
| minHeight⚓︎ | number | x | x | Indicates the configured height width of the window |
| minWidth⚓︎ | number | x | x | Indicates the configured minimum width of the window |
| positionIndex⚓︎ | number | x | The position of this window regarding it's siblings |
|
| showCloseButton⚓︎ | boolean | x | x | Indicates whether the close button which is located in the window's tab is visible |
| title⚓︎ | string | x | The title of the window |
|
| type⚓︎ | "window" | x | The type of the workspace element |
|
| width⚓︎ | number | x | x | Indicates the current width of the window |
| workspaceId⚓︎ | string | x | The string id of the workspace containing this window |