Interface BrowserViewState

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

Configurations for API injection.

Specifies the AppLogLevel for the specified View. See AppLogLevel for more information.

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

Initial bounds given relative to the window.

{@inheritDoc ChromiumPolicies}

Platforms 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.

Configures how new content (e,g, from window.open or a link) is opened.

Restrict 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.

Configure the context menu when right-clicking on a window.

A 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 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. For usage example, see MutableWindowOptions customContext Example.

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 view.

When set to true, will prevent setting the -webkit-app-region and app-region css properties on the view. These css properties are used to enable dragging of a frameless window.

Controls interaction of the view with its parent window's download shelf.

When set to true, any beforeunload handler set on Views will fire.

Control which options to ignore when creating a Platform View.

Defines 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.

Per-view tab icon. Exception to showFavicons / defaultFaviconUrl.

Distinct from Window icon (taskbar).

• Omitted / '' / 'unset': inherit — if showFavicons, page favicon then defaultFaviconUrl, else hide
• URL string: always show that URL, even when showFavicons is false. Load failure uses defaultFaviconUrl
• 'hide': always hide, even when showFavicons is true

On updateOptions, omitted keys are a no-op; set 'unset' to return to inherit.

Determines whether window.open calls from web contents should use the specified target name as provided, or automatically generate a unique name. When true, each call generates a new unique target name, ensuring a new window is always created. When false, the target name passed to window.open is respected.

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.

Platforms 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.

The name of the view.

API permissions for code running in the view.

Scripts that run before page load. When omitted, inherits from the parent application.

Platforms Only. If true, the tab of the view can't be dragged out of its host window.

String 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.

{@inheritDoc ViewThrottling}

Defaults to name.

Controls order of title precedence: 'options': viewOptions.title (componentState), document.title, viewOptions.url 'document': document.title, viewOptions.title(componentState), viewOptions.url (default behavior)

The URL of the window