Class: Window

Window

A basic window that wraps a native HTML window. Provides more fine-grained control over the window state such as the ability to minimize, maximize, restore, etc. By default a window does not show upon instantiation; instead the window's show() method must be invoked manually. The new window appears in the same process as the parent window. It has the ability to listen for window specific events.

Methods

(static) create(options) → {Promise.<_Window>}

Creates a new Window.

Parameters:
Name Type Description
options Window~options

Window creation options
Tutorials:
Returns:
Type
Promise.<_Window>

(static) getCurrent() → {Promise.<_Window>}

Asynchronously returns a Window object that represents the current window

Tutorials:
Returns:
Type
Promise.<_Window>

(static) getCurrentSync() → {_Window}

Synchronously returns a Window object that represents the current window

Tutorials:
Returns:
Type
_Window

(async, static) wrap(identity) → {Promise.<_Window>}

Asynchronously returns a Window object that represents an existing window.

Parameters:
Name Type Description
identity Identity
Tutorials:
Returns:
Type
Promise.<_Window>

(static) wrapSync(identity) → {_Window}

Synchronously returns a Window object that represents an existing window.

Parameters:
Name Type Description
identity Identity
Tutorials:
Returns:
Type
_Window

addListener(eventType, listener, optionsopt) → {Promise.<this>}

Adds a listener to the end of the listeners array for the specified event.

Parameters:
Name Type Attributes Description
eventType string | symbol

The type of the event.
listener function

Called whenever an event of the specified type occurs.
options SubOptions <optional>

Option to support event timestamps.
Tutorials:
Returns:
Type
Promise.<this>

animate(transitions, options) → {Promise.<void>}

Performs the specified window transitions.

Parameters:
Name Type Description
transitions Transition

Describes the animations to perform. See the tutorial.
options TransitionOptions

Options for the animation. See the tutorial.
Tutorials:
Returns:
Type
Promise.<void>

authenticate(userName, password) → {Promise.<void>}

Provides credentials to authentication requests

Parameters:
Name Type Description
userName string

userName to provide to the authentication challenge
password string

password to provide to the authentication challenge
Tutorials:
Returns:
Type
Promise.<void>

blur() → {Promise.<void>}

Removes focus from the window.

Tutorials:
Returns:
Type
Promise.<void>

bringToFront() → {Promise.<void>}

Brings the window to the front of the window stack.

Tutorials:
Returns:
Type
Promise.<void>

capturePage(optionsopt) → {Promise.<string>}

Gets a base64 encoded image of the window or a part of it.

Parameters:
Name Type Attributes Description
options CapturePageOptions <optional>

options for capturePage call.
Tutorials:
Returns:
Type
Promise.<string>

center() → {Promise.<void>}

Centers the window on its current screen.

Tutorials:
Returns:
Type
Promise.<void>

close(forceopt) → {Promise.<void>}

closes the window application

Parameters:
Name Type Attributes Default Description
force boolean <optional>
 false

Close will be prevented from closing when force is false and ‘close-requested’ has been subscribed to for application’s main window.
Tutorials:
Returns:
Type
Promise.<void>

(async) closePopupMenu() → {Promise.<void>}

EXPERIMENTAL

Closes the window's popup menu, if one exists.

Tutorials:
Returns:
Type
Promise.<void>

disableUserMovement() → {Promise.<void>}

Prevents a user from changing a window's size/position when using the window's frame.

Tutorials:
Returns:
Type
Promise.<void>

(async) dispatchPopupResult(data) → {Promise.<void>}

Dispatch a result to the caller of showPopupWindow. If this window isn't currently being shown as a popup, this call will silently fail.

Parameters:
Name Type Description
data *

Serializable data to send to the caller window.
Tutorials:
Returns:
Type
Promise.<void>

enableUserMovement() → {Promise.<void>}

Re-enables user changes to a window's size/position when using the window's frame.

Tutorials:
Returns:
Type
Promise.<void>

executeJavaScript(code) → {Promise.<void>}

Executes Javascript on the window, restricted to windows you own or windows owned by applications you have created.

Parameters:
Name Type Description
code string

JavaScript code to be executed on the window.
Tutorials:
Returns:
Type
Promise.<void>

findInPage(searchTerm, options) → {Promise.<number>}

Find and highlight text on a page.

Parameters:
Name Type Description
searchTerm string

Term to find in page
options FindInPageOptions

Search options
Tutorials:
Returns:
Type
Promise.<number>

flash() → {Promise.<void>}

Flashes the window’s frame and taskbar icon until stopFlashing is called or until a focus event is fired.

Tutorials:
Returns:
Type
Promise.<void>

focus() → {Promise.<void>}

Gives focus to the window.

Tutorials:
Fires:
  • event:focused
Returns:
Type
Promise.<void>

getAllFrames() → {Promise.<Array.<FrameInfo>>}

Retrieves an array of frame info objects representing the main frame and any iframes that are currently on the page.

Tutorials:
Returns:
Type
Promise.<Array.<FrameInfo>>

getBounds() → {Promise.<Bounds>}

Gets the current bounds (top, bottom, right, left, width, height) of the window.

Tutorials:
Returns:
Type
Promise.<Bounds>

(async) getCurrentViews() → {Promise.Array.<View>}

EXPERIMENTAL

Retrieves window's attached views.

Tutorials:
Returns:
Type
Promise.Array.<View>

getInfo() → {Promise.<WindowInfo>}

Gets an information object for the window.

Tutorials:
Returns:
Type
Promise.<WindowInfo>

(async) getLayout() → {Promise.<Layout>}

EXPERIMENTAL

Retrieves the window's Layout

Tutorials:
Returns:
Type
Promise.<Layout>

getNativeId() → {Promise.<string>}

Returns the native OS level Id. In Windows, it will return the Windows handle.

Tutorials:
Returns:
Type
Promise.<string>

getOptions() → {Promise.<any>}

Gets the current settings of the window.

Tutorials:
Returns:
Type
Promise.<any>

getParentApplication() → {Promise.<Application>}

Gets the parent application.

Tutorials:
Returns:
Type
Promise.<Application>

getParentWindow() → {Promise.<_Window>}

Gets the parent window.

Tutorials:
Returns:
Type
Promise.<_Window>

getPrinters() → {Promise.Array.<PrinterInfo>}

Returns an array with all system printers

Deprecated:
  • use System.getPrinters instead
Tutorials:
Returns:
Type
Promise.Array.<PrinterInfo>

getProcessInfo() → {Promise.<EntityProcessDetails>}

Retrieves the process information associated with a window.

Tutorials:
Returns:
Type
Promise.<EntityProcessDetails>

getSharedWorkers() → {Promise.Array.<SharedWorkerInfo>}

Retrieves information on all Shared Workers.

Tutorials:
Returns:
Type
Promise.Array.<SharedWorkerInfo>

(async) getSnapshot(areaopt) → {Promise.<string>}

DEPRECATED - please use Window.capturePage. Gets a base64 encoded PNG image of the window or just part a of it.

Parameters:
Name Type Attributes Description
area Area <optional>

The area of the window to be captured. Omitting it will capture the whole visible window.
Tutorials:
Returns:
Type
Promise.<string>

getState() → {Promise.<string>}

Gets the current state ("minimized", "maximized", or "normal") of the window.

Tutorials:
Returns:
Type
Promise.<string>

getWebWindow() → {object}

Previously called getNativeWindow. Returns the Window Object that represents the web context of the target window. This is the same object that you would get from calling window.open() in a standard web context. The target window needs to be in the same application as the requesting window as well as comply with same-origin policy requirements.

Tutorials:
Returns:
Type
object

getZoomLevel() → {Promise.<number>}

Returns the zoom level of the window.

Tutorials:
Returns:
Type
Promise.<number>

hide() → {Promise.<void>}

Hides the window.

Tutorials:
Returns:
Type
Promise.<void>

inspectServiceWorker() → {Promise.<void>}

Opens the developer tools for the service worker context.

Tutorials:
Returns:
Type
Promise.<void>

inspectSharedWorker() → {Promise.<void>}

Opens the developer tools for the shared worker context.

Tutorials:
Returns:
Type
Promise.<void>

inspectSharedWorkerById(workerId) → {Promise.<void>}

Inspects the shared worker based on its ID.

Parameters:
Name Type Description
workerId string

The id of the shared worker.
Tutorials:
Returns:
Type
Promise.<void>

isMainWindow() → {boolean}

Determines if the window is a main window.

Tutorials:
Returns:
Type
boolean

isShowing() → {Promise.<boolean>}

Determines if the window is currently showing.

Tutorials:
Returns:
Type
Promise.<boolean>

maximize() → {Promise.<void>}

Maximizes the window

Tutorials:
Returns:
Type
Promise.<void>

minimize() → {Promise.<void>}

Minimizes the window.

Tutorials:
Returns:
Type
Promise.<void>

moveBy(deltaLeft, deltaTop) → {Promise.<void>}

Moves the window by a specified amount.

Parameters:
Name Type Description
deltaLeft number

The change in the left position of the window
deltaTop number

The change in the top position of the window
Tutorials:
Returns:
Type
Promise.<void>

moveTo(left, top) → {Promise.<void>}

Moves the window to a specified location.

Parameters:
Name Type Description
left number

The left position of the window
top number

The top position of the window
Tutorials:
Returns:
Type
Promise.<void>

Navigates the window to a specified URL. The url must contain the protocol prefix such as http:// or https://.

Parameters:
Name Type Description
url string

The URL to navigate the window to.
Tutorials:
Returns:
Type
Promise.<void>

Navigates the window back one page.

Tutorials:
Returns:
Type
Promise.<void>

Navigates the window forward one page.

Tutorials:
Returns:
Type
Promise.<void>

on(eventType, listener, optionsopt) → {Promise.<this>}

Adds a listener to the end of the listeners array for the specified event.

Parameters:
Name Type Attributes Description
eventType string | symbol

The type of the event.
listener function

Called whenever an event of the specified type occurs.
options SubOptions <optional>

Option to support event timestamps.
Tutorials:
Returns:
Type
Promise.<this>

once(eventType, listener, optionsopt) → {Promise.<this>}

Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.

Parameters:
Name Type Attributes Description
eventType string | symbol

The type of the event.
listener function

The callback function.
options SubOptions <optional>

Option to support event timestamps.
Tutorials:
Returns:
Type
Promise.<this>

prependListener(eventType, listener, optionsopt) → {Promise.<this>}

Adds a listener to the beginning of the listeners array for the specified event.

Parameters:
Name Type Attributes Description
eventType string | symbol

The type of the event.
listener function

The callback function.
options SubOptions <optional>

Option to support event timestamps.
Tutorials:
Returns:
Type
Promise.<this>

prependOnceListener(eventType, listener, optionsopt) → {Promise.<this>}

Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed. The listener is added to the beginning of the listeners array.

Parameters:
Name Type Attributes Description
eventType string | symbol

The type of the event.
listener function

The callback function.
options SubOptions <optional>

Option to support event timestamps.
Tutorials:
Returns:
Type
Promise.<this>

print(optionsopt) → {Promise.<void>}

Prints the window's web page

Parameters:
Name Type Attributes Description
options PrintOptions <optional>

Printer Options
Tutorials:
Returns:
Type
Promise.<void>

reload() → {Promise.<void>}

Reloads the window current page

Tutorials:
Returns:
Type
Promise.<void>

removeAllListeners(eventTypeopt) → {Promise.<this>}

Removes all listeners, or those of the specified event.

Parameters:
Name Type Attributes Description
eventType string | symbol <optional>

The type of the event.
Tutorials:
Returns:
Type
Promise.<this>

removeListener(eventType, listener, optionsopt) → {Promise.<this>}

Remove a listener from the listener array for the specified event. Caution: Calling this method changes the array indices in the listener array behind the listener.

Parameters:
Name Type Attributes Description
eventType string | symbol

The type of the event.
listener function

The callback function.
options SubOptions <optional>

Option to support event timestamps.
Tutorials:
Returns:
Type
Promise.<this>

resizeBy(deltaWidth, deltaHeight, anchor) → {Promise.<void>}

Resizes the window by a specified amount.

Parameters:
Name Type Description
deltaWidth number

The change in the width of the window
deltaHeight number

The change in the height of the window
anchor AnchorType

Specifies a corner to remain fixed during the resize. Can take the values: "top-left", "top-right", "bottom-left", or "bottom-right". If undefined, the default is "top-left"
Tutorials:
Returns:
Type
Promise.<void>

resizeTo(width, height, anchor) → {Promise.<void>}

Resizes the window to the specified dimensions.

Parameters:
Name Type Description
width number

The change in the width of the window
height number

The change in the height of the window
anchor AnchorType

Specifies a corner to remain fixed during the resize. Can take the values: "top-left", "top-right", "bottom-left", or "bottom-right". If undefined, the default is "top-left"
Tutorials:
Returns:
Type
Promise.<void>

restore() → {Promise.<void>}

Restores the window to its normal state (i.e., unminimized, unmaximized).

Tutorials:
Returns:
Type
Promise.<void>

setAsForeground() → {Promise.<void>}

Will bring the window to the front of the entire stack and give it focus.

Tutorials:
Returns:
Type
Promise.<void>

setBounds() → {Promise.<void>}

Sets the window's size and position.

Properties:
Name Type Description
bounds Bounds

This is a * @type {string} name - name of the window.object that holds the propertys of
Tutorials:
Returns:
Type
Promise.<void>

setZoomLevel(level) → {Promise.<void>}

Sets the zoom level of the window.

Parameters:
Name Type Description
level number

The zoom level
Tutorials:
Returns:
Type
Promise.<void>

show(forceopt) → {Promise.<void>}

Shows the window if it is hidden.

Parameters:
Name Type Attributes Default Description
force boolean <optional>
 false

Show will be prevented from showing when force is false and ‘show-requested’ has been subscribed to for application’s main window.
Tutorials:
Returns:
Type
Promise.<void>

showAt(left, top, force) → {Promise.<void>}

Shows the window if it is hidden at the specified location. If the toggle parameter is set to true, the window will alternate between showing and hiding.

Parameters:
Name Type Default Description
left number

The left position of the window
top number

The right position of the window
force boolean false

Show will be prevented from closing when force is false and ‘show-requested’ has been subscribed to for application’s main window
Tutorials:
Returns:
Type
Promise.<void>

(async) showPopupMenu(options) → {Promise.<MenuResult>}

EXPERIMENTAL

Shows a menu on the window. Returns a promise that resolves when the user has either selected an item or closed the menu. (This may take longer than other apis). Resolves to an object with {result: 'clicked', data } where data is the data field on the menu item clicked, or {result 'closed'} when the user doesn't select anything. Calling this method will close previously opened menus.

Parameters:
Name Type Description
options ShowPopupMenuOptions
Tutorials:
Returns:
Type
Promise.<MenuResult>

showPopupWindow(options) → {Promise.<PopupResult>}

Shows a popup window. If this window currently has a popup open, closes it.

Parameters:
Name Type Description
options PopupOptions
Tutorials:
Returns:
Type
Promise.<PopupResult>

stopFindInPage(action) → {Promise.<void>}

Stops any findInPage call with the provided action.

Parameters:
Name Type Description
action string

Action to execute when stopping a find in page:
"clearSelection" - Clear the selection.
"keepSelection" - Translate the selection into a normal selection.
"activateSelection" - Focus and click the selection node.
Tutorials:
Returns:
Type
Promise.<void>

stopFlashing() → {Promise.<void>}

Stops the taskbar icon from flashing.

Tutorials:
Returns:
Type
Promise.<void>

stopNavigation() → {Promise.<void>}

Stops any current navigation the window is performing.

Tutorials:
Returns:
Type
Promise.<void>

updateOptions(options) → {Promise.<void>}

Updates the window using the passed options. Values that are objects are deep-merged, overwriting only the values that are provided.

Parameters:
Name Type Description
options *

Changes a window's options that were defined upon creation. See tutorial
Tutorials:
Returns:
Type
Promise.<void>

Type Definitions

options

Window creation options.

This is the options object required by Window.create.

Note that name is the only required property — albeit the url property is usually provided as well (defaults to "about:blank" when omitted).

This jsdoc typedef mirrors the WindowOptions TypeScript interface in @types/openfin.

Type:
  • object
Properties:
Name Type Attributes Default Description
accelerator object <optional>

Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.

Properties
Name Type Attributes Default Description
devtools boolean <optional>
 false

If true, enables the devtools keyboard shortcut:
Ctrl + Shift + I (Toggles Devtools)
reload boolean <optional>
 false

If true, enables the reload keyboard shortcuts:
Ctrl + R (Windows)
F5 (Windows)
Command + R (Mac)
reloadIgnoringCache boolean <optional>
 false

If true, enables the reload-from-source keyboard shortcuts:
Ctrl + Shift + R (Windows)
Shift + F5 (Windows)
Command + Shift + R (Mac)
zoom boolean <optional>
 false

NOTE: It is not recommended to set this value to true for Windows in Platforms as that may lead to unexpected visual shifts in layout. If true, enables the zoom keyboard shortcuts:
Ctrl + + (Zoom In)
Ctrl + Shift + + (Zoom In)
Ctrl + NumPad+ (Zoom In)
Ctrl + - (Zoom Out)
Ctrl + Shift + - (Zoom Out)
Ctrl + NumPad- (Zoom Out)
Ctrl + Scroll (Zoom In & Out)
Ctrl + 0 (Restore to 100%)
alphaMask object <optional>

Experimental. Updatable.
alphaMask turns anything of matching RGB value transparent.
Caveats:

  • runtime key --disable-gpu is required. Note: Unclear behavior on remote Desktop support
  • User cannot click-through transparent regions
  • Not supported on Mac
  • Windows Aero must be enabled
  • Won't make visual sense on Pixel-pushed environments such as Citrix
  • Not supported on rounded corner windows
Properties
Name Type Attributes Default Description
red number <optional>
 -1

0-255
green number <optional>
 -1

0-255
blue number <optional>
 -1

0-255
alwaysOnTop boolean <optional>
 false

Updatable. A flag to always position the window at the top of the window stack.
api object <optional>

Configurations for API injection.

Properties
Name Type Attributes Description
iframe object <optional>

Configure if the the API should be injected into iframes based on domain.

Properties
Name Type Attributes Default Description
crossOriginInjection boolean <optional>
 false

Controls if the fin API object is present for cross origin iframes.
sameOriginInjection boolean <optional>
 true

Controls if the fin API object is present for same origin iframes.
applicationIcon string <optional>
 ""

Deprecated - use icon instead.
aspectRatio number <optional>
 0

Updatable. The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero, an aspect ratio will not be enforced.
autoShow boolean <optional>
 true

A flag to automatically show the window when it is created.
backgroundColor string <optional>
 "#FFF"

The window’s backfill color as a hexadecimal value. Not to be confused with the content background color (document.body.style.backgroundColor), this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed areas when growing a window. Setting this value to the anticipated content background color can help improve user experience. Default is white.
contentCreation object <optional>

Apply rules that determine how user interaction (window.open and links) creates content.

Properties
Name Type Attributes Default Description
rules Array.<ContentCreationRule> <optional>
 []

List of content creation rules.
contentNavigation object <optional>

Restrict navigation to URLs that match a whitelisted pattern. In the lack of a whitelist, navigation to URLs that match a blacklisted pattern would be prohibited. See here for more details.

Properties
Name Type Attributes Default Description
whitelist Array.<string> <optional>
 []

List of whitelisted URLs.
blacklist Array.<string> <optional>
 []

List of blacklisted URLs.
contentRedirect object <optional>

Restrict redirects to URLs that match a whitelisted pattern. In the lack of a whitelist, redirects to URLs that match a blacklisted pattern would be prohibited. See here for more details.

Properties
Name Type Attributes Default Description
whitelist Array.<string> <optional>
 []

List of whitelisted URLs.
blacklist Array.<string> <optional>
 []

List of blacklisted URLs.
contextMenu boolean <optional>
 true

Updatable. A flag to show the context menu when right-clicking on a window. Gives access to the devtools for the window.
contextMenuSettings object <optional>

Updatable. Deprecated - superseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax. Configure the context menu when right-clicking on a window.

Properties
Name Type Attributes Default Description
enable boolean <optional>
 true

Should the context menu display on right click.
devtools boolean <optional>
 true

Should the context menu contain a button for opening devtools.
reload boolean <optional>
 true

Should the context menu contain a button for reloading the page.
contextMenuOptions object <optional>

Updatable. Configure the context menu when right-clicking on a window. Supported menu items: 'separator' 'cut' 'copy' 'paste' 'spellCheck' 'inspect' 'reload' 'navigateForward' 'navigateBack' 'print'

Properties
Name Type Attributes Default Description
enabled boolean <optional>
 true

Should the context menu display on right click.
contextMenuSettings.template Array.<string> <optional>
 []

List of context menu items to display on right-click.
cornerRounding object <optional>

Updatable. Defines and applies rounded corners for a frameless window. NOTE: On macOS corner is not ellipse but circle rounded by the average of height and width.

Properties
Name Type Attributes Default Description
height number <optional>
 0

The height in pixels.
width number <optional>
 0

The width in pixels.
customContext any <optional>
 ""

Updatable. Inheritable. A field that the user can use to attach serializable data that will be saved when Platform.getSnapshot is called. If a window in a Platform is trying to update or retrieve its own context, it can use the Platform.setWindowContext and Platform.getWindowContext calls. When omitted, inherits from the parent application. As opposed to customData, this is meant for frequent updates and sharing with other contexts. Example
customData any <optional>
 ""

Updatable. Inheritable. A field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.
customRequestHeaders Array.<object> <optional>

Defines list of custom headers for requests sent by the window.

Properties
Name Type Attributes Default Description
urlPatterns Array.<string> <optional>
 []

The URL patterns for which the headers will be applied
headers Array.<object> <optional>
 []

Objects representing headers and their values, where the object key is the name of header and value at key is the value of the header
closeOnLastViewRemoved boolean <optional>
 true

Experimental. Updatable. Toggling off would keep the Window alive even if all its Views were closed. This is meant for advanced users and should be used with caution. Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail. Use layout.replace to create a fresh Layout instance in case you want to populate it with Views again. ** note ** - This option is ignored in non-Platforms apps.
defaultCentered boolean <optional>
 false

Centers the window in the primary monitor. This option overrides defaultLeft and defaultTop. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value. NOTE: On macOS defaultCenter is somewhat above center vertically.
defaultHeight number <optional>
 500

The default height of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.
defaultLeft number <optional>
 100

The default left position of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.
defaultTop number <optional>
 100

The default top position of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.
defaultWidth number <optional>
 800

The default width of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.
includeInSnapshots boolean <optional>
 true

Updatable. When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
frame boolean <optional>
 true

Updatable. A flag to show the frame.
hotkeys Array.<object> <optional>
 []

Updatable. Defines the list of hotkeys that will be emitted as a hotkey event on the window. For usage example see example. Within Platform, OpenFin also implements a set of pre-defined actions called keyboard commands that can be assigned to a specific hotkey in the platform manifest.

Properties
Name Type Attributes Default Description
keys string

The key combination of the hotkey, i.e. "Ctrl+T"
preventDefault boolean <optional>
 false

Whether or not to prevent default key handling before emitting the event
icon string <optional>

Updatable. Inheritable. A URL for the icon to be shown in the window title bar and the taskbar. When omitted, inherits from the parent application._ note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
maxHeight number <optional>
 -1

Updatable. The maximum height of a window. Will default to the OS defined value if set to -1.
maximizable boolean <optional>
 true

Updatable. A flag that lets the window be maximized.
maxWidth number <optional>
 -1

Updatable. The maximum width of a window. Will default to the OS defined value if set to -1.
minHeight number <optional>
 0

Updatable. The minimum height of a window.
minimizable boolean <optional>
 true

Updatable. A flag that lets the window be minimized.
minWidth number <optional>
 0

Updatable. The minimum width of a window.
modalParentIdentity Identity <optional>

Parent identity of a modal window. It will create a modal child window when this option is set.
name string

The name of the window.
opacity number <optional>
 1.0

Updatable. A flag that specifies how transparent the window will be. Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there. This value is clamped between 0.0 and 1.0.
preloadScripts Array.<preloadScript> <optional>

Inheritable A list of scripts that are eval'ed before other scripts in the page. When omitted, inherits from the parent application.
processAffinity string <optional>

A string to attempt to group renderers together. Will only be used if pages are on the same origin.
resizable boolean <optional>
 true

Updatable. A flag to allow the user to resize the window.
resizeRegion object <optional>

Updatable. Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.

Properties
Name Type Attributes Default Description
bottomRightCorner number <optional>
 9

The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
size number <optional>
 7

The size in pixels.
sides object <optional>
 {top:true,right:true,bottom:true,left:true}

Sides that a window can be resized from.
saveWindowState boolean <optional>
 true

A flag to cache the location of the window. ** note ** - This option is ignored in Platforms as it would cause inconsistent applySnapshot behavior.
ignoreSavedWindowState boolean <optional>

A flag to ignore previously cached state of the window. It defaults the opposite value of saveWindowState to maintain backwards compatibility.
shadow boolean <optional>
 false

A flag to display a shadow on frameless windows. shadow and cornerRounding are mutually exclusive. On Windows 7, Aero theme is required.
showBackgroundImages boolean <optional>
 false

Updatable. Platforms Only. If true, will show background images in the layout when the Views are hidden. This occurs when the window is resizing or a tab is being dragged within the layout.
showTaskbarIcon boolean <optional>
 true

Updatable. Windows. A flag to show the window's icon in the taskbar.
smallWindow boolean <optional>
 false

A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height). Note: Caveats of small windows are no Aero Snap and drag to/from maximize. Windows 10: Requires maximizable to be false. Resizing with the mouse is only possible down to 38x39 px.
state string <optional>
 "normal"

The visible state of the window on creation. One of:

  • "maximized"
  • "minimized"
  • "normal"
taskbarIcon string <optional>
 string

Deprecated - use icon instead.Windows.
taskbarIconGroup string <optional>
 <application uuid>

Windows. Specify a taskbar group for the window. If omitted, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid).
url string <optional>
 "about:blank"

The URL of the window.
uuid string <optional>
 <application uuid>

The uuid of the application, unique within the set of all Applications running in OpenFin Runtime. If omitted, defaults to the uuid of the application spawning the window. If given, must match the uuid of the application spawning the window. In other words, the application's uuid is the only acceptable value, but is the default, so there's really no need to provide it.
waitForPageLoad boolean <optional>
 false

When set to true, the window will not appear until the window object's load event fires. When set to false, the window will appear immediately without waiting for content to be loaded.
viewVisibility ViewVisibility <optional>

Platform Windows Only. Controls behavior for showing views when they are being resized by the user.