Interface ViewCreationOptions

The options object required by View.create.

Note that name and target are the only required properties — albeit the url property is usually provided as well (defaults to "about:blank" when omitted).

Hierarchy

  • ViewCreationOptions

Properties

accelerator? api? autoResize? autoplayPolicy? backgroundColor? bounds? contentCreation? contentNavigation? contentRedirect? contextMenu? contextMenuOptions? contextMenuSettings? customContext? customData? customRequestHeaders? detachOnClose? enableBeforeUnload? experimental? fdc3InteropApi? hotkeys? interop? isClosable? manifestUrl? name permissions? preloadScripts? preventDragOut? processAffinity? target url zoomLevel?

Properties

Optional accelerator

accelerator?: Partial<Accelerator>

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

Optional api

api?: Api

Configurations for API injection.

Optional autoResize

autoResize?: AutoResizeOptions

Optional autoplayPolicy

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.

Optional backgroundColor

backgroundColor?: string

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.

Optional bounds

bounds?: Bounds

Initial bounds given relative to the window.

Optional contentCreation

contentCreation?: ContentCreationOptions

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

Optional contentNavigation

contentNavigation?: NavigationRules

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.

Optional contentRedirect

contentRedirect?: NavigationRules

Optional contextMenu

contextMenu?: boolean

Deprecated

Superseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.

Default Value

true

Show the context menu when right-clicking on the view. Gives access to the devtools for the view.

Optional contextMenuOptions

contextMenuOptions?: ContextMenuOptions

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

Optional contextMenuSettings

contextMenuSettings?: ContextMenuSettings

Deprecated

Superseded by contextMenuOptions, which offers a larger feature-set and cleaner syntax.

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

Optional customContext

customContext?: any

A field that the user can use to attach serializable data that will be saved when 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 customContext Example.

Optional customData

customData?: any

A field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.

Optional customRequestHeaders

customRequestHeaders?: CustomRequestHeaders[]

Custom headers for requests sent by the view.

Optional detachOnClose

detachOnClose?: boolean

Default Value

false

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 enableBeforeUnload

enableBeforeUnload?: boolean

Default Value

false

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

Optional experimental

experimental?: any

Optional fdc3InteropApi

fdc3InteropApi?: string

Optional hotkeys

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.

Optional interop

interop?: InteropConfig

Optional isClosable

isClosable?: boolean

Default Value

true

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 manifestUrl

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

name: string

The name of the view.

Optional permissions

permissions?: Partial<Permissions>

Optional preloadScripts

preloadScripts?: PreloadScript[]

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

Optional preventDragOut

preventDragOut?: boolean

Default Value

false

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

Optional processAffinity

processAffinity?: string

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

target

target: Identity

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

url

url: string

Default Value

"about:blank"

The URL of the window

Optional zoomLevel

zoomLevel?: number

Settings

Theme

On This Page