Windows
6.9.0The Window Management API lets you create and manipulate windows and is the basis of the App Management API. It allows users to group io.Connect Windows so that they move, maximize and minimize together, and provides the following features, not found in any normal browser:
- 4 types of window modes: flat, tab, HTML and frameless.
- visibility - create hidden windows, show them later;
- bounds - set window location and size;
- user interaction - allow a window to be sticky, enable or disable default system buttons ("Minimize", "Maximize", "Close");
- add custom frame buttons to the windows and respond accordingly to user interaction with them;
- organize windows into tabs that the user can also tear off;
Native apps, as opposed to web apps, can have more than one window. After you interop-enable your native app, your app windows aren't automatically registered as io.Connect Windows. You can choose which ones to register as io.Connect Windows so that they can use io.Connect Desktop functionalities.
Web and native windows are handled by io.Connect Desktop as window abstractions, which means that:
- You can use any technology adapter provided by io.Connect (JavaScript, .NET, Java, and many more) to control any window, web or native.
- From an end user perspective, there is no difference between web or native windows.
- Feature parity is provided by the different technology adapters.
The Window Management API is accessible through the io.windows object.
APIobject
Description
Window Management API.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| groups | GroupsAPI | API for managing window groups. |
Methods
autoArrangemethod
Signature
(displayId?: number) => Promise<void>
Description
Arranges the io.Connect Windows automatically in a grid on the specified display using the entire working area of the display. If called a second time, and the user hasn't broken manually the window arrangement, the windows will be restored to their previous state.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| displayId | number | ID of the display on which to arrange the windows. |
configuremethod
Signature
(options: WindowsConfiguration) => Promise<void>
Description
Configures global io.Connect Windows settings.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | WindowsConfiguration | Configuration options. |
createFlydownmethod
Signature
(targetWindowId: string, config: FlydownOptions) => Promise<Flydown>
Description
Creates a flydown window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| targetWindowId | string | ID of the window for which to create the flydown. |
|
| config | FlydownOptions | Options for creating a flydown window. |
findmethod
Signature
(name: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => IOConnectWindow
Description
Finds a window by name.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Unique window name. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
findByIdmethod
Signature
(id: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => IOConnectWindow
Description
Finds a window by ID.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Window ID. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
listmethod
Signature
(success?: (windows: IOConnectWindow[]) => void) => IOConnectWindow[]
Description
Lists all windows.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (windows: IOConnectWindow[]) => void | Callback function for handling the successfully returned result. |
mymethod
onArrangementChangedmethod
Signature
(callback: (data: { areWindowsArranged: boolean; displayId: number; }) => void) => UnsubscribeFunction
Description
Notifies when io.Connect Windows are arranged automatically or restored to their previous state using the autoArrange() method.
The event will fire also when the user manually breaks the automatic window arrangement.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (data: { areWindowsArranged: boolean; displayId: number; }) => void | Callback function for handling the event. Receives an object with |
onTabAttachedmethod
Signature
(callback: (tabWindow: IOConnectWindow, newTabGroupId: string, tabHeaderVisible: boolean) => void) => UnsubscribeFunction
Description
Notifies when a tab window is attached to a tab group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (tabWindow: IOConnectWindow, newTabGroupId: string, tabHeaderVisible: boolean) => void | Callback function for handling the event. |
onTabDetachedmethod
Signature
(callback: (window: IOConnectWindow, tabGroupId: string, oldTabGroupId: string) => void) => UnsubscribeFunction
Description
Notifies when a tab window is detached from a tab group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow, tabGroupId: string, oldTabGroupId: string) => void | Callback function for handling the event. |
onWindowAddedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a new window is opened.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onWindowFrameColorChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window frame color is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onWindowGotFocusmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a window receives focus.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onWindowLostFocusmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a window loses focus.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onWindowRemovedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a window is closed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
openmethod
Signature
(name: string, url: string, options?: WindowCreateOptions, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Opens a new io.Connect Window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | Unique window name. |
|
| url | string | URL to be loaded in the new window. |
|
| options | WindowCreateOptions | Options for creating a new window. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
readymethod
Signature
() => Promise<any>
Description
Notifies when the Window Management library has been fully initialized.
showPopupmethod
Signature
(targetWindowId: string, config: PopupOptions) => Promise<void>
Description
Creates a popup window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| targetWindowId | string | ID of the window for which to create the popup. |
|
| config | PopupOptions | Options for creating a popup window. |
AttachOptionsobject
Description
Settings for a window being attached to a tab group.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| index | number | Determines the position of the tab in the tab group. |
||
| selected | boolean | If |
Boundsobject
Description
Describes the window bounds.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| height | number | Window height in pixels. |
||
| left | number | Distance of the top left window corner from the left edge of the screen in pixels. |
||
| top | number | Distance of the top left window corner from the top edge of the screen in pixels. |
||
| width | number | Window width in pixels. |
ButtonInfoobject
Description
Window button settings.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| buttonId | string | Unique ID for the button. |
||
| imageBase64 | string | Button image in Base64 format. |
||
| order | number | Button position. |
||
| tooltip | string | Button tooltip. |
CaptureOptionsobject
Description
Options for capturing a display.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| size | AbsoluteSizeOptions | ScaleOptions | Size of the output image. Can be relative or absolute. |
CascadeSettingsobject
Description
Settings for cascading windows.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| enabled | boolean | true | If |
|
| offset | number | 50 | Offset in pixels for opening windows in a cascade. |
ChannelSelectorobject
Description
Settings for the Channel Selector UI.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| channelId | string | Name of the Channel to which the window will be joined by default when it's started. |
||
| enabled | boolean | false | If |
|
| readOnly | boolean | false | If |
|
| type | "single" | "directionalSingle" | "single" | Type of the Channel Selector to show on the io.Connect Windows. A single Channel Selector (default) allows the window to join a single Channel to which it can subscribe and publish data unrestrictedly. A directional single Channel Selector allows the window to join a single Channel, but also enables the user to restrict the window from publishing or from subscribing to the current Channel. |
CloseOptionsobject
Description
Options for closing an io.Connect Window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowPrevent | boolean | If |
||
| showDialog | boolean | If |
CreateGroupApplicationOptionsobject
Description
Options for the app that will be started and loaded in a window frame of a created window group.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowClose | boolean | true | If |
|
| allowCollapse | boolean | false | If |
|
| allowExtract | boolean | false | If |
|
| allowLockUnlock | boolean | false | If |
|
| allowMaximize | boolean | true | If |
|
| allowMinimize | boolean | true | If |
|
| allowTabClose | boolean | true | If |
|
| allowUnstick | boolean | true | If |
|
| autoAlign | boolean | true | If |
|
| autoSnap | boolean | true | If |
|
| base64ImageSource | string | Base64 image that will be used as a taskbar icon for the window. The supported formats are PNG, ICO, JPG and APNG. |
||
| borderColor | string | Color for the window border. Can be a color name such as |
||
| buttonsVisibility | "off" | "onDemand" | "always" | "onFocus" | "onDemand" | Determines the conditions under which the window buttons will be visible.
Valid only for io.Connect Windows with |
|
| cascade | CascadeSettings | Settings for opening new window instances of the same app in a cascade. |
||
| channelSelector | ChannelSelector | Settings for the Channel Selector UI. |
||
| collapseHeight | number | -1 | Defines the height of the window when collapsed. |
|
| devToolsEnable | boolean | true | If |
|
| downloadSettings | DownloadSettings | Defines the file download behavior of the window. |
||
| focus | boolean | true | If |
|
| hasMoveAreas | boolean | true | If |
|
| hasSizeAreas | boolean | true | If |
|
| height | number | 400 | Window height in pixels. |
|
| hidden | boolean | false | If |
|
| historyNavigationEnabled | boolean | true | If |
|
| ignoreFromLayouts | boolean | If |
||
| isChild | boolean | false | If |
|
| isCollapsed | boolean | false | If |
|
| isSticky | boolean | true | If |
|
| left | number | 0 | Distance of the top left window corner from the left edge of the screen in pixels. |
|
| loader | Loader | Defines loader behavior. |
||
| maxHeight | number | Specifies the maximum window height in pixels. |
||
| maxWidth | number | Specifies the maximum window width in pixels. |
||
| minHeight | number | 30 | Specifies the minimum window height in pixels. |
|
| minWidth | number | 50 | Specifies the minimum window width in pixels. |
|
| mode | WindowMode | "flat" | io.Connect Window mode. Possible values are |
|
| moveAreaBottomMargin | string | "0, 0, 0, 0" | Margin for the move area located at the bottom border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaLeftMargin | string | "0, 0, 0, 0" | Margin for the move area located at the left border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaRightMargin | string | "0, 0, 0, 0" | Margin for the move area located at the right border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaThickness | string | "0, 12, 0, 0" | How much of the window area is to be considered as a moving area.
The string value corresponds to the left, top, right and bottom borders of the window.
Setting this to "0, 20, 0, 0" will set a 20 pixel thick move area at the top of the window.
Valid only for io.Connect Windows with |
|
| moveAreaTopMargin | string | "0, 0, 0, 0" | Margin for the move area located at the top border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area.
Valid only for io.Connect Windows with |
|
| name | string | App name as specified in its definition. |
||
| onTop | boolean | false | If |
|
| placement | PlacementSettings | Specifies the window position relative to the screen. |
||
| preloadScripts | string[] | A list of preload scripts (URLs) that will be loaded and executed before the actual page is executed. |
||
| relativeDirection | RelativeDirection | "right" | Direction for positioning the window relatively to the window specified in the |
|
| relativeTo | string | ID of the window that will be used to relatively position the new window. Can be combined with |
||
| showInTaskbar | boolean | true | If |
|
| showTitleBar | boolean | true | If |
|
| sizeAreaThickness | string | "5, 5, 5, 5" | How much of the window area in pixels is to be considered as a sizing area.
The string value corresponds to the left, top, right and bottom borders of the window.
Valid only for io.Connect Windows with |
|
| snappingEdges | string | "all" | Specifies the active io.Connect Window snapping edges.
Possible values are |
|
| startLocation | string | Specifies the window start location.
Possible options are |
||
| stickyFrameColor | string | "#5b8dc9" | Specifies the io.Connect Window frame color. Accepts a hexadecimal color as string (e.g., |
|
| stickyGroup | string | "Any" | If set, the io.Connect Window can only stick to windows that have the same group. |
|
| tabGroupId | string | Specifies the tab group ID. If two or more tab windows are defined with the same ID, they will be hosted in the same container as tabs. |
||
| tabIndex | number | The tab index of the current window. All tabs in a common tab container have different indices. |
||
| tabSelected | boolean | true | If |
|
| tabTitle | string | "" | Sets the tab title. |
|
| tabTooltip | string | "" | Sets the tab tooltip. |
|
| title | string | Sets the window title. To work properly, there should be a |
||
| top | number | 0 | Distance of the top left window corner from the top edge of the screen in pixels. |
|
| urlLoadOptions | LoadURLOptions | Options for loading the window URL. Can be used for POST requests, like uploading a file or specifying additional headers. |
||
| useRandomFrameColor | boolean | false | If |
|
| width | number | 400 | Window width in pixels. |
|
| windowState | FrameState | "normal" | If set, the window will start in the specified state ( |
CreateGroupsOptionsobject
Description
Options for creating window groups.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| context | unknown | Context for the created window groups. |
||
| groups | GroupDefinition[] | List of window groups to be created. |
DetachOptionsobject
Description
Settings for a window detached from a window group.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| bounds | Partial<Bounds> | Window bounds. |
||
| height | number | Window height in pixels. |
||
| hideTabHeader | boolean | If |
||
| relativeDirection | RelativeDirection | Direction for positioning the window relatively to the window specified in the |
||
| relativeTo | IOConnectWindow | Positions the new window relatively to an existing window. |
||
| width | number | Window width in pixels. |
DialogOptionsobject
Description
Options for showing a dialog.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| affirmativeButtonName | string | Name for the affirmative response button. |
||
| cancelButtonName | string | Name for the canceling button. |
||
| context | unknown | Context data that can be used by a custom dialog. |
||
| defaultAction | "affirmative" | "negative" | "cancel" | Determines which dialog button to be the default one.
The action tied to the default button will be executed when the user presses |
||
| inputMaxLength | number | The amount of characters that can be entered in the input field of a |
||
| inputPattern | string | String pattern that serves as a regular expression for validating the input from the user in a |
||
| inputPatternErrorMessage | string | Error message to be displayed if the user input doesn't match the specified validation pattern for a |
||
| inputPlaceholder | string | Placeholder that will be displayed in the input field of a |
||
| message | string | Message to the user that the dialog will contain. |
||
| messageTitle | string | Title for the message that will be displayed in the dialog. |
||
| mode | DialogMode | Mode for the dialog. |
||
| movable | boolean | true | If |
|
| negativeButtonName | string | Name for the negative response button. |
||
| showAffirmativeButton | boolean | false | If |
|
| showCancelButton | boolean | false | If |
|
| showNegativeButton | boolean | false | If |
|
| showTimer | boolean | false | If |
|
| size | Size | Size for the dialog to show. |
||
| timerDuration | number | Interval in seconds after which the dialog will close automatically.
If |
||
| title | string | Title for the dialog that will be displayed in the dialog header. |
||
| transparent | boolean | false | If |
|
| type | string | Type of the dialog to show. Can be either a predefined io.Connect dialog type, or a custom one. |
DialogResultobject
Description
Describes the result returned from showing a dialog.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| action | "clicked" | "closed" | "expired" | If the user clicks a button in the dialog, this will be set to |
||
| button | "affirmative" | "negative" | "cancel" | Specifies which button the user has clicked. |
||
| value | string | The string value from the user input of a |
DockingOptionsobject
Description
Options for docking a window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| claimScreenArea | boolean | If |
||
| position | RelativeDirection | Position of the docked window on the screen - top, bottom, left or right. |
DockingPlacementobject
Description
Describes a docked window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| claimScreenArea | boolean | If |
||
| docked | boolean | If |
||
| position | string | Position of the docked window on the screen - top, bottom, left or right. |
DownloadOptionsobject
Description
Options for downloading a file.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| autoOpenDownload | boolean | false | If |
|
| autoOpenPath | boolean | false | If |
|
| name | string | If specified, will be used as a name for the downloaded file. |
||
| silent | boolean | false | If |
DownloadResultobject
Description
Describes the result from downloading a file.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| path | string | Location of the downloaded file. |
||
| size | number | Size of the downloaded file. |
||
| url | string | URL of the download. |
DownloadSettingsobject
Description
Describes the window download behavior.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| autoOpenDownload | boolean | false | If |
|
| autoOpenPath | boolean | false | If |
|
| autoSave | boolean | true | If |
|
| enable | boolean | true | If |
|
| enableDownloadBar | boolean | true | If |
Flydownobject
Description
Flydown instance returned when creating flydown windows.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| destroy | () => Promise<void> | Function that clears all flydown trigger zones from the window when invoked. |
||
| options | FlydownOptions | The options object used when the flydown was created. |
FlydownOptionsobject
Description
Options for creating flydown windows.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| activeArea | Bounds | Range where the flydown will remain active. |
||
| horizontalOffset | number | Default horizontal offset for all flydown zones in pixels. |
||
| size | Size | ((data: ShowFlydownData, cancel: () => void) => Promise<Size>) | Size of the rendered flydown window. Can be an object with a specific size, or a callback that calculates the size. The callback receives the flydown data and a function to cancel the flydown. |
||
| targetLocation | PopupTargetLocation | Location ( |
||
| verticalOffset | number | Default vertical offset for all flydown zones in pixels. |
||
| windowId | string | ID of the window which will be used as a flydown window. |
||
| zones | FlydownZone[] | Array of defined zones which when triggered will show a flydown window. |
FlydownZoneobject
Description
Describes a flydown trigger zone.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| bounds | Bounds | Bounds of the zone which can trigger a flydown window.
The bounds are relative to the target window, so the coordinates |
||
| flydownSize | Size | ((data: ShowFlydownData, cancel: () => void) => Promise<Size>) | Size of the rendered flydown window. Can be an object with a specific size, or a callback that calculates the size. The callback receives the flydown data and a function to cancel the flydown. |
||
| id | string | Unique ID of the flydown trigger zone. |
||
| targetLocation | PopupTargetLocation | Location ( |
||
| windowId | string | ID of the window which will be used as a flydown window. |
FrameDefinitionobject
Description
Describes a window frame that will be part of a created window group.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| applications | CreateGroupApplicationOptions[] | List of objects containing the names of the apps to be started and loaded in the window frames of the created window group, as well as additional app settings. |
||
| bounds | Bounds | Bounds for the window frame. |
||
| mode | WindowMode | Mode for the window frame. |
Groupobject
Description
Describes a window group.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| id | string | ID of the current group. |
||
| isHeaderVisible | boolean | If |
||
| isHibernated | boolean | If |
||
| isVisible | boolean | If |
||
| windows | IOConnectWindow[] | Lists all windows in the group. |
Methods
capturemethod
Signature
(options?: CaptureOptions) => Promise<string>
Description
Captures the entire window group as a Base64 string.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | CaptureOptions | Options for capturing the window group. |
closemethod
Signature
(options?: CloseOptions) => Promise<void>
Description
Closes the window group.
Available since version io.Connect Desktop 9.3
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | CloseOptions | Options for closing the group that can be used to prevent closing the group and control whether to show a confirmation dialog before closing it. |
findmethod
Signature
(window: string | IOConnectWindow, success?: (window: IOConnectWindow) => void) => IOConnectWindow
Description
Finds a window by ID or by a window object.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| window | string | IOConnectWindow | Window ID or a window object by which to find a window in the group. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
getTitlemethod
Signature
() => Promise<string>
Description
Returns the current title of the window group.
hidemethod
Signature
() => Promise<void>
Description
Hides a window group.
hideHeadermethod
Signature
(success?: (group: Group) => void, error?: (error: string) => void) => Promise<Group>
Description
Hides the window group header.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (group: Group) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
maximizemethod
Signature
(success?: (group: Group) => void, error?: (error: string) => void) => void
Description
Maximizes a window group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (group: Group) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
onClosingmethod
Signature
(callback: (prevent: (options?: PreventClosingOptions) => void) => Promise<void>) => void
Description
Notifies when the window group is about to be closed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (prevent: (options?: PreventClosingOptions) => void) => Promise<void> | Callback function for handling the event. Returns a |
onHeaderVisibilityChangedmethod
onVisibilityChangedmethod
onWindowAddedmethod
Signature
(callback: (group: Group, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a new window is added to the group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (group: Group, window: IOConnectWindow) => void | Callback function for handling the event. |
onWindowRemovedmethod
Signature
(callback: (group: Group, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a window is removed from the group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (group: Group, window: IOConnectWindow) => void | Callback function for handling the event. |
restoremethod
Signature
(success?: (group: Group) => void, error?: (error: string) => void) => void
Description
Restores a window group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (group: Group) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setTitlemethod
Signature
(title: string) => Promise<Group>
Description
Changes the title of the window group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | New title for the window group. |
showmethod
Signature
(activate?: boolean) => Promise<void>
Description
Shows a previously hidden window group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| activate | boolean | Flag indicating whether to activate the group and focus the last focused app window. |
showHeadermethod
Signature
(success?: (group: Group) => void, error?: (error: string) => void) => Promise<Group>
Description
Shows the window group header.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (group: Group) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
showPopupmethod
Signature
(config: PopupOptions) => Promise<void>
Description
Creates a popup window.
Available since version io.Connect Desktop 9.3
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| config | PopupOptions | Options for creating a popup window. |
GroupDefinitionobject
Description
Describes a window group that will be created.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| frames | FrameDefinition[] | List of window frames that will be part of the created window group. |
||
| state | string | State for the created window group. |
||
| title | string | Title for the created window group. |
GroupsAPIobject
Description
API for managing window groups.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| my | Group | Returns the current group of the window. |
Methods
closemethod
Signature
(group: string | Group, options?: CloseOptions) => Promise<void>
Description
Closes a window group.
Available since version io.Connect Desktop 9.3
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| group | string | Group | The |
|
| options | CloseOptions | Options for closing the group that can be used to prevent closing the group and control whether to show a confirmation dialog before closing it. |
createmethod
Signature
(options: CreateGroupsOptions) => Promise<Group[]>
Description
Creates window groups.
Available since version io.Connect Desktop 9.3
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | CreateGroupsOptions | Options for creating window groups. |
findGroupByWindowmethod
Signature
(winId: string | IOConnectWindow, success?: (group: Group) => void, error?: (error: string) => void) => Group
Description
Finds a group by a provided window object or window ID.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| winId | string | IOConnectWindow | An io.Connect Window object or a window ID by which to find a window group. |
|
| success | (group: Group) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
getMyGroupmethod
Signature
() => Promise<Group>
Description
Retrieves the current window group.
Available since version io.Connect Desktop 9.3
hibernatemethod
Signature
(groupId: string) => Promise<string>
Description
Hibernates a window group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| groupId | string | ID of the window group to hibernate. |
listmethod
onGroupAddedmethod
onGroupRemovedmethod
onHibernatedmethod
Signature
(callback?: (groupId: string) => void) => () => void
Description
Notifies when a window group is hibernated.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (groupId: string) => void | Callback function for handling the event. |
onResumedmethod
resumemethod
Signature
(groupId: string, activate?: boolean) => Promise<void>
Description
Resumes a previously hibernated window group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| groupId | string | ID of the window group to resume. |
|
| activate | boolean | Flag indicating whether to activate the group and focus the last focused app window. |
waitForGroupmethod
Signature
(groupId: string) => Promise<Group>
Description
Waits for a group to be loaded.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| groupId | string | ID of the group to be awaited. |
IOConnectWindowobject
Description
Describes an io.Connect Window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowWorkspaceDrop | boolean | If |
||
| application | Application | The app associated with the current window. Can be |
||
| bottomNeighbours | IOConnectWindow[] | Retrieves the bottom neighbors of the window. |
||
| bounds | Bounds | Retrieves the bounds of the window. |
||
| frameButtons | ButtonInfo[] | Retrieves all frame buttons. |
||
| frameColor | string | Retrieves the color of the window frame. |
||
| frameId | string | The ID of the frame in which the window is placed. |
||
| group | Group | Retrieves the group of the window. |
||
| groupId | string | Retrieves the ID of the group of the window. |
||
| hostInstance | string | Instance | Interop instance of the io.Connect Desktop library. |
||
| id | string | ID of the current window. |
||
| interopInstance | Instance | Interop instance of the window. Used for easier access to the Interop API. |
||
| isCollapsed | boolean | If |
||
| isFocused | boolean | If |
||
| isGroupHeaderVisible | boolean | If |
||
| isLocked | boolean | If |
||
| isPinned | boolean | Flag indicating whether the tab of the current window is pinned. Pinned tabs are placed before the regular tab windows and they contain only the window title. Pinned tab windows don't have a "Close" button, effectively preventing the user from closing them. Available only for tab windows in web groups. Available since version io.Connect Desktop 9.5 |
||
| isSticky | boolean | If |
||
| isTabHeaderVisible | boolean | If |
||
| isTabSelected | boolean | If |
||
| isVisible | boolean | If |
||
| jumpList | JumpList | API for managing window jump lists. |
||
| leftNeighbours | IOConnectWindow[] | Retrieves the left neighbors of the window. |
||
| maxHeight | number | Retrieves the maximum height of the window in pixels. |
||
| maxWidth | number | Retrieves the maximum width of the window in pixels. |
||
| minHeight | number | Retrieves the minimum height of the window in pixels. |
||
| minWidth | number | Retrieves the minimum width of the window in pixels. |
||
| mode | WindowMode | Retrieves the mode of the window. |
||
| name | string | Name of the current window. Window names are unique within the framework. |
||
| opened | boolean | If |
||
| placementSettings | PlacementSettings | Retrieves the current placement settings. |
||
| rightNeighbours | IOConnectWindow[] | Retrieves the right neighbors of the window. |
||
| settings | WindowSettings | Settings of the current window. |
||
| state | FrameState | Retrieves the state of the window. |
||
| tabGroupId | string | ID of the tab group in which the current window is located. |
||
| tabIndex | number | Tab index of the current window. |
||
| tabs | IOConnectWindow[] | Retrieves all tabs that are in the same tab group as the current window. Available only when the window is in |
||
| title | string | Title of the current window. |
||
| topNeighbours | IOConnectWindow[] | Retrieves the top neighbors of the window. |
||
| url | string | URL of the current window. |
||
| windowType | "electron" | "remote" | Type of the window. |
||
| zoomFactor | number | Retrieves the current zoom factor. |
Methods
- activate
- addFrameButton
- attachTab
- capture
- center
- clone
- close
- close
- collapse
- configure
- createFlydown
- detachTab
- dock
- download
- executeCode
- expand
- flash
- flashTab
- focus
- getBounds
- getButtons
- getChannel
- getChildWindows
- getConfiguration
- getContext
- getDisplay
- getDockingPlacement
- getIcon
- getParentWindow
- getSizeConstraints
- getTabTooltip
- getTitle
- getURL
- goBack
- goForward
- hide
- hideLoader
- joinChannel
- leaveChannel
- lock
- maximize
- maximizeRestore
- minimize
- moveResize
- moveTo
- navigate
- navigate
- onAttached
- onBoundsChanged
- onChannelRestrictionsChanged
- onClose
- onClosing
- onCollapsed
- onContextUpdated
- onDetached
- onDockingChanged
- onExpanded
- onFocusChanged
- onFrameButtonAdded
- onFrameButtonClicked
- onFrameButtonRemoved
- onFrameColorChanged
- onGroupChanged
- onLockingChanged
- onMaximized
- onMinimized
- onNavigating
- onNeighboursChanged
- onNormal
- onPlacementSettingsChanged
- onRefreshing
- onStickyChanged
- onTabHeaderVisibilityChanged
- onTabSelectionChanged
- onTitleChanged
- onUrlChanged
- onVisibilityChanged
- onWindowAttached
- onWindowDetached
- onZoomFactorChanged
- pin
- place
- printToPDF
- refresh
- removeFrameButton
- resetButtons
- resizeTo
- restore
- setAllowWorkspaceDrop
- setContext
- setFrameColor
- setIcon
- setModalState
- setOnTop
- setSizeConstraints
- setSticky
- setTabHeaderVisible
- setTabTooltip
- setTitle
- setVisible
- setZoomFactor
- show
- showDialog
- showLoader
- showPopup
- snap
- startDrag
- toggleCollapse
- ungroup
- unlock
- unpin
- updateContext
- zoomIn
- zoomOut
activatemethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Activates the current window. This is the same as calling focus().
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
addFrameButtonmethod
Signature
(buttonInfo: ButtonInfo, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Adds a frame button to the window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| buttonInfo | ButtonInfo | Frame button settings. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
attachTabmethod
Signature
(tab: string | IOConnectWindow, options?: number | AttachOptions, success?: () => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Attaches a tab window to the current tab window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tab | string | IOConnectWindow | The instance or the name of the tab window to attach. |
|
| options | number | AttachOptions | Settings for the attached tab. |
|
| success | () => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
capturemethod
Signature
(options: CaptureOptions) => Promise<string>
Description
Captures a screenshot of the window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | CaptureOptions | Options for capturing the window. |
centermethod
Signature
(display?: Display) => Promise<IOConnectWindow>
Description
Moves the window to the center of the screen.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| display | Display | Describes the display on which to center the window. |
clonemethod
Signature
(options?: ApplicationStartOptions) => Promise<IOConnectWindow>
Description
Duplicates the current io.Connect Window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | ApplicationStartOptions | Optional start options that will override the default start options when cloning the window. |
closemethod
Signature
(options?: CloseOptions) => Promise<boolean>
Description
Closes the window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | CloseOptions | Options for closing the window that can be used to prevent closing the window and control whether to show a confirmation dialog before closing it. |
closemethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | ||
| error | (error: string) => void |
collapsemethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Collapses a window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
configuremethod
Signature
(options: WindowConfiguration) => Promise<IOConnectWindow>
Description
Configures the window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | WindowConfiguration | Configuration options. |
createFlydownmethod
Signature
(config: FlydownOptions) => Promise<Flydown>
Description
Creates a flydown window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| config | FlydownOptions | Options for the flydown window. |
detachTabmethod
Signature
(opt: DetachOptions, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Detaches a tab window from the current tab window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| opt | DetachOptions | Settings for the detached window. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
dockmethod
Signature
(options: DockingOptions) => Promise<DockingPlacement>
Description
Docks the window at the specified position.
Available since version io.Connect Desktop 9.1.0
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | DockingOptions | Options for docking the window. |
downloadmethod
Signature
(url: string, options: DownloadOptions) => Promise<DownloadResult>
Description
Downloads a file.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | URL, data URL or blob which to download. |
|
| options | DownloadOptions | Download options. |
executeCodemethod
Signature
(code: string) => Promise<any>
Description
Executes code in the context of the io.Connect Window.
Available since version io.Connect Desktop 9.5
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| code | string | Code to be executed in the context of the window. The code must be supplied as a string. |
expandmethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Expands a window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
flashmethod
Signature
(options?: boolean, mode?: FlashMode) => Promise<IOConnectWindow>
Description
Makes the taskbar window icon flash (e.g., to prompt the user to take action).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | boolean | Flag indicating whether to start or stop flashing the taskbar window icon. Defaults to |
|
| mode | FlashMode | Mode for determining the flashing behavior of the window taskbar icon. |
flashTabmethod
Signature
(options?: boolean) => Promise<IOConnectWindow>
Description
Makes the tab of the window flash (e.g., to prompt the user to take action).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | boolean | Flag indicating whether to start or stop flashing the window tab. Defaults to |
focusmethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Focuses the current window. This is the same as calling activate().
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
getBoundsmethod
getButtonsmethod
Signature
() => Promise<WindowButtons>
Description
Retrieves the visible buttons of the window frame.
getChannelmethod
Signature
() => Promise<string>
Description
Retrieves the current Channel of the window, if any.
getChildWindowsmethod
getConfigurationmethod
getContextmethod
Signature
() => Promise<any>
Description
Retrieves the window context.
getDisplaymethod
getDockingPlacementmethod
Signature
() => Promise<DockingPlacement>
Description
Retrieves the docking placement information for the current window.
Available since version io.Connect Desktop 9.1.0
getIconmethod
Signature
(success?: (icon: string) => void, error?: (error: string) => void) => Promise<string>
Description
Retrieves the window icon.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (icon: string) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
getParentWindowmethod
getSizeConstraintsmethod
getTabTooltipmethod
Signature
() => Promise<string>
Description
Retrieves the tooltip of a tab window.
getTitlemethod
Signature
() => Promise<string>
Description
Retrieves the window title.
getURLmethod
Signature
() => Promise<string>
Description
Retrieves the window URL.
goBackmethod
Signature
() => Promise<void>
Description
Makes the window navigate back to the previous web page.
goForwardmethod
Signature
() => Promise<void>
Description
Makes the window navigate forward to the next web page.
hidemethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Hides the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
hideLoadermethod
joinChannelmethod
Signature
(name: string) => Promise<void>
Description
Joins a new Channel.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | The name of the Channel to join. |
leaveChannelmethod
Signature
() => Promise<void>
Description
Leaves the current Channel.
lockmethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Locks the window. When in locked state, moving the window will result in moving the entire group (if it's part of any).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
maximizemethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Maximizes a window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
maximizeRestoremethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Maximizes or restores the current window based on the current window state.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
minimizemethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Minimizes a window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
moveResizemethod
Signature
(dimension: Partial<Bounds>, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Moves and/or resizes the window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| dimension | Partial<Bounds> | Location and size for the window. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
moveTomethod
Signature
(top?: number, left?: number) => Promise<IOConnectWindow>
Description
Moves a window to the specified position on the screen.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| top | number | Distance in pixels from the top edge of the screen for the top window border. |
|
| left | number | Distance in pixels from the left edge of the screen for the left window border. |
navigatemethod
Signature
(url: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Navigates the window to a new URL.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | URL to which to navigate. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
navigatemethod
Signature
(url: string, options?: LoadURLOptions) => Promise<IOConnectWindow>
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | ||
| options | LoadURLOptions |
onAttachedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the current window is attached to another window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onBoundsChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window bounds are changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onChannelRestrictionsChangedmethod
Signature
(callback: (restrictions: Restrictions) => void) => () => void
Description
Notifies when the restrictions for any existing Channel have changed. Returns an unsubscribe function.
Available since version io.Connect Desktop 9.5
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (restrictions: Restrictions) => void | Callback function for handling the event. |
onClosemethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is closed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onClosingmethod
Signature
(callback: (prevent: (options?: PreventClosingOptions) => void) => Promise<void>) => void
Description
Notifies when the window is about to be closed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (prevent: (options?: PreventClosingOptions) => void) => Promise<void> | Callback function for handling the event. Returns a |
onCollapsedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is collapsed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onContextUpdatedmethod
Signature
(callback: (context: any, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window context is updated.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (context: any, window: IOConnectWindow) => void | Callback function for handling the event. |
onDetachedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the current window is detached from another window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onDockingChangedmethod
Signature
(callback: (window: IOConnectWindow, dockingPlacement: DockingPlacement) => void) => UnsubscribeFunction
Description
Notifies when the window docking placement is changed.
Available since version io.Connect Desktop 9.1.0
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow, dockingPlacement: DockingPlacement) => void | Callback function for handling the event. |
onExpandedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is expanded.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onFocusChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window focus is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onFrameButtonAddedmethod
Signature
(callback: (buttonInfo: ButtonInfo, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a frame button is added.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (buttonInfo: ButtonInfo, window: IOConnectWindow) => void | Callback function for handling the event. |
onFrameButtonClickedmethod
Signature
(callback: (buttonInfo: ButtonInfo, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a frame button is clicked.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (buttonInfo: ButtonInfo, window: IOConnectWindow) => void | Callback function for handling the event. |
onFrameButtonRemovedmethod
Signature
(callback: (buttonInfo: ButtonInfo, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a frame button is removed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (buttonInfo: ButtonInfo, window: IOConnectWindow) => void | Callback function for handling the event. |
onFrameColorChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window frame color is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onGroupChangedmethod
Signature
(callback: (window: IOConnectWindow, newGroup: Group, oldGroup: Group) => void) => UnsubscribeFunction
Description
Notifies when the window group is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow, newGroup: Group, oldGroup: Group) => void | Callback function for handling the event. |
onLockingChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is locked or unlocked.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onMaximizedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is maximized.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onMinimizedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is minimized.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onNavigatingmethod
Signature
(callback: (args: { newUrl: string; }) => Promise<void>) => void
Description
Notifies when the window is about to be navigated to a new URL.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (args: { newUrl: string; }) => Promise<void> | Callback function for handling the event. |
onNeighboursChangedmethod
Signature
(callback: (neighbours: Neighbours, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the neighbors of the window are changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (neighbours: Neighbours, window: IOConnectWindow) => void | Callback function for handling the event. |
onNormalmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is restored from minimized or maximized state to normal state.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onPlacementSettingsChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the placement settings for the window are changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onRefreshingmethod
Signature
(callback: (prevent: () => void) => Promise<void>) => void
Description
Notifies when the window is about to be refreshed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (prevent: () => void) => Promise<void> | Callback function for handling the event. Returns a |
onStickyChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window stickiness is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onTabHeaderVisibilityChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the visibility of the window tab header changes.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onTabSelectionChangedmethod
Signature
(callback: (selectedWindow: IOConnectWindow, previousWindow: IOConnectWindow, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the active tab is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (selectedWindow: IOConnectWindow, previousWindow: IOConnectWindow, window: IOConnectWindow) => void | Callback function for handling the event. |
onTitleChangedmethod
Signature
(callback: (title: string, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the title of the window is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (title: string, window: IOConnectWindow) => void | Callback function for handling the event. |
onUrlChangedmethod
Signature
(callback: (url: string, window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window URL is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (url: string, window: IOConnectWindow) => void | Callback function for handling the event. |
onVisibilityChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the window visibility changes.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onWindowAttachedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a window is attached to the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onWindowDetachedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when a window is detached from the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
onZoomFactorChangedmethod
Signature
(callback: (window: IOConnectWindow) => void) => UnsubscribeFunction
Description
Notifies when the zoom factor is changed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| callback | (window: IOConnectWindow) => void | Callback function for handling the event. |
pinmethod
Signature
() => Promise<IOConnectWindow>
Description
Pins the tab of the current window. Pinned tabs are placed before the regular tab windows and contain only the window title. Pinned tab windows don't have a "Close" button preventing the user from closing them. Available only for tab windows in web groups.
Available since version io.Connect Desktop 9.5
placemethod
Signature
(options: PlacementSettings) => Promise<void>
Description
Places the window at the specified position.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | PlacementSettings | Window placement settings. |
printmethod
Signature
(options?: PrintOptions) => Promise<IOConnectWindow>
Description
Prints the window web page.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | PrintOptions | Print options. |
printToPDFmethod
Signature
(options?: PrintToPDFOptions) => Promise<string>
Description
Prints the window web page as a PDF file.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | PrintToPDFOptions | Print to PDF options. |
refreshmethod
Signature
(ignoreCache?: boolean) => Promise<IOConnectWindow>
Description
Refreshes the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| ignoreCache | boolean | Flag indicating whether to use the Chromium cache (if |
removeFrameButtonmethod
Signature
(buttonId: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Removes a frame button from the window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| buttonId | string | ID of the button to remove. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
resetButtonsmethod
Signature
(buttons: WindowButtons, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Resets the visible buttons of the window frame.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| buttons | WindowButtons | Describes which buttons to be shown on the window frame. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
resizeTomethod
Signature
(width?: number, height?: number) => Promise<IOConnectWindow>
Description
Resizes a window to the specified size.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| width | number | Width in pixels to which to resize the window. |
|
| height | number | Height in pixels to which to resize the window. |
restoremethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Restores a window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setAllowWorkspaceDropmethod
Signature
(allow: boolean) => Promise<IOConnectWindow>
Description
Specifies whether the user will able to drop the current window in a Workspace.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| allow | boolean | Flag indicating whether the user will be able to drop the window in a Workspace. |
setContextmethod
Signature
(context: any) => Promise<IOConnectWindow>
Description
Sets the window context.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| context | any |
setFrameColormethod
Signature
(frameColor: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Sets the window frame color.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| frameColor | string | Can be a color name, such as "red", or a hexadecimal RGB or ARGB value. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setIconmethod
Signature
(base64Image: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Sets the window icon.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| base64Image | string | Icon as a Base64 string. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setModalStatemethod
Signature
(isModal: boolean) => Promise<void>
Description
Makes a window behave like a modal window when it's used as a flydown.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| isModal | boolean | Flag indicating whether the modal behavior is to be turned on or off. |
setOnTopmethod
Signature
(onTop: boolean | "always", success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Z-index setting for the window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| onTop | boolean | "always" | If |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setSizeConstraintsmethod
Signature
(constraints: SizeConstraints, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Changes the size constraints of the window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| constraints | SizeConstraints | Minimum and maximum width and height constraints for the window in pixels. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setStickymethod
Signature
(isSticky: boolean, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Enables or disables the stickiness of the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| isSticky | boolean | Flag indicating whether the window will be able to stick to other windows. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setTabHeaderVisiblemethod
Signature
(toBeVisible?: boolean, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Hides or shows the tab header of the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| toBeVisible | boolean | Flag indicating whether to show or hide the tab header. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setTabTooltipmethod
Signature
(tabTooltip: string) => Promise<IOConnectWindow>
Description
Changes the tooltip of a tab window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tabTooltip | string | Text to be used as a tooltip. |
setTitlemethod
Signature
(title: string, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Sets the title of the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | New title for the window. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setVisiblemethod
Signature
(toBeVisible?: boolean, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Hides or shows the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| toBeVisible | boolean | Flag indicating whether the window will become visible or hidden. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
setZoomFactormethod
Signature
(factor: number) => Promise<IOConnectWindow>
Description
Changes the zoom level.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| factor | number | Zoom factor. |
showmethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Shows the current window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
showDialogmethod
Signature
<T>(options: DialogOptions) => Promise<DialogResult | T>
Description
Shows a dialog with a title, message and response buttons to the user.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | DialogOptions | Options for the dialog. |
showLoadermethod
Signature
(options?: Loader) => Promise<IOConnectWindow>
Description
Shows a loader animation for the window or updates the loader properties (animation type, background or text).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | Loader | Settings for the loader animation. |
showPopupmethod
Signature
(config: PopupOptions) => Promise<IOConnectWindow>
Description
Shows a popup window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| config | PopupOptions | Options for the popup window. |
snapmethod
Signature
(target: string | IOConnectWindow, options?: "top" | "left" | "right" | "bottom" | SnappingOptions, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Snaps the window to another window.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| target | string | IOConnectWindow | ID or instance of the window to which to snap the current window. |
|
| options | "top" | "left" | "right" | "bottom" | SnappingOptions | Relative direction or options for snapping a window to another window or window group. |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
startDragmethod
Signature
(options: StartDragOptions) => Promise<IOConnectWindow>
Description
Enables moving files from a web page to the OS when a user starts dragging a web page element. Based on the Electron Native File Drag & Drop functionality.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | StartDragOptions | Options for the file that will be moved. |
toggleCollapsemethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Collapses or expands the current window based on the current window state.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
ungroupmethod
Signature
(options?: UngroupOptions) => Promise<IOConnectWindow>
Description
Extracts the current window from the window group. If the window is part of a tab group, the entire tab group will be extracted.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | UngroupOptions | Settings for the extracted window. |
unlockmethod
Signature
(success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Unlocks the window. When in unlocked state, moving the window will result in tearing it out from the window group (if it's part of any).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
unpinmethod
Signature
() => Promise<IOConnectWindow>
Description
Unpins the tab of the current window. The previously pinned tab reverts to a normal tab window containing a "Close" button. Available only for tab windows in web groups.
Available since version io.Connect Desktop 9.5
updateContextmethod
Signature
(context: any, success?: (window: IOConnectWindow) => void, error?: (error: string) => void) => Promise<IOConnectWindow>
Description
Updates the window context.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| context | any | Context object with which to update the current context (or create a new one if it doesn't exist). |
|
| success | (window: IOConnectWindow) => void | Callback function for handling the successfully returned result. |
|
| error | (error: string) => void | Callback function for handling errors. |
zoomInmethod
zoomOutmethod
JumpListobject
Description
API for managing window jump lists.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| categories | JumpListCategoriesAPI | API for managing jump list categories. |
Methods
isEnabledmethod
Signature
() => Promise<boolean>
Description
If true, jump lists are enabled.
setEnabledmethod
Signature
(enabled: boolean) => Promise<void>
Description
Enables or disables jump lists.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | Flag indicating whether to enable or disable jump lists. |
JumpListActionsAPIobject
Description
API for managing jump list actions within a category.
Methods
createmethod
Signature
(actions: JumpListActionSettings[]) => Promise<void>
Description
Creates jump list actions for the category.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| actions | JumpListActionSettings[] | List of objects describing the actions to create. |
listmethod
Signature
() => Promise<JumpListActionSettings[]>
Description
Lists all available actions for the jump list category.
removemethod
Signature
(actions: JumpListActionSettings[]) => Promise<void>
Description
Removes actions from the jump list category.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| actions | JumpListActionSettings[] | List of objects describing the actions to remove. |
JumpListActionSettingsobject
Description
Settings for a jump list action.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| callback | () => Promise<void> | Callback that will be executed when the user clicks on the action. |
||
| icon | string | Icon for the action to be displayed in the context menu. |
||
| multiInstanceTitle | string | Title of the action to be displayed in the context menu when there are multiple instances with grouped taskbar icons. |
||
| singleInstanceTitle | string | Title of the action to be displayed in the context menu when there is a single instance with a single taskbar icon. |
JumpListCategoriesAPIobject
Description
API for managing jump list categories.
Methods
createmethod
Signature
(title: string, actions: JumpListActionSettings[]) => Promise<void>
Description
Creates a jump list category.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | Title for the category. |
|
| actions | JumpListActionSettings[] | List of objects describing the actions in the category. |
findmethod
Signature
(title: string) => Promise<JumpListCategory>
Description
Retrieves a jump list category.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | Title of the category to retrieve. |
listmethod
removemethod
Signature
(title: string) => Promise<void>
Description
Removes a jump list category.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | Title of the category to remove. |
JumpListCategoryobject
Description
Describes a jump list category.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| actions | JumpListActionsAPI | API for managing jump list actions within a category. |
||
| title | string | Title of the category. |
JumpListCategorySettingsobject
Description
Settings for a jump list category.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| actions | JumpListActionSettings[] | List of actions contained in the category. |
||
| title | string | Title of the category to be displayed in the context menu. |
JumpListSettingsobject
Description
Settings for app jump lists.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| categories | JumpListCategorySettings[] | Categorized lists with actions to execute when the user clicks on them. |
||
| enabled | boolean | true | If |
Loaderobject
Description
Window loader settings.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| enabled | boolean | true | Enable or disable the loader. |
|
| loaderBackground | string | "#1C2D3B" | Changes the background of the loader page. |
|
| loaderHideOnLoad | boolean | true | Hide the loader once the page is loaded. |
|
| loaderSize | number | Sets a specific size in pixels for the loader animation. |
||
| loaderSizeFactor | number | 0.3 | Sets a size factor for the loader animation relative to the window size. |
|
| loaderSpeed | number | 1 | Changes the loader animation speed. |
|
| loaderText | string | "Loading" | Text that will show below the loader animation. |
|
| loaderTextColor | string | "#F1F1F1" | Color for the loader text. |
|
| loaderTextSize | number | 12 | Size of the loader text. |
|
| loaderType | string | "DoubleBounce" | Type of the loading animation. |
|
| timeout | number | Interval in milliseconds after which the loader will be hidden. |
LoadURLOptionsobject
Description
Options for loading a window URL.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| baseURLForDataURL | string | Base URL for files loaded by a data URL. Must end with a trailing path separator. This property is necessary only when the loaded URL is a data URL. |
||
| extraHeaders | string | A string with extra headers for the request. Separate the headers with a |
||
| httpReferrer | string | Referrer | URL for the |
||
| postData | (UploadBase64Data | UploadFile)[] | Data for the POST request. The list can contain both |
||
| queryString | string | Query string that will be appended to the URL when starting the app. If the string doesn't start with a |
||
| userAgent | string | Value for the |
Marginsobject
Description
Margins for the printed web page.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| bottom | number | Bottom margin for the printed web page in pixels. |
||
| left | number | Left margin for the printed web page in pixels. |
||
| marginType | "default" | "none" | "printableArea" | "custom" | Margin type. If |
||
| right | number | Right margin for the printed web page in pixels. |
||
| top | number | Top margin for the printed web page in pixels. |
Neighboursobject
Description
Describes the window neighbors of an io.Connect Window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| bottomNeighbours | IOConnectWindow[] | Window neighbors to the bottom of the io.Connect Window. |
||
| leftNeighbours | IOConnectWindow[] | Window neighbors on the left side of the io.Connect Window. |
||
| rightNeighbours | IOConnectWindow[] | Window neighbors on the right side of the io.Connect Window. |
||
| topNeighbours | IOConnectWindow[] | Window neighbors on top of the io.Connect Window. |
PageRangeobject
Description
Page range to print.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| from | number | Index of the first page to print (0-based). |
||
| to | number | Index of the last page to print (inclusive, 0-based). |
PlacementSettingsobject
Description
Describes the window position relative to the screen.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| bottom | string | number | Bottom margin for the placed window. Use a |
||
| display | Display | "current" | Defines the current display. |
||
| height | string | number | Defines the window height.
Use a |
||
| horizontalAlignment | "left" | "right" | "center" | "stretch" | Horizontal alignment for the placed window. If |
||
| left | string | number | Left margin for the placed window. Use a |
||
| right | string | number | Right margin for the placed window. Use a |
||
| snapped | boolean | If |
||
| top | string | number | Top margin for the placed window. Use a |
||
| verticalAlignment | "top" | "bottom" | "center" | "stretch" | Vertical alignment for the placed window. If |
||
| width | string | number | Defines the window width.
Use a |
PopupOptionsobject
Description
Options for creating popup windows.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| horizontalOffset | number | Horizontal offset from the target bounds (applied only to |
||
| size | Size | Size of the rendered popup window. |
||
| targetBounds | Bounds | Bounds of the area around which the popup will appear. |
||
| targetLocation | PopupTargetLocation | Location ( |
||
| verticalOffset | number | Vertical offset from the target bounds (applied only to |
||
| windowId | string | ID of the window which will be used as a popup window. |
PreventClosingOptionsobject
Description
Options for the prevent() function passed as an argument to the onClosing() method when an io.Connect Window is about to be closed.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| showDialog | boolean | If |
PrintOptionsobject
Description
Options for printing web pages.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| collate | boolean | If |
||
| color | boolean | true | If |
|
| copies | number | The number of copies of the web page to print. |
||
| deviceName | string | Sets the printer device name to use. Must be the system-defined name and not the user-friendly name. |
||
| dpi | { horizontal?: number; vertical?: number; } | Print resolution in pixels. |
||
| duplexMode | "simplex" | "shortEdge" | "longEdge" | Duplex mode for the printed web page. |
||
| footer | string | String to be printed as a page footer. |
||
| header | string | String to be printed as a page header. |
||
| landscape | boolean | false | If |
|
| margins | Margins | Margins for the printed web page. |
||
| pageRanges | PageRange[] | Page range to print. |
||
| pageSize | Size | "A3" | "A4" | "A5" | "Legal" | "Letter" | "Tabloid" | Page size for the printed web page. |
||
| pagesPerSheet | number | Number of pages to print per sheet. |
||
| printBackground | boolean | false | Prints the background color and image of the web page. |
|
| scaleFactor | number | Scale factor of the web page. |
||
| silent | boolean | false | If |
PrintToPDFOptionsobject
Description
Options for printing PDF files.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| autoOpen | boolean | false | If |
|
| autoOpenPath | boolean | false | If |
|
| autoSave | boolean | false | If |
|
| headerFooter | { title?: string; url?: string; } | Header and footer for the PDF. |
||
| landscape | boolean | Set to |
||
| marginsType | number | Specifies the type of margins to use. Use 0 for default margin, 1 for no margin, and 2 for minimum margin. |
||
| pageRanges | PageRange[] | The page range to print. |
||
| pageSize | Size | "A3" | "A4" | "A5" | "Legal" | "Letter" | "Tabloid" | Page size of the generated PDF file. |
||
| printBackground | boolean | If |
||
| printSelectionOnly | boolean | If |
||
| scaleFactor | number | The scale factor of the web page. Can range from 0 to 100. |
Referrerobject
Description
Describes the values that will be used for the Referer and the Referrer-Policy request headers.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| policy | "default" | "unsafe-url" | "no-referrer-when-downgrade" | "no-referrer" | "origin" | "strict-origin-when-cross-origin" | "same-origin" | "strict-origin" | Value for the |
||
| url | string | URL for the |
ShowFlydownDataobject
Description
Describes a flydown window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| flydownWindowBounds | Bounds | Initial bounds of the flydown, if set before the callback is invoked.
If not set, this defaults to |
||
| flydownWindowId | string | ID of the window used as a flydown. |
||
| zoneId | string | ID of the zone which triggered the flydown. |
Sizeobject
Description
Describes the size of the window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| height | number | Window height in pixels. |
||
| width | number | Window width in pixels. |
SizeConstraintsobject
Description
Describes the minimum and maximum constraints for the window size.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| maxHeight | number | Maximum height in pixels for the window. |
||
| maxWidth | number | Maximum width in pixels for the window. |
||
| minHeight | number | Minimum height in pixels for the window. |
||
| minWidth | number | Minimum width in pixels for the window. |
SnappingOptionsobject
Description
Options for snapping a window to another window or a window group.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| autoAlign | boolean | If |
||
| direction | RelativeDirection | Direction for snapping the window relative to the target window. |
StartDragOptionsobject
Description
Options for moving a file from a web page to the OS.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| data | string | File data in string format. |
||
| filename | string | Name for the file. |
||
| icon | string | Icon that will be shown under the mouse cursor when the user drags the file. |
||
| type | "file" | "base64" | "base64url" | "utf8" | Type of the file to be moved. |
UngroupOptionsobject
Description
Settings for a window extracted from a window group.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| bounds | Partial<Bounds> | Bounds for the extracted window. |
||
| focus | boolean | If |
UploadBase64Dataobject
Description
Describes data to upload encoded as a Base64 string.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| data | string | The data to upload encoded as a Base64 string. |
||
| type | "base64" | Type of the uploaded data. Must be set to |
UploadFileobject
Description
Describes a file to upload.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| filePath | string | Path to the file to upload. |
||
| length | number | 0 | Number of bytes to read starting from the value set in |
|
| modificationTime | number | The time the file was last modified expressed as a number of seconds since the UNIX epoch. |
||
| offset | number | 0 | Position of the first byte to read. |
|
| type | "file" | Type of the uploaded data. Must be set to |
WindowButtonsobject
Description
Describes the buttons for the window frame.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowClose | boolean | If |
||
| allowCollapse | boolean | If |
||
| allowLockUnlock | boolean | If |
||
| allowMaximize | boolean | If |
||
| allowMinimize | boolean | If |
WindowConfigurationobject
Description
Configuration options for an io.Connect Window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| buttonsVisibility | "off" | "onDemand" | "always" | "onFocus" | "onDemand" | Determines the conditions under which the window buttons will be visible.
Valid only for io.Connect Windows with |
|
| hasMoveAreas | boolean | true | If |
|
| hasSizeAreas | boolean | true | If |
|
| moveAreaBottomMargin | string | "0, 0, 0, 0" | Margin for the move area located at the bottom border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaLeftMargin | string | "0, 0, 0, 0" | Margin for the move area located at the left border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaRightMargin | string | "0, 0, 0, 0" | Margin for the move area located at the right border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaThickness | string | "0, 12, 0, 0" | How much of the window area is to be considered as a moving area.
The string value corresponds to the left, top, right and bottom borders of the window.
Setting this to "0, 20, 0, 0" will set a 20 pixel thick move area at the top of the window.
Valid only for io.Connect Windows with |
|
| moveAreaTopMargin | string | "0, 0, 0, 0" | Margin for the move area located at the top border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area.
Valid only for io.Connect Windows with |
|
| sizeAreaThickness | string | "5, 5, 5, 5" | How much of the window area in pixels is to be considered as a sizing area.
The string value corresponds to the left, top, right and bottom borders of the window.
Valid only for io.Connect Windows with |
WindowCreateOptionsobject
Description
Options for creating a new window.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowClose | boolean | true | If |
|
| allowCollapse | boolean | false | If |
|
| allowExtract | boolean | false | If |
|
| allowLockUnlock | boolean | false | If |
|
| allowMaximize | boolean | true | If |
|
| allowMinimize | boolean | true | If |
|
| allowTabClose | boolean | true | If |
|
| allowUnstick | boolean | true | If |
|
| autoAlign | boolean | true | If |
|
| autoSnap | boolean | true | If |
|
| base64ImageSource | string | Base64 image that will be used as a taskbar icon for the window. The supported formats are PNG, ICO, JPG and APNG. |
||
| borderColor | string | Color for the window border. Can be a color name such as |
||
| buttonsVisibility | "off" | "onDemand" | "always" | "onFocus" | "onDemand" | Determines the conditions under which the window buttons will be visible.
Valid only for io.Connect Windows with |
|
| cascade | CascadeSettings | Settings for opening new window instances of the same app in a cascade. |
||
| channelSelector | ChannelSelector | Settings for the Channel Selector UI. |
||
| collapseHeight | number | -1 | Defines the height of the window when collapsed. |
|
| context | any | Context for the new window. |
||
| devToolsEnable | boolean | true | If |
|
| downloadSettings | DownloadSettings | Defines the file download behavior of the window. |
||
| focus | boolean | true | If |
|
| hasMoveAreas | boolean | true | If |
|
| hasSizeAreas | boolean | true | If |
|
| height | number | 400 | Window height in pixels. |
|
| hidden | boolean | false | If |
|
| historyNavigationEnabled | boolean | true | If |
|
| ignoreFromLayouts | boolean | If |
||
| isChild | boolean | false | If |
|
| isCollapsed | boolean | false | If |
|
| isSticky | boolean | true | If |
|
| left | number | 0 | Distance of the top left window corner from the left edge of the screen in pixels. |
|
| loader | Loader | Defines loader behavior. |
||
| maxHeight | number | Specifies the maximum window height in pixels. |
||
| maxWidth | number | Specifies the maximum window width in pixels. |
||
| minHeight | number | 30 | Specifies the minimum window height in pixels. |
|
| minWidth | number | 50 | Specifies the minimum window width in pixels. |
|
| mode | WindowMode | "flat" | io.Connect Window mode. Possible values are |
|
| moveAreaBottomMargin | string | "0, 0, 0, 0" | Margin for the move area located at the bottom border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaLeftMargin | string | "0, 0, 0, 0" | Margin for the move area located at the left border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaRightMargin | string | "0, 0, 0, 0" | Margin for the move area located at the right border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaThickness | string | "0, 12, 0, 0" | How much of the window area is to be considered as a moving area.
The string value corresponds to the left, top, right and bottom borders of the window.
Setting this to "0, 20, 0, 0" will set a 20 pixel thick move area at the top of the window.
Valid only for io.Connect Windows with |
|
| moveAreaTopMargin | string | "0, 0, 0, 0" | Margin for the move area located at the top border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area.
Valid only for io.Connect Windows with |
|
| onTop | boolean | false | If |
|
| placement | PlacementSettings | Specifies the window position relative to the screen. |
||
| preloadScripts | string[] | A list of preload scripts (URLs) that will be loaded and executed before the actual page is executed. |
||
| relativeDirection | RelativeDirection | "right" | Direction for positioning the window relatively to the window specified in the |
|
| relativeTo | string | ID of the window that will be used to relatively position the new window. Can be combined with |
||
| showInTaskbar | boolean | true | If |
|
| showTitleBar | boolean | true | If |
|
| sizeAreaThickness | string | "5, 5, 5, 5" | How much of the window area in pixels is to be considered as a sizing area.
The string value corresponds to the left, top, right and bottom borders of the window.
Valid only for io.Connect Windows with |
|
| snappingEdges | string | "all" | Specifies the active io.Connect Window snapping edges.
Possible values are |
|
| startLocation | string | Specifies the window start location.
Possible options are |
||
| stickyFrameColor | string | "#5b8dc9" | Specifies the io.Connect Window frame color. Accepts a hexadecimal color as string (e.g., |
|
| stickyGroup | string | "Any" | If set, the io.Connect Window can only stick to windows that have the same group. |
|
| tabGroupId | string | Specifies the tab group ID. If two or more tab windows are defined with the same ID, they will be hosted in the same container as tabs. |
||
| tabIndex | number | The tab index of the current window. All tabs in a common tab container have different indices. |
||
| tabSelected | boolean | true | If |
|
| tabTitle | string | "" | Sets the tab title. |
|
| tabTooltip | string | "" | Sets the tab tooltip. |
|
| title | string | Sets the window title. To work properly, there should be a |
||
| top | number | 0 | Distance of the top left window corner from the top edge of the screen in pixels. |
|
| url | string | URL of the app to be loaded in the new window. |
||
| urlLoadOptions | LoadURLOptions | Options for loading the window URL. Can be used for POST requests, like uploading a file or specifying additional headers. |
||
| useRandomFrameColor | boolean | false | If |
|
| width | number | 400 | Window width in pixels. |
|
| windowName | string | Name of the window. |
||
| windowState | FrameState | "normal" | If set, the window will start in the specified state ( |
WindowsConfigurationobject
Description
Configuration settings for overriding the default global io.Connect Windows settings.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| approachingDistance | number | Sets the distance in pixels at which the approaching edges of io.Connect Windows will be highlighted indicating that the windows will be snapped together. |
||
| autoAlign | boolean | If |
||
| hideGroupCaption | boolean | If |
||
| showExtractButton | boolean | If |
||
| showFeedbackButton | boolean | If |
||
| showStickyButton | boolean | If |
||
| sticky | boolean | If |
WindowSettingsobject
Description
Settings for io.Connect Windows.
Properties
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| allowClose | boolean | true | If |
|
| allowCollapse | boolean | false | If |
|
| allowExtract | boolean | false | If |
|
| allowLockUnlock | boolean | false | If |
|
| allowMaximize | boolean | true | If |
|
| allowMinimize | boolean | true | If |
|
| allowTabClose | boolean | true | If |
|
| allowUnstick | boolean | true | If |
|
| autoAlign | boolean | true | If |
|
| autoSnap | boolean | true | If |
|
| base64ImageSource | string | Base64 image that will be used as a taskbar icon for the window. The supported formats are PNG, ICO, JPG and APNG. |
||
| borderColor | string | Color for the window border. Can be a color name such as |
||
| buttonsVisibility | "off" | "onDemand" | "always" | "onFocus" | "onDemand" | Determines the conditions under which the window buttons will be visible.
Valid only for io.Connect Windows with |
|
| cascade | CascadeSettings | Settings for opening new window instances of the same app in a cascade. |
||
| channelSelector | ChannelSelector | Settings for the Channel Selector UI. |
||
| collapseHeight | number | -1 | Defines the height of the window when collapsed. |
|
| devToolsEnable | boolean | true | If |
|
| downloadSettings | DownloadSettings | Defines the file download behavior of the window. |
||
| focus | boolean | true | If |
|
| hasMoveAreas | boolean | true | If |
|
| hasSizeAreas | boolean | true | If |
|
| height | number | 400 | Window height in pixels. |
|
| hidden | boolean | false | If |
|
| historyNavigationEnabled | boolean | true | If |
|
| ignoreFromLayouts | boolean | If |
||
| isChild | boolean | false | If |
|
| isCollapsed | boolean | false | If |
|
| isSticky | boolean | true | If |
|
| left | number | 0 | Distance of the top left window corner from the left edge of the screen in pixels. |
|
| loader | Loader | Defines loader behavior. |
||
| maxHeight | number | Specifies the maximum window height in pixels. |
||
| maxWidth | number | Specifies the maximum window width in pixels. |
||
| minHeight | number | 30 | Specifies the minimum window height in pixels. |
|
| minWidth | number | 50 | Specifies the minimum window width in pixels. |
|
| mode | WindowMode | "flat" | io.Connect Window mode. Possible values are |
|
| moveAreaBottomMargin | string | "0, 0, 0, 0" | Margin for the move area located at the bottom border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaLeftMargin | string | "0, 0, 0, 0" | Margin for the move area located at the left border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaRightMargin | string | "0, 0, 0, 0" | Margin for the move area located at the right border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "0, 10, 0, 10" will take away 10 pixels from the top and the bottom of the move area.
Valid only for io.Connect Windows with |
|
| moveAreaThickness | string | "0, 12, 0, 0" | How much of the window area is to be considered as a moving area.
The string value corresponds to the left, top, right and bottom borders of the window.
Setting this to "0, 20, 0, 0" will set a 20 pixel thick move area at the top of the window.
Valid only for io.Connect Windows with |
|
| moveAreaTopMargin | string | "0, 0, 0, 0" | Margin for the move area located at the top border of the window. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting this to "10, 0, 10, 0" will take away 10 pixels from the left and the right sides of the move area.
Valid only for io.Connect Windows with |
|
| onTop | boolean | false | If |
|
| placement | PlacementSettings | Specifies the window position relative to the screen. |
||
| preloadScripts | string[] | A list of preload scripts (URLs) that will be loaded and executed before the actual page is executed. |
||
| relativeDirection | RelativeDirection | "right" | Direction for positioning the window relatively to the window specified in the |
|
| relativeTo | string | ID of the window that will be used to relatively position the new window. Can be combined with |
||
| showInTaskbar | boolean | true | If |
|
| showTitleBar | boolean | true | If |
|
| sizeAreaThickness | string | "5, 5, 5, 5" | How much of the window area in pixels is to be considered as a sizing area.
The string value corresponds to the left, top, right and bottom borders of the window.
Valid only for io.Connect Windows with |
|
| snappingEdges | string | "all" | Specifies the active io.Connect Window snapping edges.
Possible values are |
|
| startLocation | string | Specifies the window start location.
Possible options are |
||
| stickyFrameColor | string | "#5b8dc9" | Specifies the io.Connect Window frame color. Accepts a hexadecimal color as string (e.g., |
|
| stickyGroup | string | "Any" | If set, the io.Connect Window can only stick to windows that have the same group. |
|
| tabGroupId | string | Specifies the tab group ID. If two or more tab windows are defined with the same ID, they will be hosted in the same container as tabs. |
||
| tabIndex | number | The tab index of the current window. All tabs in a common tab container have different indices. |
||
| tabSelected | boolean | true | If |
|
| tabTitle | string | "" | Sets the tab title. |
|
| tabTooltip | string | "" | Sets the tab tooltip. |
|
| title | string | Sets the window title. To work properly, there should be a |
||
| top | number | 0 | Distance of the top left window corner from the top edge of the screen in pixels. |
|
| urlLoadOptions | LoadURLOptions | Options for loading the window URL. Can be used for POST requests, like uploading a file or specifying additional headers. |
||
| useRandomFrameColor | boolean | false | If |
|
| width | number | 400 | Window width in pixels. |
|
| windowState | FrameState | "normal" | If set, the window will start in the specified state ( |
DialogModeenumeration
Description
Mode for the dialog.
WindowContainer- only the container (a Workspaces Frame, or an io.Connect Window group) of the window that is showing the dialog will be blocked for user interaction;Global- all visible containers (including frameless io.Connect Windows) will be blocked. All windows within a blocked container are blocked too;
- WindowContainer
- Global
DialogTypeenumeration
Description
Type of the dialog to show. Can be either a predefined io.Connect dialog type, or a custom one.
YesNo- dialog with "Yes" and "No" buttons;YesNoCancel- dialog with "Yes", "No" and "Cancel" buttons;OkCancel- dialog with "OK" and "Cancel" buttons;Ok- dialog with an "OK" button;Custom- custom dialog;SingleInputDialog- dialog with a text input field;
- YesNo
- YesNoCancel
- OkCancel
- Ok
- Custom
- SingleInputDialog
PopupTargetLocationenumeration
Description
Location of the window (flydown or popup) relative to the defined trigger zone (flydown trigger zone or popup trigger area).
- None
- Left
- Right
- Top
- Bottom
FlashModeenumeration
Description
Modes for flashing the window icon in the taskbar:
"auto"- the icon will flash only if the window isn't on focus and will stop flashing when the window is activated;"force"- the icon will flash even if the window is on focus, but still turns off when the window is activated;"forceAndKeep"- the icon will flash until theflash()method is called withfalseas an argument;
- "auto"
- "force"
- "forceAndKeep"
RelativeDirectionenumeration
Description
Relative direction for positioning the window.
- "top"
- "left"
- "right"
- "bottom"
WindowModeenumeration
Description
io.Connect Window mode.
- "html"
- "flat"
- "tab"
- "frameless"
WindowStateenumeration
Description
Window state.
- "normal"
- "maximized"
- "minimized"