Type alias ConstWindowOptions

Type declaration

• accelerator: Partial<Accelerator>

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

• api: Api

  Configurations for API injection.

• applicationIcon: string

  Deprecated

  use icon instead.

• autoShow: boolean

  Automatically show the window when it is created.

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

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

• closeOnLastViewRemoved: boolean

  Default Value

  true

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

• contentCreation: ContentCreationOptions

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

• contentNavigation: ContentNavigation

  Restrict navigation to URLs that match a whitelisted pattern. In the lack of a whitelist, navigation to URLs that match a blacklisted pattern would be prohibited. See here for more details.

• contentRedirect: Partial<ContentRedirect>

  Restrict redirects to URLs that match a whitelisted pattern. In the lack of a whitelist, redirects to URLs that match a blacklisted 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

  Default Value

  500

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

• defaultLeft: number

  Default Value

  100

  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.

• defaultTop: number

  Default Value

  100

  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.

• defaultWidth: number

  Default Value

  800

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

• Optional experimental?: any

• Optional fdc3InteropApi?: string

• height: number

• ignoreSavedWindowState: boolean

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

• layout: any

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

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

• saveWindowState: boolean

  Default Value

  true

  Caches the location of the window. Note: this option is ignored in Platforms as it would cause inconsistent applySnapshot behavior.

• shadow: boolean

  Default Value

  false

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

• smallWindow: boolean

  Default Value

  false

  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.

• state: WindowState

  Default Value

  "normal"

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

  • "maximized"
  • "minimized"
  • "normal"

• taskbarIcon: string

  Deprecated

  • use icon instead.

• taskbarIconGroup: string

  Specify a taskbar group for the window. If omitted, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid).

• url: string

  Default Value

  "about:blank"

  The URL of the window

• uuid: string

  Default Value

  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.

• Optional viewVisibility?: ViewVisibilityOptions

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

• waitForPageLoad: boolean

  Default Value

  false

  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.

• width: number

• x: number

• y: number