AboutSupportDeveloper GuideVersion 37.124.81.24

Interface ConstViewOptions

View options that cannot be updated after creation.

Hierarchy

  • ConstViewOptions

Properties

accelerator?: Partial<Accelerator>

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

Configurations for API injection.

autoplayPolicy: AutoplayPolicyOptions

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.

bounds: Bounds

Initial bounds given relative to the window.

closeBehavior: "destroy" | "hide" | "detach"

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.

contentCreation: ContentCreationOptions

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

customRequestHeaders: CustomRequestHeaders[]

Custom headers for requests sent by the view.

downloadShelf: {
    enabled: boolean;
}

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

Type declaration

  • enabled: boolean

    Whether downloads in this view trigger opening the download shelf on its parent BrowserWindow.

    Remarks

    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.

enableBeforeUnload: boolean

Default Value

false

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

experimental: any
fdc3InteropApi?: string
hotkeys: Hotkey[]

Defines the hotkeys that will be emitted as a hotkey event on the view. For usage example, see 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.

manifestUrl: string

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.

name: string

The name of the view.

permissions: Partial<Permissions>
preloadScripts: PreloadScript[]

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

processAffinity: string

String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.

target: Identity

The identity of the window this view should be attached to.

url: string

Default Value

"about:blank"

The URL of the window

zoomLevel: number