AboutSupportDeveloper GuideVersion 47.154.100.2
OpenFin JavaScript API
    Preparing search index...

    Interface ConstWindowOptions

    Window options that cannot be changed after creation.

    interface ConstWindowOptions {
        accelerator: Partial<Accelerator>;
        api: ApiSettings;
        applicationIcon: string;
        autoplayPolicy: AutoplayPolicyOptions;
        autoShow: boolean;
        backgroundColor: string;
        backgroundThrottling: boolean;
        closeOnLastViewRemoved: boolean;
        contentCreation: ContentCreationOptions;
        contentNavigation: NavigationRules;
        contentRedirect: Partial<ContentRedirect>;
        customRequestHeaders: CustomRequestHeaders[];
        defaultCentered: boolean;
        defaultHeight: number;
        defaultLeft: number;
        defaultTop: number;
        defaultWidth: number;
        disableAppRegion: boolean;
        downloadBubble?: DownloadBubbleOptions;
        downloadShelf: DownloadShelfOptions;
        excludeOptions: ExcludeOptions;
        fdc3InteropApi?: string;
        frame: boolean;
        height: number;
        ignoreChildFrameName?: boolean;
        ignoreSavedWindowState: boolean;
        inheritance?: Partial<InheritableOptions>;
        layout: any;
        layoutSnapshot: LayoutSnapshot;
        modalParentIdentity: Identity;
        name: string;
        permissions: Partial<Permissions>;
        preloadScripts: PreloadScript[];
        processAffinity: string;
        roundedCorners: boolean;
        saveWindowState: boolean;
        shadow: boolean;
        smallWindow: boolean;
        state: WindowState;
        taskbarIcon: string;
        taskbarIconGroup: string;
        url: string;
        uuid: string;
        viewsPreventingClose: "layout" | "all";
        viewVisibility?: ViewVisibilityOptions;
        waitForPageLoad: boolean;
        width: number;
        x: number;
        y: number;
    }
    Index
    accelerator api applicationIcon autoplayPolicy autoShow backgroundColor backgroundThrottling closeOnLastViewRemoved contentCreation contentNavigation contentRedirect customRequestHeaders defaultCentered defaultHeight defaultLeft defaultTop defaultWidth disableAppRegion downloadBubble? downloadShelf excludeOptions fdc3InteropApi? frame height ignoreChildFrameName? ignoreSavedWindowState inheritance? layout layoutSnapshot modalParentIdentity name permissions preloadScripts processAffinity roundedCorners saveWindowState shadow smallWindow state taskbarIcon taskbarIconGroup url uuid viewsPreventingClose viewVisibility? waitForPageLoad width x y
    accelerator: Partial<Accelerator>

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

    api: ApiSettings

    Configurations for API injection.

    applicationIcon: string

    use icon instead.

    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.

    autoShow: boolean

    Automatically show the window when it is created.

    backgroundColor: string

    The window’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 window’s (a) content area before its content is loaded as well as (b) newly exposed areas when growing a window. Setting this value to the anticipated content background color can help improve user experience. Default is white.

    backgroundThrottling: boolean

    Determines whether WebContents will throttle animations and timers when the page becomes backgrounded. This also affects the Page Visibility API.

    When true, the page is throttled whether it is hidden or not.

    false
    closeOnLastViewRemoved: boolean

    Setting this to false would keep the Window alive even if all its Views were closed. This is meant for advanced users and should be used with caution. Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail. Use layout.replace to create a fresh Layout instance in case you want to populate it with Views again. NOTE: - This option is ignored in non-Platforms apps.

    true
    contentCreation: ContentCreationOptions

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

    contentNavigation: NavigationRules

    Restrict navigation to URLs that match an allowed pattern. In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited. See here for more details.

    contentRedirect: Partial<ContentRedirect>

    Restrict redirects to URLs that match an allowed pattern. In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited. See here for more details.

    customRequestHeaders: CustomRequestHeaders[]

    Custom headers for requests sent by the window.

    defaultCentered: boolean

    Centers the window in the primary monitor. This option overrides defaultLeft and defaultTop. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

    NOTE: On macOS defaultCenter is somewhat above center vertically.

    defaultHeight: number

    The default height of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

    500
    defaultLeft: number

    The default left position of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

    100
    defaultTop: number

    The default top position of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

    100
    defaultWidth: number

    The default width of the window. When saveWindowState is true, this value will be ignored for subsequent launches in favor of the cached value.

    800
    disableAppRegion: boolean

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

    false
    downloadBubble?: DownloadBubbleOptions

    Configuration for download bubble UI.

    downloadShelf: DownloadShelfOptions

    Controls the styling and behavior of the window download shelf.

    This will control the styling for the download shelf regardless of whether its display was triggered by the window itself, or a view targeting the window.

    excludeOptions: ExcludeOptions

    Control which options to ignore when creating a Platform Window.

    fdc3InteropApi?: string
    frame: boolean
    true

    Show the window's frame.
    height: number
    ignoreChildFrameName?: boolean

    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.

    ignoreSavedWindowState: boolean

    Ignores the cached state of the window. Defaults the opposite value of saveWindowState to maintain backwards compatibility.

    inheritance?: Partial<InheritableOptions>

    Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the Manifest.startup_app or Manifest.platform properties in the manifest or in ApplicationOptions.mainWindowOptions when calling Application.start. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.

    layout: any
    layoutSnapshot: LayoutSnapshot

    The collection of layouts to load when the window is created. When launching multiple layouts, manage the lifecycle via fin.Platform.Layout.create()/destroy() methods.

    modalParentIdentity: Identity

    Parent identity of a modal window. It will create a modal child window when this option is set.

    name: string

    The name of the window.

    permissions: Partial<Permissions>

    API permissions for code running in the window.

    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: 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. However, there is no guarantee that a different affinity value will create a different process, under the hood Chromium can enforce its own process management under certain circumstances.

    Will only be used if pages are on the same origin.

    roundedCorners: boolean

    Controls whether frameless window should have rounded corners. Default is false for Windows and true for MacOS. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.

    saveWindowState: boolean

    Caches the location of the window.

    Note: this option is ignored in Platforms as it would cause inconsistent applySnapshot behavior.

    true
    shadow: boolean

    Displays a shadow on frameless windows. shadow and cornerRounding are mutually exclusive. On Windows 7, Aero theme is required.

    false
    smallWindow: boolean

    Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).

    Note: Caveats of small windows are no Aero Snap and drag to/from maximize. Windows 10: Requires maximizable to be false. Resizing with the mouse is only possible down to 38x39 px.

    false
    state: WindowState

    The visible state of the window on creation. One of:

    • "maximized"
    • "minimized"
    • "normal"
    "normal"
    taskbarIcon: string
    • use icon instead.
    taskbarIconGroup: string

    Specify a taskbar group for the window. Can be shared across applications. If omitted from a main window, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid). Use platform.defaultWindowOptions.taskbarIconGroup to set a default for platform applications.

    url: string

    The URL of the window

    "about:blank"
    uuid: string

    The uuid of the application, unique within the set of all Applications running in OpenFin Runtime. If omitted, defaults to the uuid of the application spawning the window. If given, must match the uuid of the application spawning the window. In other words, the application's uuid is the only acceptable value, but is the default, so there's really no need to provide it.

    <application UUID>
    viewsPreventingClose: "layout" | "all"

    When closeOnLastViewRemoved is set to true, determines which views prevent closing the window. Defaults to all. You may want to switch this to layout if using View closeBehavior: 'hide'. NOTE: - This option is ignored in non-Platforms apps.

    'all'
    viewVisibility?: ViewVisibilityOptions

    Platform Windows Only. Controls behavior for showing views when they are being resized by the user.

    waitForPageLoad: boolean

    When set to true, the window will not appear until the window object's load event fires. When set to false, the window will appear immediately without waiting for content to be loaded.

    false
    width: number
    x: number
    y: number

    Settings

    On This Page
    Properties