Optional acceleratorEnable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
Optional alwaysfalse
Always position the window at the top of the window stack.
Optional apiConfigurations for API injection.
Optional apitrue
When set to false it will disable OpenFin Diagnostics for the app.
Optional aspect0
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.
Optional autoAutomatically show the window when it is created.
Optional autoplayAutoplay policy to apply to content in the window, can be
no-user-gesture-required, user-gesture-required,
document-user-activation-required. Defaults to no-user-gesture-required.
Optional backgroundThe 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.
Optional commandsConfiguration for keyboard commands. For details and usage, see Using Keyboard Commands.
Optional contentRestrict navigation to URLs that match an allowed pattern. In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited. See here for more details.
Optional contextSuperseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.
true
Show the context menu when right-clicking on the window. Gives access to the devtools for the window.
Optional cornerDefines 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.
Optional customA field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.
Optional customCustom headers for requests sent by the window.
Optional defaultCenters 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.
Optional defaultPlease use domainSettings instead
Optional default500
The default height of the window. When saveWindowState is true, this value will be ignored for subsequent launches
in favor of the cached value.
Optional default100
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.
Optional default100
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.
Optional defaultPlatforms Only. Default view options apply to all platform views.
Optional default800
The default width of the window. When saveWindowState is true, this value will be ignored for subsequent
launches in favor of the cached value.
Optional defaultPlatforms Only. Default window options apply to all platform windows.
Optional disablefalse
Disables IAB secure logging for the app.
Optional domainDefine the file download rules and domain-based api injection rules.
Optional enablefalse
When set to true, any beforeunload handler set on the app will fire.
Optional enablefalse
Enables the use of the Jumplists API and the 'pin to taskbar' functionality. Only relevant in Windows.
Optional frametrue
Show the window's frame.
Optional hidefalse
Hides the window instead of closing it when the close button is pressed.
Optional iconA 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.
Optional ignoreIgnores the cached state of the window.
Defaults the opposite value of saveWindowState to maintain backwards compatibility.
Optional interopConfiguration for interop broker.
Optional isOptional load'There was an error loading the application.'
An error message to display when the application (launched via manifest) fails to load.
A dialog box will be launched with the error message just before the runtime exits.
Load fails such as failed DNS resolutions or aborted connections as well as cancellations, e.g., window.stop(),
will trigger this dialog.
Client response codes such as 404 Not Found are not treated as fails as they are valid server responses.
Optional mainThe options of the main window of the application.
Optional max-1
The maximum height of a window. Will default to the OS defined value if set to -1.
Optional max1000
Platforms Only. The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed. If you do not wish for views to be pooled on your platform, set this property to zero.
Optional max-1
The maximum width of a window. Will default to the OS defined value if set to -1.
Optional maximizabletrue
Allows the window to be maximized.
Optional min0
The minimum height of the window.
Optional mintrue
The minimum width of the window.
Optional minimizabletrue
Allows the window to be minimized.
The name of the application.
This property is used for naming the application logging folder, which will be sanitized to remove
any special characters, spaces or international characters. It's also used in error messages, API
security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/
This property will be deprecated in the future.
Optional nonfalse
A flag to configure the application as non-persistent. Runtime exits when there are no persistent apps running.
Optional opacity1
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.
Optional permissionsThe permissions for secured APIs.
Optional pluginsfalse
Enable Flash at the application level.
Optional preloadScripts that run before page load. When omitted, inherits from the parent application.
Optional preventfalse
Platforms Only. Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
Note: if the Platform Provider is showing, it won't close automatically. If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
Optional resizabletrue
A flag to allow the user to resize the window.
Optional resizeDefines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
Optional savetrue
Caches the location of the window.
Note: this option is ignored in Platforms as it would cause inconsistent applySnapshot behavior.
Optional shadowfalse
Displays a shadow on frameless windows.
shadow and cornerRounding are mutually exclusive.
On Windows 7, Aero theme is required.
Optional showtrue
Shows the window's icon in the taskbar.
Optional smallfalse
Makes this window a frameless window that can 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.
Optional snapshotPlatforms Only. The snapshot to be applied.
Optional spellfalse
Enable spell check at the application level.
Optional state"normal"
The visible state of the window on creation. One of:
"maximized""minimized""normal"Optional taskbarSpecify a taskbar group for the window.
If omitted, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid).
Optional url'about:blank'
The url to the application (specifically the application's main window).
The Unique Universal Identifier (UUID) of the application, unique within the set of all other applications running in the OpenFin Runtime.
Optional waitfalse
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.
Optional webtrue
When set to false it will disable the same-origin policy for the app.
The options object required by Application.start.
The following options are required:
uuidis required in the app manifest as well as by Application.startnameis optional in the app manifest but required by Application.starturlis optional in both the app manifest Application.start and but is usually given (defaults to"about:blank"when omitted).IMPORTANT NOTE: This object inherits all the properties of the window creation options object, which will take priority over those of the same name that may be provided in
mainWindowOptions.