Optional
acceleratorOptional
apiConfigurations for API injection.
Optional
autoOptional
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 view’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 view’s (a) content area before its content is loaded as well as (b) newly exposed
areas when growing a view. Setting
this value to the anticipated content background color can help improve user experience.
Default is white.
Optional
boundsInitial bounds given relative to the window.
Optional
chromium{@inheritDoc ChromiumPolicies}
Optional
closePlatforms Only.
Determines what happens when a view is closed in a platform window.
Supersedes the deprecated detachOnClose
.
If not set, detaults to destroy
if detachOnClose
is false (default), or detach
if detachOnClose
is true.
While this option is not updateable, it may change at runtime if detachOnClose
is updated.
'hide' hides the view on the platform window that closed it.
'detach' behaves like 'detachOnClose': true. It attaches the closed view to the platform provider.
'destroy' is the default behavior as long as 'detachOnClose' is not set. It destroys the view.
Optional
contentConfigures how new content (e,g, from window.open
or a link) is opened.
Optional
contentRestrict navigation to URLs that match an allowed pattern. In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited. See here for more details.
Optional
contentOptional
contextSuperseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.
true
Show the context menu when right-clicking on the view. Gives access to the devtools for the view.
Optional
contextConfigure the context menu when right-clicking on a window.
Optional
contextSuperseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.
Configure the context menu when right-clicking on a window.
Optional
customA field that the user can use to attach serializable data that will be saved when 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 Platform#setWindowContext Platform.setWindowContext and 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. For usage example, see MutableWindowOptions customContext Example.
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 view.
Optional
detachfalse
Platforms Only. If true, will hide and detach the View from the window for later use instead of closing, allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
Optional
downloadControls interaction of the view with its parent window's download shelf.
Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.
If enabled: true
, downloads from this view will cause the download shelf to display
on the parent window even if that parent window's DownloadShelfOptions specify
enabled: false
.
Optional
enablefalse
When set to true
, any beforeunload
handler set on Views will fire.
Optional
excludeControl which options to ignore when creating a Platform View.
Optional
experimentalOptional
fdc3Optional
hotkeysDefines the hotkeys that will be emitted as a hotkey
event on the view. For usage example, see MutableWindowOptions hotkeys 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.
Optional
interopOptional
istrue
Platforms Only. If false, the view will be persistent and can't be closed through
either UI or Platform.closeView
. Note that the view will still be closed if the host window is closed or
if the view isn't part of the new layout when running Layout.replace
.
Optional
manifestPlatforms Only. Url to a manifest that contains View Options. Properties other than manifestUrl can still be used but the properties in the manifest will take precedence if there is any collision.
Optional
minThe name of the view.
Optional
permissionsAPI permissions for code running in the view.
Superseded by DomainSettings.default.api.permissions - if present, this setting will be ignored. It is recommended for users to migrate to a domain-based security model, since it is more natural to assign trust to the source of the page content than to the context rendering it.
Optional
preloadScripts that run before page load. When omitted, inherits from the parent application.
Optional
preventfalse
Platforms Only. If true, the tab of the view can't be dragged out of its host window.
Optional
processString tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
The identity of the window this view should be attached to.
Optional
throttling{@inheritDoc ViewThrottling}
'enabled'
Optional
titleDefaults to name
.
Ignored in container, but used in @openfin/core-web to set tab titles.
Order of precedence for title in container is: document.title, viewOptions.url.
Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
"about:blank"
The URL of the window
Optional
workspaceOptional
zoom
Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.