Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
Turns anything of matching RGB value transparent.
Caveats:
Configurations for API injection.
Automatically show the window when it is created.
Autoplay 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
.
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.
Configures how new content (e,g, from window.open
or a link) is opened.
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.
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.
Configure the context menu when right-clicking on a window.
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.
A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot} is called. If a window in a Platform is trying to update or retrieve its own context, it can use the {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext 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]{@tutorial customContext}
A field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.
Custom headers for requests sent by the window.
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.
Defines the hotkeys that will be emitted as a hotkey
event on the window. For usage example see [example]{@tutorial hotkeys}.
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.
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.
Ignores the cached state of the window.
Defaults the opposite value of saveWindowState
to maintain backwards compatibility.
Parent identity of a modal window. It will create a modal child window when this option is set.
The name of the window.
Scripts that run before page load. When omitted, inherits from the parent application.
String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
Specify a taskbar group for the window.
If omitted, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid
).
Platform Windows Only. Controls behavior for showing views when they are being resized by the user.
WorkspacePlatform specific window options. These options will not work unless a workspace platform has been initialized.
Remove the Page UI and only allow a single page in the browser window.
Must be set to true for this behavior. If this is not set to false,
then an empty pages
option will be populated with a single page.
The favicon to display on the top left of the created browser window.
When true, disables the ability to close pages, drag pages within the window, and drag pages into/out of the window. False by default.
Landing page that shows up when you add a new page from the plus button that exists in the window frame where the page selector is shown. If you do not provide a newPageUrl, then the new Page plus button will not be shown and you cannot create a new empty Page or Window.
Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip. If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and users cannot create a new empty tab.
The initial set of pages to add to the created browser window.
When true, disables the ability to close pages in the window. False by default.
When true, page tabs in the window will not be draggable. This includes reordering pages and dragging them out of the window. False by default.
When true, disables the ability to drag pages into the window. False by default.
When true, disables the ability to drag pages out of a window. False by default.
A UI friendly title for the created browser window.
Generated using TypeDoc
Request for creating a browser window.