AboutSupportDeveloper GuideVersion 41.132.100.57

Interface ConstViewOptions

View options that cannot be updated after creation.

interface ConstViewOptions {
    accelerator?: Partial<Accelerator>;
    api: ApiSettings;
    autoplayPolicy: AutoplayPolicyOptions;
    bounds: Bounds;
    closeBehavior: "destroy" | "hide" | "detach";
    contentCreation: ContentCreationOptions;
    customRequestHeaders: CustomRequestHeaders[];
    downloadShelf: {
        enabled: boolean;
    };
    enableBeforeUnload: boolean;
    excludeOptions: ExcludeOptions;
    experimental: any;
    fdc3InteropApi?: string;
    hotkeys: Hotkey[];
    manifestUrl: string;
    name: string;
    permissions: Partial<Permissions>;
    preloadScripts: PreloadScript[];
    processAffinity: string;
    target: Identity;
    title: string;
    url: string;
    zoomLevel: number;
}

Properties

accelerator? api autoplayPolicy bounds closeBehavior contentCreation customRequestHeaders downloadShelf enableBeforeUnload excludeOptions experimental fdc3InteropApi? hotkeys manifestUrl name permissions preloadScripts processAffinity target title url zoomLevel

Properties

Optionalaccelerator

accelerator?: Partial<Accelerator>

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

api

api: ApiSettings

Configurations for API injection.

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.

bounds

bounds: Bounds

Initial bounds given relative to the window.

closeBehavior

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

contentCreation: ContentCreationOptions

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

customRequestHeaders

customRequestHeaders: CustomRequestHeaders[]

Custom headers for requests sent by the view.

downloadShelf

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

enableBeforeUnload: boolean

Default Value

false

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

excludeOptions

excludeOptions: ExcludeOptions

Control which options to ignore when creating a Platform View.

experimental

experimental: any

Optionalfdc3InteropApi

fdc3InteropApi?: string

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.

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.

permissions

permissions: Partial<Permissions>

API permissions for code running in the view.

Remarks

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.

preloadScripts

preloadScripts: PreloadScript[]

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

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.

title

title: string

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

url

url: string

Default Value

"about:blank"

The URL of the window

zoomLevel

zoomLevel: number

Settings

On This Page

Properties