WorkspaceWindowinterface
An object describing a window part of an existing workspace
Properties (24)
| 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 |
|
| frame⚓︎ | Frame | x | An object representing the frame, which contains this window |
|
| 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 |
| parent⚓︎ | Workspace | WorkspaceBox | x | An object representing the parent box, which contains this 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 |
| workspace⚓︎ | Workspace | x | An object representing the workspace, which contains this window |
|
| workspaceId⚓︎ | string | x | The string id of the workspace containing this window |
14 Methods
eject()⚓︎
() => Promise<any>
Removes a workspace window from the workspace and turns it into a standalone window.
forceLoad()⚓︎
() => Promise<void>
Forces a window, which was added to the workspace to load it's contents.
getGdWindow()⚓︎
() => any
Returns the underlying GDWindow (Enterprise) or WebWindow (Core) of the workspace window.
lock()⚓︎
(config?: WorkspaceWindowLockConfig | ((config: WorkspaceWindowLockConfig) => WorkspaceWindowLockConfig)) => Promise<void>
Locks the window using a provided config object, which restricts various modification functionalities of the window
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| config⚓︎ | WorkspaceWindowLockConfig | ((config: WorkspaceWindowLockConfig) => WorkspaceWindowLockConfig) | x | This can be either an object or a function. When the object is provided, it overrides all other lock properties. When a function is provided, it will be called with the current lock settings and it should return a lock config, which will override the current settings. The function is recommended in all cases where overriding of the settings is not desired. |
moveTo()⚓︎
(box: WorkspaceBox) => Promise<void>
Moves the workspace window to a new box. In io.Connect Browser this box must be part of the same frame.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| box⚓︎ | WorkspaceBox | An object describing the new box of the window. |
onLockConfigurationChanged()⚓︎
(callback: (config: WorkspaceWindowLockConfig) => void) => Promise<Unsubscribe>
Notifies when a change in the lock configuration of the workspace window has been made
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| callback⚓︎ | (config: WorkspaceWindowLockConfig) => void | Callback function to handle the event. Receives the new lock configuration as a parameter |
onRemoved()⚓︎
(callback: () => void) => Promise<Unsubscribe>
Notifies when this window was removed from the workspace.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| callback⚓︎ | () => void | Callback function to handle the event. |
onTabReordered()⚓︎
(callback: () => void) => Promise<Unsubscribe>
Notifies when the tab of the Workspace window has been reordered. Returns an unsubscribe function.
io.Connect Browser 4.4Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| callback⚓︎ | () => void | Callback function for handling the event. Available only in io.Connect Browser. |
setSize()⚓︎
(sizeConfig: ElementResizeConfig) => Promise<void>
Sets a new size for the window
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| sizeConfig⚓︎ | ElementResizeConfig | A config object which should be the new size of the window. |