Skip to main content

Interface: AdjustedSpawnParams

window.types.AdjustedSpawnParams

Hierarchy​

Properties​

addToWorkspace​

• Optional 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.

Inherited from​

SpawnParams.addToWorkspace

affinity​

• Optional 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.

Inherited from​

SpawnParams.affinity

alias​

• Optional alias: string

Used when windowType is "native" or "assimilation". Specifies the alias of a bundled asset.

Inherited from​

SpawnParams.alias

arguments​

• Optional 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"

Inherited from​

SpawnParams.arguments

argumentsAsQueryString​

• Optional 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

Inherited from​

SpawnParams.argumentsAsQueryString

bottom​

• Optional bottom: string | number

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.

Inherited from​

SpawnParams.bottom

canGroup​

• Optional canGroup: boolean

Whether the component can group with other windows.

Inherited from​

SpawnParams.canGroup

claimMonitorSpace​

• Optional 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.

Inherited from​

SpawnParams.claimMonitorSpace

closeComponentsTogether​

• Optional closeComponentsTogether: boolean

Defaults to false. Whether to close all components within a launchGroup component at the same time.

Inherited from​

SpawnParams.closeComponentsTogether

component​

• Optional component: any

Type of component to spawn.

Inherited from​

SpawnParams.component

compositeComponentData​

• Optional compositeComponentData: CompositeComponentData

Inherited from​

SpawnParams.compositeComponentData

connectId​

• Optional connectId: string

Inherited from​

SpawnParams.connectId

data​

• Optional data: any

Optional data to pass to the opening window. If set, then the spawned window can use WindowClient#getSpawnData to retrieve the data.

Inherited from​

SpawnParams.data

dockOnSpawn​

• Optional 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".

Inherited from​

SpawnParams.dockOnSpawn

dockable​

• Optional 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.

Inherited from​

SpawnParams.dockable

docked​

• Optional 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.

Inherited from​

SpawnParams.docked

dockedHeight​

• Optional 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.

Inherited from​

SpawnParams.dockedHeight

env​

• Optional 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.

Inherited from​

SpawnParams.env

ephemeral​

• Optional 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.

Inherited from​

SpawnParams.ephemeral

forceOntoMonitor​

• forceOntoMonitor: string | boolean

Overrides​

SpawnParams.forceOntoMonitor

frame​

• Optional frame: boolean

Inherited from​

SpawnParams.frame

groupName​

• Optional 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.

Inherited from​

SpawnParams.groupName

groupOnSpawn​

• Optional 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".

Inherited from​

SpawnParams.groupOnSpawn

height​

• height: string | number

Overrides​

SpawnParams.height

isInExistingGroup​

• isInExistingGroup: boolean

launchGroupComponentData​

• Optional launchGroupComponentData: LaunchGroupComponentData

Inherited from​

SpawnParams.launchGroupComponentData

launchingWindow​

• Optional Private launchingWindow: WindowIdentifier

Where the spawn request is coming from.

Inherited from​

SpawnParams.launchingWindow

left​

• Optional left: string | number

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.

Inherited from​

SpawnParams.left

maxHeight​

• Optional maxHeight: number

Maximum height window can be resized to.

Inherited from​

SpawnParams.maxHeight

maxWidth​

• Optional maxWidth: number

Maximum width window can be resized to.

Inherited from​

SpawnParams.maxWidth

minHeight​

• Optional minHeight: number

Minimum height window can be resized to.

Inherited from​

SpawnParams.minHeight

minWidth​

• Optional minWidth: number

Minimum width window can be resized to.

Inherited from​

SpawnParams.minWidth

monitor​

• Optional 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.

Inherited from​

SpawnParams.monitor

monitors​

• monitors: MonitorInfoDetail[]

name​

• Optional name: string

Name to give the component. If not provided, a random one will be generated.

Inherited from​

SpawnParams.name

native​

• Optional native: boolean

deprecated Please use windowType instead. Optional native application to launch with Assimilation service. Overrides what is passed in "component".

Inherited from​

SpawnParams.native

options​

• Optional 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.

Inherited from​

SpawnParams.options

path​

• Optional 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.

Inherited from​

SpawnParams.path

position​

• Optional 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.

Inherited from​

SpawnParams.position

previousMonitor​

• previousMonitor: MonitorInfoDetail

previousWindow​

• previousWindow: FSBLWindow

previousWindowBounds​

• previousWindowBounds: Bounds

relativeWindow​

• Optional relativeWindow: WindowIdentifier

The window to use when calculating any relative launches. If not set then the window from which spawn() was called.

Inherited from​

SpawnParams.relativeWindow

• Optional right: string | number

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.

Inherited from​

SpawnParams.right

setBoundsOnly​

• Optional setBoundsOnly: boolean

If true, then visibility of window will not be changed. In otherwords, a hidden window will not be made visible.

Inherited from​

SpawnParams.setBoundsOnly

slave​

• Optional 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.

Inherited from​

SpawnParams.slave

spawnedByWorkspaceService​

• Optional Private spawnedByWorkspaceService: boolean

Inherited from​

SpawnParams.spawnedByWorkspaceService

staggerPixels​

• Optional staggerPixels: number

Number of pixels to stagger (default when neither left, right, top or bottom are set).

Inherited from​

SpawnParams.staggerPixels

toSpawn​

• Optional 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'.

Inherited from​

SpawnParams.toSpawn

top​

• Optional top: string | number

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.

Inherited from​

SpawnParams.top

url​

• Optional url: string

Optional url to launch. Overrides what is passed in "component".

Inherited from​

SpawnParams.url

width​

• width: string | number

Overrides​

SpawnParams.width

windowIdentifier​

• Optional Private 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.

Inherited from​

SpawnParams.windowIdentifier

windowInterop​

• Optional windowInterop: WindowInterop

Inherited from​

SpawnParams.windowInterop

windowTitleBarUrl​

• Optional windowTitleBarUrl: string

Inherited from​

SpawnParams.windowTitleBarUrl

windowType​

• Optional 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.

Inherited from​

SpawnParams.windowType