Windows
4.7.1The Window Management API lets you create and manipulate windows and is the basis of the Application Management and Activities APIs. Glue42 Windows allow users to group a set of desktop windows so that they move, maximize and minimize together. The Window Management API provides the following features, not found in any normal browser:
- 3 types of window modes: flat, tab or HTML
- Complete control and customization of the windows:
- visibility - create hidden windows, show them later;
- bounds - set window location and/or size;
- user interaction - allow a window to be sticky, enable/disable minimize/maximize/close buttons;
- add custom buttons to the windows and respond accordingly to user interaction with them;
- organize windows into tabs that the user can also tear off;
See also Window Management
object
Description
Window Management API.
Description
Returns the current window.
Returns
(name: string, url: string, options: WindowCreateOptions, success: (window: GDWindow) => void, error: (error: object) => void) => Promise<GDWindow>
Description
Opens a new Glue42 Window.
Parameters
name
string
yes
A unique window name.
url
string
yes
The window URL.
options
no
Options for creating a window.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: object) => void
no
Optional error callback to handle errors.
Returns
Promise<GDWindow>
Description
Finds a window by name.
Parameters
name
string
yes
A unique window name.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional error callback to handle errors.
Returns
Description
Finds a window by ID.
Parameters
id
string
yes
Window ID.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional error callback to handle errors.
Returns
Description
Lists all windows.
Parameters
success
(windows: GDWindow[]) => void
no
Optional success callback to handle the returned windows.
Returns
GDWindow[]
(targetWindowId: string, config: FlydownOptions) => Promise<Flydown>
Description
Creates a flydown window.
Parameters
targetWindowId
string
yes
ID of the window for which to create the flydown.
config
yes
Options for creating a flydown window.
Returns
Promise<Flydown>
(targetWindowId: string, config: PopupOptions) => Promise<void>
Description
Creates a popup window.
Parameters
targetWindowId
string
yes
ID of the window for which to create the popup.
config
yes
Options for creating a popup window.
Returns
Promise<void>
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a new window is opened. For backwards compatibility, you can also use windowAdded.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Receives the added window as a parameter. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Parameters
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a window is closed. For backwards compatibility, you can also use windowRemoved.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Receives the removed window as a parameter. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Parameters
Returns
UnsubscribeFunction
(callback: (tabWindow: GDWindow, newTabGroupId: string, tabHeaderVisible: boolean) => void) => Promise<void>
Description
Notifies when a tab window is attached to another tab group. This is a generic event handler that provides information for both the window being attached and the group of tab windows that the tab is attached to.
Parameters
callback
(tabWindow: GDWindow, newTabGroupId: string, tabHeaderVisible: boolean) => void
yes
Callback function to handle the event. Receives as parameters the attached tab window,
the ID of the new tab group and a boolean value showing whether the header of the tab is visible or not.
Returns
Promise<void>
(callback: (window: GDWindow, tabGroupId: string, oldTabGroupId: string) => void) => Promise<void>
Description
Notifies you when a tab window is detached from another tab group. This is a generic event handler that provides information for both the window being detached and the group of tab windows that the tab is being detached from.
Parameters
callback
(window: GDWindow, tabGroupId: string, oldTabGroupId: string) => void
yes
Callback function to handle the event. Receives as parameters the detached tab window, the ID of the new tab group and a the ID of the old tab group.
Returns
Promise<void>
(callback: (window: GDWindow) => void) => Promise
Description
Notifies when the window frame color is changed.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Receives the window instance as a parameter. Returns a Promise which resolves with an unsubscribe function.
Returns
Promise
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a window receives focus.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Receives the window instance as a parameter. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a window loses focus.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Receives the window instance as a parameter. Returns an unsubscribe function.
Returns
UnsubscribeFunction
() => Promise<any>
Description
Returns a Promise that resolves when the library is ready.
Returns
Promise<any>
Properties
groups:
Returns the API for managing group windows.
object
Description
Glue42 Window object.
- onClose
- onClosing
- onCollapsed
- onContextUpdated
- onDetached
- onExpanded
- onFocusChanged
- onFrameButtonAdded
- onFrameButtonClicked
- onFrameButtonRemoved
- onFrameColorChanged
- onGroupChanged
- onLockingChanged
- onMaximized
- onMinimized
- onNormal
- onRefreshing
- onTabHeaderVisibilityChanged
- onTabSelectionChanged
- onTitleChanged
- onUrlChanged
- onVisibilityChanged
- onWindowAttached
Description
Attaches a tab window to the current tab window.
Parameters
tab
string | GDWindow
yes
The instance or the name of the tab window to attach.
index
number
yes
Index for the attached tab. Determines the position of the tab in the tab group.
success
() => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
(opt: DetachOptions, success: (window: GDWindow) => void, error: (error: string) => void) => Promise<GDWindow>
Description
Detaches a tab window from the current tab window.
Parameters
opt
yes
Settings for the detached window.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Maximizes a window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Restores a window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Minimizes a window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Maximizes or restores the current window based on the current window state.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Collapses a window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Expands a window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Collapses or expands the current window based on the current window state.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Focuses the current window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Activates the current window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Move and/or resize the window.
Parameters
Returns
Promise<GDWindow>
Description
Sets the title of the current window.
Parameters
title
string
yes
The title for the window.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
(styles: WindowStyle, success: (window: GDWindow) => void, error: (error: string) => void) => Promise<GDWindow>
Description
Sets the style of the current window.
Parameters
styles
yes
An object defining the window frame buttons, window size constraints, focus and visibility.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
(buttons: WindowButtons, success: (window: GDWindow) => void, error: (error: string) => void) => Promise<GDWindow>
Description
Resets the visible buttons of the window frame.
Parameters
buttons
yes
An object defining which buttons to be shown on the window frame.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Z-index setting. If true, will make the window appear on top of all other windows.
Parameters
onTop
boolean
yes
success
(window: GDWindow) => void
no
error
(error: string) => void
no
Returns
Promise<GDWindow>
(constraints: SizeConstraints, success: (window: GDWindow) => void, error: (error: string) => void) => Promise<GDWindow>
Description
Changes the size constraints of the window.
Parameters
constraints
yes
Min and max width and height constraints for the window.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Navigates the window to a new URL.
Parameters
url
string
yes
URL to navigate to.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
(buttonInfo: ButtonInfo, success: (window: GDWindow) => void, error: (error: string) => void) => Promise<GDWindow>
Description
Adds a frame button to the window.
Parameters
buttonInfo
yes
Window button settings.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Removes a frame button from the window.
Parameters
buttonId
string
yes
ID of the button to remove.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Hides or shows the current window.
Parameters
toBeVisible
boolean
no
Whether the window is to be visible or not.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Shows the current window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Hides the current window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Closes the window.
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
(target: string | GDWindow, direction: RelativeDirection, success: (window: GDWindow) => void, error: (error: string) => void) => Promise<GDWindow>
Description
Snaps the window to another window.
Parameters
target
string | GDWindow
yes
Instance or name of the window to which to snap the current window.
direction
no
Direction for snapping the window. Relative to the target window.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Shows a loader animation for the window or updates the loader properties (animation type, background or text).
Parameters
Returns
Promise<GDWindow>
() => Promise<GDWindow>
Description
Hides the loader animation for the window.
Returns
Promise<GDWindow>
Description
Updates the window context.
Parameters
context
any
yes
Context object with which to update the current context (or create a new one if it does not exist).
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Locks the window. When in locked state, moving the window will result in moving the entire group (if it is part of any).
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Unlocks the window. When in unlocked state, moving the window will result in tearing it out from the window group (if it is part of any).
Parameters
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
(success: (icon: string) => void, error: InvokeErrorHandler) => Promise<string>
Description
Returns the window icon.
Parameters
success
(icon: string) => void
no
Optional success callback to handle the returned icon.
error
no
Optional callback to handle errors.
Returns
Promise<string>
Description
Sets the window icon.
Parameters
base64Image
string
yes
Icon as a base64 encoded string.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Sets the window frame color.
Parameters
frameColor
string
yes
Can be a color name, such as “red”, or a hex-encoded RGB or ARGB value.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
Description
Hides or shows the tab header of the current window.
Parameters
toBeVisible
boolean
no
Whether to show or hide the tab header.
success
(window: GDWindow) => void
no
Optional success callback to handle the returned window.
error
(error: string) => void
no
Optional callback to handle errors.
Returns
Promise<GDWindow>
(config: PopupOptions) => Promise<GDWindow>
Description
Shows a popup window.
Parameters
Returns
Promise<GDWindow>
(config: FlydownOptions) => Promise<Flydown>
Description
Creates a flydown window.
Parameters
Returns
Promise<Flydown>
Description
Zooms in the window.
Returns
Promise<GDWindow>
Description
Zooms out the window.
Returns
Promise<GDWindow>
(factor: number) => Promise<GDWindow>
Description
Changes the zoom level.
Parameters
factor
number
yes
Zoom factor.
Returns
Promise<GDWindow>
(options: CaptureOptions) => Promise<string>
Description
Returns a screenshot of the window.
Parameters
Returns
Promise<string>
Description
Makes the taskbar window icon flash (e.g., to prompt the user to take action).
Parameters
options
boolean
no
Whether to start or stop flashing the taskbar window icon.
Returns
Promise<GDWindow>
Description
Moves the window to the center of the screen.
Parameters
screen
no
Optional parameter specifying the screen on which to center the window.
Returns
Promise<GDWindow>
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a window is attached to the current window.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a window is detached from the current window.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the visibility of the window tab header changes.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
Description
Notifies when the window is closed.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (url: string, window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window URL is changed.
Parameters
callback
(url: string, window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (title: string, window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the title of the window is changed.
Parameters
callback
(title: string, window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (buttonInfo: ButtonInfo, window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a frame button is added.
Parameters
callback
(buttonInfo: ButtonInfo, window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (buttonInfo: ButtonInfo, window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a frame button is removed.
Parameters
callback
(buttonInfo: ButtonInfo, window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (buttonInfo: ButtonInfo, window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when a frame button is clicked.
Parameters
callback
(buttonInfo: ButtonInfo, window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is collapsed.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is expanded.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is minimized.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is maximized.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
Description
Notifies when the window is restored from minimized/maximized state to normal state.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the current window is attached.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the current window is detached.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window visibility changes.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (context: any, window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window context is updated.
Parameters
callback
(context: any, window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window is locked or unlocked.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window location is changed.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window frame color is changed.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the window focus is changed.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
Description
Notifies when the window group is changed.
Parameters
Returns
UnsubscribeFunction
Description
Notifies when the active tab is changed.
Parameters
Returns
UnsubscribeFunction
(callback: () => Promise<void>) => void
Description
Notifies when the window is about to close.
Parameters
callback
() => Promise<void>
yes
Callback function to handle the event. Returns a Promise that will be awaited
before the window is closed. Subject to a timeout configured in Glue42 Desktop.
Returns
void
(callback: () => Promise<void>) => void
Description
Notifies when the window is about to refresh.
Parameters
callback
() => Promise<void>
yes
Callback function to handle the event. Returns a Promise that will be awaited
before the window is refreshed. Subject to a timeout configured in Glue42 Desktop.
Returns
void
(callback: (window: GDWindow) => void) => UnsubscribeFunction
Description
Notifies when the zoom factor is changed.
Parameters
callback
(window: GDWindow) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
Properties
windowType:
The type of the window.
name:
The name of the current window. Window names are unique within Glue42.
hostInstance:
The Interop instance that the window runs in.
agmInstance:
The Interop instance of the window. Used for easier access to the Interop API.
url:
The URL of the current window.
id:
The ID of the current window.
application:
The application associated with the current window. Can be undefined if the window was not started as an application.
title:
The title of the current window.
windowStyleAttributes:
Deprecated. Use settings instead.
The window styles of the current window.
settings:
The settings of the current window.
tabGroupId:
The tab group ID of the current window. When several windows reside in a common tab container they have the same tab group ID.
frameButtons:
Returns all frame buttons.
mode:
Returns the mode of the window - html, flat, tab.
state:
Returns the state of the window - normal, maximized or minimized.
isCollapsed:
Returns true if the window is collapsed.
isVisible:
Returns true if the window is visible.
isLocked:
Returns true if the window is locked.
isFocused:
Whether the window is focused or not.
isGroupHeaderVisible:
Whether the header of the window group is visible or hidden.
context:
Returns the context of the window.
bounds:
Returns the bounds of the window.
minHeight:
Returns the minimum height of the window.
maxHeight:
Returns the maximum height of the window.
minWidth:
Returns the minimum width of the window.
maxWidth:
Returns the maximum width of the window.
frameColor:
Returns the color of the window frame.
opened:
Whether the window is open or not.
group:
Returns the group of the window.
groupId:
Returns the ID of the group of the window.
topNeighbours:
Returns the top neighbours of the window.
leftNeighbours:
Returns the left neighbours of the window.
rightNeighbours:
Returns right neighbours of the window.
bottomNeighbours:
Returns bottom neighbours of the window.
activityId:
Returns the ID of the activity the window participates in (undefined if it is not part of an activity).
activityWindowId:
Returns the ID of the window if the window is an activity window (undefined if it is not part of an activity).
tabs:
Available only when the window is in tab mode. Returns all tabs that are in the same tab group as the current window.
isTabHeaderVisible:
Whether the tab header of the window is visible or not.
isTabSelected:
Whether the tab window is selected.
zoomFactor:
Returns the current zoom factor.
screen:
Returns the screen the window is on.
object
Description
Provides access to window groups.
Description
Lists all window groups.
Parameters
success
(groups: Group[]) => void
no
Optional callback to handle the returned window groups. Receives an array of the returned window groups as a parameter.
Returns
Group[]
Description
Finds a group by a provided window object or window ID.
Parameters
Returns
Properties
my:
Returns the current group of the window.
object
Description
Glue42 Windows can be grouped together via the Window Management API.
The Group object describes a window group.
Description
Finds a window by ID or by a window object.
Parameters
Returns
Description
Restores the window group.
Parameters
success
(group: Group) => void
no
Optional success callback to handle the returned window group.
error
(error: string) => void
no
Optional error callback to handle errors.
Returns
void
Description
Maximizes the window group.
Parameters
success
(group: Group) => void
no
Optional success callback to handle the maximized window group.
error
(error: string) => void
no
Optional error callback to handle errors.
Returns
void
(success: (group: Group) => void, error: InvokeErrorHandler) => Promise<Group>
Description
Shows the window group header.
Parameters
success
(group: Group) => void
no
Optional success callback that receives the window group as a parameter.
error
no
Optional error callback to handle errors.
Returns
Promise<Group>
Description
Hides the window group header.
Parameters
success
(group: Group) => void
no
Optional success callback that receives the window group as a parameter.
error
() => void
no
Optional error callback to handle errors.
Returns
Promise<Group>
(options: CaptureOptions) => Promise<string>
Description
Returns an image of the entire window group as a base64 encoded string.
Parameters
Returns
Promise<string>
(callback: (group: Group) => void) => UnsubscribeFunction
Description
Notifies when the visibility of the window group header is changed.
Parameters
callback
(group: Group) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
Description
Notifies when a new window is added to the group.
Parameters
Returns
UnsubscribeFunction
(callback: (group: Group) => void) => UnsubscribeFunction
Description
Notifies when a window is removed from the group.
Parameters
callback
(group: Group) => void
yes
Callback function to handle the event. Returns an unsubscribe function.
Returns
UnsubscribeFunction
Properties
id:
The ID of the current group.
windows:
Lists all windows in the group.
isHeaderVisible:
Whether the header of the group is visible or not.
object
Description
Flydown instance returned when creating flydown windows.
Properties
destroy:
Function that clears all flydown trigger zones from the window when invoked.
options:
The options object used when the flydown was created.
object
Description
Settings that define the window download behavior.
Properties
autoSave?:
If true, will autosave the file (without asking the user where to save it). If false, a system save dialog will appear.
Default: true
autoOpenPath?:
If true, will open the folder that contains the downloaded file after the download is completed.
Default: false
autoOpenDownload?:
If true, will open the download file after the download is completed.
Default: false
enable?:
If true, enables the window to download files.
Default: true
enableDownloadBar?:
If true, a download bar tracking the progress will appear at the bottom of the window when downloading. If false, the download process will be invisible.
Default: true
object
Description
Window buttons settings.
Properties
buttonId:
Unique ID for the button.
order?:
Button position.
tooltip?:
Button tooltip.
imageBase64:
Button image in base64 format.
object
Description
Object describing the window bounds.
Properties
top?:
Vertical coordinate of the top left window corner.
left?:
Horizontal coordinate of the top left window corner.
width?:
Window width.
height?:
Window height.
object
Description
Object describing the size of the window.
Properties
width?:
Window width.
height?:
Window height.
object
Description
Options for creating flydown windows.
Properties
zones:
An array of defined zones which when triggered will show a flydown window.
activeArea?:
Range where the flydown will remain active.
horizontalOffset?:
Default horizontal offset for all flydown zones.
verticalOffset?:
Default vertical offset for all flydown zones.
targetLocation?:
The location ("bottom", "top", "left", "right" or "none") where the flydown will appear, relative to the defined flydown zone.
If "none" is passed, the flydown will appear at { left: 0, top: 0 } of the flydown trigger zone.
windowId?:
The ID of the window which will be used as a flydown window.
size?:
The size of the rendered flydown window (width and height).
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.
object
Description
Object describing a flydown window.
Properties
zoneId:
The ID of the zone which triggered the flydown.
flydownWindowBounds:
The initial bounds of the flydown, if set before the callback is invoked. If not set, this defaults to { left: 0, top: 0, height: 200, width: 200}.
flydownWindowId:
The ID of the window used as a flydown.
object
Description
Object describing a flydown trigger zone.
Properties
id:
Unique ID of the flydown trigger zone.
flydownSize?:
The size of the rendered flydown window (width and height).
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.
bounds:
Bounds of the zone which can trigger a flydown window.
These bounds are relative to the target window, so the coordinates { left: 0, top: 0 }
correspond to the top left corner of the target window, rather than the top left corner of the monitor.
targetLocation?:
The location ("bottom", "top", "left", "right" or "none") where the flydown will appear, relative to the defined flydown zone.
If "none" is passed, the flydown will appear at { left: 0, top: 0 } of the flydown trigger zone.
windowId?:
The ID of the window which will be used as a flydown window.
object
Properties
windowName:
The name of the window - must be unique.
url:
Required. The URL of the app to be loaded in the new window
top?:
Distance of the top left window corner from the top edge of the screen.
Default: 0
left?:
Distance of the top left window corner from the left edge of the screen.
Default: 0
width?:
Window width.
Default: 400
height?:
Window height.
Default: 400
allowClose?:
If false, the window will not contain a close button.
Default: true
allowTabClose?:
If false, the tab header will not contain a close button.
Default: true
allowCollapse?:
If false, the window will not contain a collapse button.
Default: true
allowForward?:
If false, the window will not contain an activity related forward button.
Default: true
allowMaximize?:
If false, the window will not contain a maximize button.
Default: true
allowMinimize?:
If false, the window will not contain a minimize button.
Default: true
allowUnstick?:
If false, the window will not unstick from other windows.
Default: true
allowLockUnlock?:
If false, the window will not contain a lock/unlock button.
Default: false
autoSnap?:
If true, when moving the window operation ends, the window will snap to one of the approaching edges of another window
(if any of the approaching edges are marked with red).
Default: true
autoAlign?:
If true, a snapped window will adjust its bounds to the same width/height of the window it has stuck to,
and/or will occupy the space between other windows (if any).
Default: true
base64ImageSource?:
Image as base64 encoded string that will be used as a taskbar icon for the window. The supported formats are png, ico, jpg, apng.
borderColor?:
Can be a color name such as “red”, or a hex-encoded RGB or ARGB value.
collapseHeight?:
Defines the height of the window when collapsed.
Default: -1
devToolsEnable?:
If true, allows opening a developer console (using F12) for the new window.
Default: true
downloadSettings?:
Object that defines file download behavior in the window.
isCollapsed?:
If true, the window will start collapsed.
Default: false
isPopup?:
If true, the window will open as a popup, sharing the lifetime and the environment of the opener.
Default: false
isSticky?:
If true, the window will stick to other Glue42 Windows forming groups.
Default: true
focus?:
If false, the window will not be on focus when created.
Default: true
hasMoveAreas?:
If false, the window cannot be moved.
Default: true
hasSizeAreas?:
If false, the window cannot be resized by dragging its borders, maximizing, etc.
Default: true
If true, the window will be started as a hidden window.
Default: false
If true, this will allow the users to navigate back (CTRL+Left) and forward (CTRL+Right) through the web page history.
Default: true
maxHeight?:
Specifies the maximum window height.
maxWidth?:
Specifies the maximum window width.
minHeight?:
Specifies the minimum window height.
Default: 30
minWidth?:
Specifies the minimum window width.
Default: 50
mode?:
moveAreaThickness?:
How much of the window area is to be considered as a moving area (meaning you can move the window using it).
The string value corresponds to the left, top, right and bottom borders of the window.
Setting moveAreaThickness to “0, 20, 0, 0” will set a 20 pixel thick move area at the top of the window.
Default: "0, 12, 0, 0"
moveAreaTopMargin?:
Margin for the top window move area. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting moveAreaTopMargin to “10, 0, 0, 10” will take away 10 pixels from the left and the right side of the move area.
Default: "0, 0, 0, 0"
onTop?:
If true, the window will appear on top of the z-order.
Default: false
relativeTo?:
The ID of the window that will be used to relatively position the new window. Can be combined with relativeDirection.
relativeDirection?:
Direction ("bottom", "top", "left", "right") of positioning the window relatively to the relativeTo window. Considered only if relativeTo is supplied.
Default: "right"
showInTaskbar?:
If false, the window will not appear on the Windows taskbar.
Default: true
showTitleBar?:
Determines whether the window will have a title bar.
Default: true
sizeAreaThickness?:
How much of the window area is to be considered as a sizing area (meaning you can resize the window using that area). The string value corresponds to the left, top, right and bottom borders.
Default: "5, 5, 5, 5"
snappingEdges?:
Specifies the active Glue42 Window snapping edges.
Possible values are: top, left, right, bottom, all or any combination of them (e.g., left, right).
Default: "all"
startLocation?:
Specifies the start window location.
Possible options are Automatic (The Glue42 Window decides where the window will be positioned) and CenterScreen.
stickyFrameColor?:
Specifies the Glue42 window frame color. Accepts hex color as string (e.g. "#666666") or named HTML colors (e.g. "red").
Default: "#5b8dc9"
stickyGroup?:
If set, the Glue42 Window can only stick to windows that have the same group.
Default: "Any"
tabGroupId?:
Specifies the tab group ID. If two or more tab windows are defined with the same ID, they will be hosted in the same tab window.
tabIndex?:
Specifies the tab position index. Tab windows in the same tab group are ordered by their position index. Use negative index to make the tab active.
tabSelected?:
Tab is selected.
Default: true
tabTitle?:
The tab title.
Default: ""
tabToolTip?:
The tab tooltip.
Default: ""
title?:
Sets the window title. To work properly, there should be a title HTML tag in the page.
loader?:
Object that defines loader behavior.
useRandomFrameColor?:
If true, this will set a random (from a predefined list of colors) frame color to the new window.
Default: false
windowState?:
If set, the window will start in the specified state (maximized, minimized, normal).
Default: "normal"
object
Description
Options for creating popup windows.
Properties
windowId:
The ID of the window which will be used as a popup window.
targetBounds:
The bounds of the area around which the popup will appear.
size:
The size of the rendered popup window (width and height).
targetLocation:
The location ("bottom", "top", "left", "right" or "none") where the popup will appear, relative to the defined popup area.
If "none" is passed, the popup will appear at { left: 0, top: 0 } of the popup area.
horizontalOffset?:
The horizontal offset from the target bounds (applied only to left and right target locations).
verticalOffset?:
The vertical offset from the target bounds (applied only to top and bottom target locations).
object
Description
Window loader settings.
Properties
enabled?:
Enable or disable the loader.
Default: true
loaderHideOnLoad?:
Hide the loader once the page is loaded.
Default: true
loaderSpeed?:
Changes the loader animation speed.
Default: 1
loaderBackground?:
Changes the background of the loader page.
Default: "#1C2D3B"
loaderType?:
Type of the loading animation.
Default: "DoubleBounce"
loaderSize?:
Sets a specific size (in pixels) for the loader animation.
loaderSizeFactor?:
Sets a size factor for the loader animation relative to the window size.
Default: 0.3
loaderText?:
Text that will show below the loader animation.
Default: "Loading"
loaderTextSize?:
Size of the loader text.
Default: 12
loaderTextColor?:
Color for the loader text.
Default: "#F1F1F1"
timeout?:
If set, will auto hide the loader after the specified period of time (in ms).
object
Description
Window settings for a window detached from a window group.
Properties
relativeTo?:
Position the new window relatively to an existing window.
relativeDirection?:
Relative direction of positioning the new window. Considered only if relativeTo is supplied. Can be “bottom”, “top”, “left”, “right”.
width?:
Window width.
height?:
Window height.
bounds?:
Window bounds.
hideTabHeader?:
Whether to hide or show to window header.
object
Description
Options for capturing a display.
Properties
size?:
Size of the output image. Can be relative or absolute.
object
Description
Absolute size for the output image when capturing a display.
Properties
width?:
Image width.
height?:
Image height.
keepAspectRatio?:
Specifies whether to keep the aspect ratio of the output image when you specify width and/or height of the output image.
If true and both width and height are set, then the specified width will be used as a basis for the output image aspect ratio.
Default: true
object
Properties
scale:
Specifies the size of the output image relative to the actual screen size.
object
Description
Settings for Glue42 Windows.
Properties
top?:
Distance of the top left window corner from the top edge of the screen.
Default: 0
left?:
Distance of the top left window corner from the left edge of the screen.
Default: 0
width?:
Window width.
Default: 400
height?:
Window height.
Default: 400
allowClose?:
If false, the window will not contain a close button.
Default: true
allowTabClose?:
If false, the tab header will not contain a close button.
Default: true
allowCollapse?:
If false, the window will not contain a collapse button.
Default: true
allowForward?:
If false, the window will not contain an activity related forward button.
Default: true
allowMaximize?:
If false, the window will not contain a maximize button.
Default: true
allowMinimize?:
If false, the window will not contain a minimize button.
Default: true
allowUnstick?:
If false, the window will not unstick from other windows.
Default: true
allowLockUnlock?:
If false, the window will not contain a lock/unlock button.
Default: false
autoSnap?:
If true, when moving the window operation ends, the window will snap to one of the approaching edges of another window
(if any of the approaching edges are marked with red).
Default: true
autoAlign?:
If true, a snapped window will adjust its bounds to the same width/height of the window it has stuck to,
and/or will occupy the space between other windows (if any).
Default: true
base64ImageSource?:
Image as base64 encoded string that will be used as a taskbar icon for the window. The supported formats are png, ico, jpg, apng.
borderColor?:
Can be a color name such as “red”, or a hex-encoded RGB or ARGB value.
collapseHeight?:
Defines the height of the window when collapsed.
Default: -1
devToolsEnable?:
If true, allows opening a developer console (using F12) for the new window.
Default: true
downloadSettings?:
Object that defines file download behavior in the window.
isCollapsed?:
If true, the window will start collapsed.
Default: false
isPopup?:
If true, the window will open as a popup, sharing the lifetime and the environment of the opener.
Default: false
isSticky?:
If true, the window will stick to other Glue42 Windows forming groups.
Default: true
focus?:
If false, the window will not be on focus when created.
Default: true
hasMoveAreas?:
If false, the window cannot be moved.
Default: true
hasSizeAreas?:
If false, the window cannot be resized by dragging its borders, maximizing, etc.
Default: true
If true, the window will be started as a hidden window.
Default: false
If true, this will allow the users to navigate back (CTRL+Left) and forward (CTRL+Right) through the web page history.
Default: true
maxHeight?:
Specifies the maximum window height.
maxWidth?:
Specifies the maximum window width.
minHeight?:
Specifies the minimum window height.
Default: 30
minWidth?:
Specifies the minimum window width.
Default: 50
mode?:
moveAreaThickness?:
How much of the window area is to be considered as a moving area (meaning you can move the window using it).
The string value corresponds to the left, top, right and bottom borders of the window.
Setting moveAreaThickness to “0, 20, 0, 0” will set a 20 pixel thick move area at the top of the window.
Default: "0, 12, 0, 0"
moveAreaTopMargin?:
Margin for the top window move area. The string value corresponds to the left, top, right and bottom borders of the move area.
Setting moveAreaTopMargin to “10, 0, 0, 10” will take away 10 pixels from the left and the right side of the move area.
Default: "0, 0, 0, 0"
onTop?:
If true, the window will appear on top of the z-order.
Default: false
relativeTo?:
The ID of the window that will be used to relatively position the new window. Can be combined with relativeDirection.
relativeDirection?:
Direction ("bottom", "top", "left", "right") of positioning the window relatively to the relativeTo window. Considered only if relativeTo is supplied.
Default: "right"
showInTaskbar?:
If false, the window will not appear on the Windows taskbar.
Default: true
showTitleBar?:
Determines whether the window will have a title bar.
Default: true
sizeAreaThickness?:
How much of the window area is to be considered as a sizing area (meaning you can resize the window using that area). The string value corresponds to the left, top, right and bottom borders.
Default: "5, 5, 5, 5"
snappingEdges?:
Specifies the active Glue42 Window snapping edges.
Possible values are: top, left, right, bottom, all or any combination of them (e.g., left, right).
Default: "all"
startLocation?:
Specifies the start window location.
Possible options are Automatic (The Glue42 Window decides where the window will be positioned) and CenterScreen.
stickyFrameColor?:
Specifies the Glue42 window frame color. Accepts hex color as string (e.g. "#666666") or named HTML colors (e.g. "red").
Default: "#5b8dc9"
stickyGroup?:
If set, the Glue42 Window can only stick to windows that have the same group.
Default: "Any"
tabGroupId?:
Specifies the tab group ID. If two or more tab windows are defined with the same ID, they will be hosted in the same tab window.
tabIndex?:
Specifies the tab position index. Tab windows in the same tab group are ordered by their position index. Use negative index to make the tab active.
tabSelected?:
Tab is selected.
Default: true
tabTitle?:
The tab title.
Default: ""
tabToolTip?:
The tab tooltip.
Default: ""
title?:
Sets the window title. To work properly, there should be a title HTML tag in the page.
loader?:
Object that defines loader behavior.
useRandomFrameColor?:
If true, this will set a random (from a predefined list of colors) frame color to the new window.
Default: false
windowState?:
If set, the window will start in the specified state (maximized, minimized, normal).
Default: "normal"
object
Properties
allowClose?:
allowCollapse?:
allowLockUnlock?:
allowMaximize?:
allowMinimize?:
object
Properties
maxWidth?:
maxHeight?:
minWidth?:
minHeight?:
object
Properties
focus?:
allowClose?:
allowCollapse?:
allowLockUnlock?:
allowMaximize?:
allowMinimize?:
maxWidth?:
maxHeight?:
minWidth?:
minHeight?:
object
Description
Object describing a screen.
Properties
height:
Screen height.
isPrimary:
Whether this is the primary screen.
left:
Horizontal coordinate of the top left corner of the screen.
name:
Name of the screen assigned by the operating system.
scale:
Screen scale factor.
scaleX:
Scale factor of the horizontal axis of the screen.
scaleY:
Scale factor of the vertical axis of the screen.
top:
Vertical coordinate of the top left corner of the screen.
width:
Screen width.
workingAreaHeight:
Height of the working area.
workingAreaLeft:
Horizontal coordinate of the top left corner of the screen working area.
workingAreaTop:
Vertical coordinate of the top left corner of the screen working area.
workingAreaWidth:
Width of the working area.
enumeration
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
enumeration
Description
Relative direction of positioning the window.
-
- "top"
-
- "left"
-
- "right"
-
- "bottom"
enumeration
Description
Glue42 Window mode.
-
- "html"
-
- "flat"
-
- "tab"
enumeration
Description
Window state.
-
- "normal"
-
- "maximized"
-
- "minimized"