Namespace: types

services.window.types

Interfaces

• AdjustedSpawnParams
• ComponentConfig
• ILauncherGroup

Type Aliases

AppIcons

Ƭ AppIcons: Object

Type declaration

Name	Type
taskbarIcon?	IconDescriptor
titleBarIcon	IconDescriptor
toolbarIcon	IconDescriptor

---

Bounds

Ƭ Bounds: Object

Type declaration

Name	Type
bottom?	number
height	number
left	number
right?	number
top	number
width	number

---

ConnectId

Ƭ ConnectId: string | undefined | null

---

CustomData

Ƭ CustomData: Object

Type declaration

Name	Type
appDConfig?	any
component?	any
foreign?	any
interop?	any
isAnApp?	boolean
manifest?	any
monitorDimensions?	any
spawnData?	any
window?	any

---

FSBLWindow

Ƭ FSBLWindow: BaseWindow & FinsembleWindow & { canGroup: boolean ; componentType: string ; disableFrame: Function ; dockingOptions: any ; errorSent: boolean ; isDocked: boolean ; key: string ; lastHeartbeat: number ; notRespondingSent: boolean ; tabbing: boolean ; tiling: boolean ; uuid: string ; warningSent: boolean ; windowDescriptor: WindowDescriptor }

The internal representation of a Finsemble-controlled window.

---

FinsembleWindowData

Ƭ FinsembleWindowData: Partial<OptionalFinsembleWindowData> & { componentType: string ; name: string }

Represents all the state needed to recreate a Finsemble window.

Pass to Launcher.spawn to spawn a new window with the given state.

Once launched, the window saves its own state to storage, indexed by the workspace it belongs to. This state is also partially managed by the Workspace service.

---

IconDescriptor

Ƭ IconDescriptor: IconUrl | IconInitials & { category?: string }

---

IconInitials

Ƭ IconInitials: Object

Type declaration

Name	Type
imageType	"initials"
name	string

---

IconUrl

Ƭ IconUrl: Object

Type declaration

Name	Type
imageType	"url" | "fonticon"
path	string

---

LaunchGroupComponent

Ƭ LaunchGroupComponent: Object

Type declaration

Name	Type
componentType	LaunchGroupComponentType
launchGroupComponentData?	LaunchGroupComponentData
spawnOptions	LaunchGroupComponentSpawnOptions

---

LaunchGroupStackedWindow

Ƭ LaunchGroupStackedWindow: Object

Type declaration

Name	Type
components	LaunchGroupComponentType & { spawnOptions: { data: Record<string, any> } }[]
launchGroupComponentData?	LaunchGroupComponentData
spawnOptions	LaunchGroupComponentSpawnOptions

---

MonitorChoice

Ƭ MonitorChoice: number | "mine" | "primary" | "next" | "previous" | "all"

---

OptionalFinsembleWindowData

Ƭ OptionalFinsembleWindowData: Object

Contains all the optional keys on the FinsembleWindowData type. See FinsembleWindowData for more info.

Type declaration

Name	Type	Description
accelerator	{ devtools: boolean ; reload: boolean ; reloadIgnoringCache: boolean ; zoom: boolean }	-
accelerator.devtools	boolean	-
accelerator.reload	boolean	-
accelerator.reloadIgnoringCache	boolean	-
accelerator.zoom	boolean	-
allowAutoArrange	boolean	-
alphaMask	{ blue: number ; green: number ; red: number }	-
alphaMask.blue	number	-
alphaMask.green	number	-
alphaMask.red	number	-
alwaysOnBottom	boolean	-
alwaysOnTop	boolean	-
applicationIcon	string	-
autoShow	boolean	-
backgroundColor	string	-
backgroundThrottling	boolean	-
bottom	number | string	-
bounds	Bounds	-
callstack	string	-
center	boolean	-
childWindowIdentifiers	[any]	-
componentState	Record<string, any>	DH 5/8/2019 Confusingly, this is not the "official" component state. That's stored under an entirely different key. I'm not sure why or how this is here, but I definitely saw it at runtime.
contextMenu	boolean	-
cornerRounding	{ height: number ; width: number }	-
cornerRounding.height	number	-
cornerRounding.width	number	-
customData	any	-
defaultCentered	boolean	-
defaultHeight	number	-
defaultLeft	number	-
defaultTop	number	-
defaultWidth	number	-
delay_connection	boolean	-
disableIabSecureLogging	boolean	-
draggable	boolean	-
enable-plugins	boolean	-
enableLargerThanScreen	boolean	-
exitOnClose	boolean	-
experimental	{ disableInitialReload: boolean ; v2Api: boolean }	-
experimental.disableInitialReload	boolean	-
experimental.v2Api	boolean	-
focused	boolean	DH 6/14/2019 We added this property because Electron/OF maintain their own record of which window has focus, creating the possibility for the OS and Electron/OF to think different windows have focus. Currently, we only keep this state on WebWindows. If we can figure out a different way to synchronize the OS and container, we may not need this state.
frame	boolean	-
frameConnect	string	-
hasLoaded	boolean	-
height	number | string	-
hideOnBlur	boolean	-
hideOnClose	boolean	-
hideWhileChildrenVisible	boolean	-
icon	string	-
isEvergreen	boolean	-
launchExternal	""	-
launchGroupComponentData	{ closeComponentsTogether: boolean ; launchGroupComponentUUID: string }	-
launchGroupComponentData.closeComponentsTogether	boolean	-
launchGroupComponentData.launchGroupComponentUUID	string	-
left	number | string	-
loadErrorMessage	""	-
maxHeight	number	-
maxWidth	number	-
maximizable	boolean	-
minHeight	number	-
minWidth	number	-
minimizable	boolean	-
monitorDimensions	{ bottom: number ; height: number ; left: number ; right: number ; top: number ; width: number }	-
monitorDimensions.bottom	number	-
monitorDimensions.height	number	-
monitorDimensions.left	number	-
monitorDimensions.right	number	-
monitorDimensions.top	number	-
monitorDimensions.width	number	-
opacity	number	-
options	any	-
plugin	Record<string, any>[]	-
plugins	boolean	-
preloadScripts	{ state?: "succeeded" ; url: string }[]	-
resizable	boolean	-
resize	boolean	-
resizeRegion	{ bottomRightCorner: number ; sides: { bottom: number ; left: number ; right: number ; top: number } ; size: number }	-
resizeRegion.bottomRightCorner	number	-
resizeRegion.sides	{ bottom: number ; left: number ; right: number ; top: number }	-
resizeRegion.sides.bottom	number	-
resizeRegion.sides.left	number	-
resizeRegion.sides.right	number	-
resizeRegion.sides.top	number	-
resizeRegion.size	number	-
right	number | string	-
saveWindowState	boolean	-
shadow	boolean	-
show	boolean	-
showTaskbarIcon	boolean	-
skipTaskbar	boolean	-
smallWindow	boolean	-
spawnedByWorkspaceService	boolean	-
state	string	-
taskbarIcon	""	-
taskbarIconGroup	string	-
title	string	-
top	number | string	-
transparent	boolean	-
type	string	-
url	string	-
uuid	string	-
waitForPageLoad	boolean	-
webPreferences	{ disableInitialReload: boolean ; nodeIntegration: boolean ; plugins: boolean }	-
webPreferences.disableInitialReload	boolean	-
webPreferences.nodeIntegration	boolean	-
webPreferences.plugins	boolean	-
webSecurity	boolean	-
width	number | string	-
windowIdentifier	{ name: string ; uuid: string ; windowName: string ; windowType: "StackedWindow" | "WebWindow" | "NativeWindow" | "FinsembleNativeWindow" }	-
windowIdentifier.name	string	-
windowIdentifier.uuid	string	-
windowIdentifier.windowName	string	-
windowIdentifier.windowType	"StackedWindow" | "WebWindow" | "NativeWindow" | "FinsembleNativeWindow"	-
windowType	"StackedWindow" | "WebWindow" | "NativeWindow" | "FinsembleNativeWindow"	-
x	number	-
y	number	-

---

PositionTypes

Ƭ PositionTypes: "available" | "monitor" | "relative" | "virtual" | "absolute"

All the possible position types that can be used to define the spawn viewport

"available" Positioned according to the coordinates available on the monitor itself, less space claimed by the operating system (such as the windows toolbar). For instance, bottom:0 will place the new component with its bottom flush against the windows toolbar.

"monitor" Positioned according to the absolute size of the monitor. For instance, top:0 will place the component overlapping the toolbar.

"relative" Positioned relative to the relativeWindow. For instance, left:0;top:0 will join the top left corner of the new component with the top left corner of the relative window.

"virtual" Positioned against coordinates on the virtual screen. The virtual screen is the full viewing area of all monitors combined into a single theoretical monitor.

"absolute" Positioned using native operating system coordinates. Only available with showWindow, not with spawn.

---

ShowWindowParams

Ƭ ShowWindowParams: any

---

SpawnOptions

Ƭ SpawnOptions: Record<string, any>

---

SpawnParams

Ƭ SpawnParams: Object

The parameters passed to Launcher.Spawn.

If properties are duplicated between the the app configuration those passed as parameters to spawn, parameters passed to spawn will generally take precedence.

Type declaration

Name	Type	Description
addToWorkspace?	boolean	Defaults to false. Whether to add the new component to the workspace. The addToWorkspace config value set at the component level overwrites this value.
affinity?	string | boolean	Process affinity setting that allows render threads for web windows (served from the same 'site') to be grouped together to save memory. Group render process together thoughtfully by setting the same string value or disable rendering process grouping by setting false.
alias?	string	Used when windowType is "native" or "assimilation". Specifies the alias of a bundled asset.
arguments?	any	Used when windowType is "native" or "assimilation". Specifies the arguments to be sent to the application. This is used in conjunction with path. Arguments should be separated by spaces: --arg1 foo --arg2 bar except when params.argumentsAsQueryString is true, in which case set this parameter to be single string in URI format: arg=1&arg=2"
argumentsAsQueryString?	boolean	For native applications launched by URI: 1) the string is passed as the "arguments" parameter if appended as a query string; and 2) the automatically generated arguments described in "path" are appended to the query string
bottom?	number | string	A pixel value representing the distance from the bottom edge of the viewport as defined by "position". You can also use the percentage value, which represents the percentage distance from the bottom edge of the viewport relative to the viewport's height.
canGroup?	boolean	Whether the component can group with other windows.
claimMonitorSpace?	boolean	For use with permanent toolbars. The available space for other components will be reduced by the amount of space covered by the newly spawned component. Users will be prevented from moving windows to a position that covers the claimed space.
closeComponentsTogether?	boolean	Defaults to false. Whether to close all components within a launchGroup component at the same time.
component?	any	Type of component to spawn.
compositeComponentData?	CompositeComponentData	-
connectId?	string	-
data?	any	Optional data to pass to the opening window. If set, then the spawned window can use WindowClient#getSpawnData to retrieve the data.
dockOnSpawn?	boolean	deprecated Please use groupOnSpawn instead. If true, will automatically group the window with the "relative" window (grouping to the parent window unless specified in params.relativeWindow). Note that you must also position the window in a valid position for grouping, for example, by setting the "left" or "top" parameters to "adjacent".
dockable?	["top", "bottom"] | ["bottom", "top"] | ["top"] | ["bottom"]	An array of parts of the monitor that the component can dock to. Valid values are top and bottom.
docked?	"top" | "bottom"	Which part of the monitor that the component will dock to on spawn. Valid options are top and bottom. Only valid if combined with the dockable property.
dockedHeight?	number	Currently, components can only dock to the full width of the monitor. This parameter determines what height the component will be when docked to a monitor.
env?	any	Sets environment variables for a spawned native application. Create a map (JSON) object of names to values. This is only available when running Assimilation.
ephemeral?	boolean	Indicates that this window is ephemeral. An ephemeral window is a dialog, menu, or other window that is temporarily displayed but usually hidden. Ephemeral windows automatically have the following settings assigned: resizable: false, showTaskbarIcon: false, alwaysOnTop: true. Note: Use options:{autoShow: false} to prevent an ephemeral widow from showing automatically.
forceOntoMonitor?	boolean | string	If true, will attempt to make the window have no edges outside the monitor boundary.
frame?	boolean	-
groupName?	string	Optional group name. Adds windows to a group (unrelated to docking or linking) that is used for window management functions. If the group does not exist it will be created.
groupOnSpawn?	boolean	Groups the window to the relativeWindow on spawn. Note that you must also position the window in a valid position for grouping, for example, by setting the "left" or "top" parameters to "adjacent".
height?	number | string	A pixel or percentage value.
launchGroupComponentData?	LaunchGroupComponentData	-
launchingWindow?	WindowIdentifier	Where the spawn request is coming from.
left?	number | string	A pixel value representing the distance from the left edge of the viewport as defined by "position". You can also use the percentage value, which represents the percentage distance from the left edge of the viewport relative to the viewport's width. "adjacent" will snap to the right edge of the spawning or relative window. "center" will center the window If neither left nor right are provided, then the default will be to stagger the window based on the last spawned window.
maxHeight?	number	Maximum height window can be resized to.
maxWidth?	number	Maximum width window can be resized to.
minHeight?	number	Minimum height window can be resized to.
minWidth?	number	Minimum width window can be resized to.
monitor?	MonitorChoice	Which monitor to place the new window. "mine" - Place the window on the same monitor as the calling window. Integer value from 0-n (0 being the primary monitor). "primary" indicates the user's primary monitor. "all" - Put a copy of the component on all monitors.
name?	string	Name to give the component. If not provided, a random one will be generated.
native?	boolean	deprecated Please use windowType instead. Optional native application to launch with Assimilation service. Overrides what is passed in "component".
options?	SpawnOptions	Properties to merge with the default windowDescriptor. Any value set here will be sent directly to the WebWindow, and will override the effect of relevant parameters to spawn(). By default, all Finsemble windows are frameless. FEA Permissions and window properties (such as always on top) are provided here.
path?	string	Used when windowType is "native" or "assimilation". Specifies the path to the application. The path can be: The name of an exe that is on the system path (e.g., notepad.exe). The full path to an executable on the user's machine (e.g., C:\Program Files\app.exe). A system installed URI (e.g., myuri://advancedapplauncher). When windowType is "native" then additional arguments will be automatically appended to the path or the URI. These arguments can be captured by the native application in order to tie it to Finsemble's window tracking. When building an application with finsemble.dll, this is handled automatically. Those arguments are: uuid - A generated UUID that uniquely identifies this window. left - The x coordinate of the new window top - The y coordinate of the new window width - The width of the new window height - The height of the new window finsembleWindowName - The name of the window in the Finsemble config componentType - The component type in the Finsemble config A common troublesome problem is when a native application needs to be launched from an intermediary application (such as a launcher or batch script). That intermediary application can pass these parameters which will allow the final application to connect back to Finsemble.
position?	PositionTypes	Defines a "viewport" for the spawn, with one of the Position Types: available - Positioned according to the coordinates available on the monitor itself, less space claimed by the operating system (such as the windows toolbar). For instance, bottom:0 will place the new component with its bottom flush against the windows toolbar. monitor - Positioned according to the absolute size of the monitor. For instance, top:0 will place the component overlapping the toolbar. relative - Positioned relative to the relativeWindow. For instance, left:0;top:0 will join the top left corner of the new component with the top left corner of the relative window. virtual - Deprecated. Positioned against coordinates on the virtual screen. The virtual screen is the full viewing area of all monitors combined into a single theoretical monitor. absolute - Positioned using native operating system coordinates. Only available with showWindow, not with spawn.
relativeWindow?	WindowIdentifier	The window to use when calculating any relative launches. If not set then the window from which spawn() was called.
right?	number | string	A pixel value representing the distance from the right edge of the viewport as defined by "position". You can also use the percentage value, which represents the percentage distance from the right edge of the viewport relative to the viewport's width.
setBoundsOnly?	boolean	If true, then visibility of window will not be changed. In otherwords, a hidden window will not be made visible.
slave?	boolean	If true then the new window will act as a slave to the relativeWindow (or the launching window if relativeWindow is not specified). Slave windows will automatically close when their parent windows close.
spawnedByWorkspaceService?	boolean
staggerPixels?	number	Number of pixels to stagger (default when neither left, right, top or bottom are set).
toSpawn?	[object]	An array of objects defining the components to spawn. Each entry may either represent a single component in the form {componentType, spawnOptions} or a tabbed window of components in the form {components, spawnOptions}, where components is an array of single component definitions (again in the form {componentType, spawnOptions}). Most arguments that are normally passed to LauncherClient.spawn are supported, although positioning will be interpreted as relative to the group's coordinates and dimensions for single components and ignored for tabbed components (as these use the position specified in the group's spawnOptions). Note - This param will only be taken into account if the windowType param is 'composite' OR 'launchGroup'.
top?	number | string	A pixel value representing the distance from the top edge of the viewport as defined by "position". You can also use the percentage value, which represents the percentage distance from the top edge of the viewport relative to the viewport's height.
url?	string	Optional url to launch. Overrides what is passed in "component".
width?	number | string	A pixel or percentage value.
windowIdentifier?	WindowIdentifier	Component instances are often referred to in Finsemble API calls via a windowIdentifier. A windowIdentifier is an object with both windowName and componentType properties.
windowInterop?	WindowInterop	-
windowTitleBarUrl?	string	-
windowType?	WindowTypes	Optional. Describes which type of component to spawn. WebWindow - A normal HTML window. assimilation - A window that is managed by the Finsemble assimilation process (usually a native window without source code access). Requires "path" to be specified, which may be the name of an executable on the system path, a system file path or system installed URI. native - A native window that has implemented finsemble.dll. Requires "path" to be specified. application - A standalone application that will be launched in its own browser process (giving it dedicated CPU and memory). This can also point to a standalone web application (such as from a third party). composite - DEPRECATED - Use launchGroup. launchGroup - A component composed of other components, usually group together. See toSpawn property.

---

WindowBounds

Ƭ WindowBounds: Object

Type declaration

Name	Type
bottom?	number
height	number
left	number
right?	number
top	number
width	number

---

WindowDescriptor

Ƭ WindowDescriptor: Object

Used to define the parameters for creating a Window.

Type declaration

Name	Type	Description
affinity?	string | boolean	Process affinity setting that allows render threads for web windows (served from the same 'site') to be grouped together to save memory. Group render process together thoughtfully by setting the same string value or disable rendering process grouping by setting false.
allowAutoArrange?	boolean	-
alwaysOnTop?	boolean	-
alwaysOnTopLevel?	string | null	-
autoShow?	boolean	-
backgroundColor?	string	-
bottom?	number	-
bounds?	{ bottom: number ; height: number ; left: number ; right: number ; top: number ; width: number }	-
bounds.bottom	number	-
bounds.height	number	-
bounds.left	number	-
bounds.right	number	-
bounds.top	number	-
bounds.width	number	-
canGroup?	boolean	-
childWindowOptions?	{ component?: any ; foreign?: any ; window?: any }	-
childWindowOptions.component?	any	-
childWindowOptions.foreign?	any	-
childWindowOptions.window?	any	-
claimMonitorSpace?	boolean	-
componentType?	string	The name of the component in this window. E.g "Welcome Component", "StackedWindow", etc.
customData?	{ appDConfig?: any ; component?: any ; foreign?: any ; interop?: any ; isAnApp?: boolean ; manifest?: any ; monitorDimensions?: any ; spawnData?: any ; window?: any }	-
customData.appDConfig?	any	-
customData.component?	any	-
customData.foreign?	any	-
customData.interop?	any	-
customData.isAnApp?	boolean	-
customData.manifest?	any	-
customData.monitorDimensions?	any	-
customData.spawnData?	any	-
customData.window?	any	-
defaultBottom?	number	-
defaultHeight?	number	-
defaultLeft?	number	-
defaultRight?	number	-
defaultTop?	number	-
defaultWidth?	number	-
execJSWhitelist?	string[]	-
external?	boolean	-
height?	number	-
hideTitleBar?	boolean	-
icons?	AppIcons	-
launchGroupComponentData?	LaunchGroupComponentData	-
left?	number	-
manifest?	{}	-
maxHeight?	number	-
maxWidth?	number	-
minHeight?	number	-
minWidth?	number	-
monitorInfo?	any	-
name?	string	-
opacity?	number	-
path?	string	-
permissions?	{ Application?: {} ; System?: {} ; Window?: {} }	-
permissions.Application?	{}	-
permissions.System?	{}	-
permissions.Window?	{}	-
preload?	any[]	-
preloadScripts?	any[]	-
resizable?	boolean	-
right?	number	-
securityPolicy?	string	-
showTaskbarIcon?	boolean	-
top?	number	-
transparent?	boolean	-
url?	string	-
uuid?	string	-
width?	number	-
windowInterop?	WindowInterop	-
windowTitleBarUrl?	string	-
windowType?	string	-
x?	number	-
y?	number	-

---

WindowEventName

Ƭ WindowEventName: "blurred" | "bounds-change-start" | "startedMoving" | "bounds-changing" | "bounds-change-request" | "bounds-change-end" | "bounds-changed" | "system-bounds-changed" | "system-maximized" | "system-restored" | "crashed" | "system-closed" | "stoppedMoving" | "broughtToFront" | "clicked" | "close-requested" | "closed" | "alwaysOnTop" | "component-state-changed" | "close-complete" | "created" | "focused" | "hide-requested" | "hidden" | "maximize-requested" | "maximized" | "minimize-requested" | "minimized" | "parent-set" | "parent-unset" | "ready" | "restore-requested" | "restored" | "show-requested" | "shown" | "title-changed" | "wrap-state-changed"

---

WindowIdentifier

Ƭ WindowIdentifier: Object

An object that includes all the potential identifications for a window. For instance, one can try and obtain a reference for a window if some of these values are known.

Type declaration

Name	Type	Description
componentType?	string | null	The type of component
uuid?	string	uuid is deprecated
waitForReady?	boolean	-
windowName	string	The name of the physical HTML window, or a reference to a native window that was launched with Assimilation service
windowType?	string	-

---

WindowInterop

Ƭ WindowInterop: Object

Type declaration

Name	Type
connectId?	ConnectId
grandParent?	WindowIdentifier
launchGroupId?	string
parent?	WindowIdentifier

---

WindowLocator

Ƭ WindowLocator: { windowName: string } | { componentType: string ; uuid?: string }

---

WindowTypes

Ƭ WindowTypes: "WebWindow" | "NativeWindow" | "assimilation" | "assimilated" | "native" | "FinsembleNativeWindow" | "application" | "WebApplication" | "StackedWindow" | "composite" | "launchGroup" | "Citrix"

All the possible window types, including their aliases used in config.

---

WrapState

Ƭ WrapState: "created" | "initializing" | "ready" | "reloading" | "closing" | "closed"