AboutSupportDeveloper GuideVersion 38.126.83.75

Interface PlatformOptions

The options object required by Platform.start Any Application option is also a valid platform option

interface PlatformOptions {
    accelerator?: Partial<Accelerator>;
    allowLaunchIntoPlatform?: boolean;
    alwaysOnTop?: boolean;
    api?: ApiSettings;
    apiDiagnostics?: boolean;
    appLogsTimezone?: TimeZones;
    aspectRatio?: number;
    autoShow?: boolean;
    autoplayPolicy?: AutoplayPolicyOptions;
    backgroundColor?: string;
    commands?: ShortcutOverride[];
    contentNavigation?: NavigationRules;
    contextMenu?: boolean;
    cornerRounding?: Partial<CornerRounding>;
    customData?: any;
    customRequestHeaders?: CustomRequestHeaders[];
    defaultCentered?: boolean;
    defaultDomainSettings?: DomainSettings;
    defaultHeight?: number;
    defaultLeft?: number;
    defaultTop?: number;
    defaultViewOptions?: Partial<ViewOptions>;
    defaultWidth?: number;
    defaultWindowOptions?: Partial<PlatformWindowOptions>;
    disableDefaultCommands?: boolean;
    disableIabSecureLogging?: boolean;
    domainSettings?: DomainSettings;
    enableBeforeUnload?: boolean;
    enableJumpList?: boolean;
    frame?: boolean;
    hideOnClose?: boolean;
    icon?: string;
    ignoreSavedWindowState?: boolean;
    interopBrokerConfiguration?: InteropBrokerOptions;
    isPlatformController?: boolean;
    loadErrorMessage?: string;
    mainWindowOptions?: WindowCreationOptions;
    maxHeight?: number;
    maxViewPoolSize?: number;
    maxWidth?: number;
    maximizable?: boolean;
    minHeight?: number;
    minWidth?: number;
    minimizable?: boolean;
    name: string;
    nonPersistent?: boolean;
    opacity?: number;
    permissions?: Partial<Permissions>;
    plugins?: boolean;
    preloadScripts?: PreloadScript[];
    preventQuitOnLastWindowClosed?: boolean;
    providerUrl?: string;
    resizable?: boolean;
    resizeRegion?: ResizeRegion;
    saveWindowState?: boolean;
    shadow?: boolean;
    showTaskbarIcon?: boolean;
    smallWindow?: boolean;
    snapshot?: Snapshot;
    spellCheck?: boolean;
    state?: WindowState;
    taskbarIconGroup?: string;
    url?: string;
    uuid: string;
    viewProcessAffinityStrategy?: ProcessAffinityStrategy;
    waitForPageLoad?: boolean;
    webSecurity?: boolean;
}

Properties

accelerator? allowLaunchIntoPlatform? alwaysOnTop? api? apiDiagnostics? appLogsTimezone? aspectRatio? autoShow? autoplayPolicy? backgroundColor? commands? contentNavigation? contextMenu? cornerRounding? customData? customRequestHeaders? defaultCentered? defaultDomainSettings? defaultHeight? defaultLeft? defaultTop? defaultViewOptions? defaultWidth? defaultWindowOptions? disableDefaultCommands? disableIabSecureLogging? domainSettings? enableBeforeUnload? enableJumpList? frame? hideOnClose? icon? ignoreSavedWindowState? interopBrokerConfiguration? isPlatformController? loadErrorMessage? mainWindowOptions? maxHeight? maxViewPoolSize? maxWidth? maximizable? minHeight? minWidth? minimizable? name nonPersistent? opacity? permissions? plugins? preloadScripts? preventQuitOnLastWindowClosed? providerUrl? resizable? resizeRegion? saveWindowState? shadow? showTaskbarIcon? smallWindow? snapshot? spellCheck? state? taskbarIconGroup? url? uuid viewProcessAffinityStrategy? waitForPageLoad? webSecurity?

Properties

Optional accelerator

accelerator?: Partial<Accelerator>

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

Optional allowLaunchIntoPlatform

allowLaunchIntoPlatform?: boolean

Default Value

true

Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to true.

NOTE: Starting in v38, the default value will change to false and content launching must be explicitly opted into.

Optional alwaysOnTop

alwaysOnTop?: boolean

Default Value

false

Always position the window at the top of the window stack.

Optional api

api?: ApiSettings

Configurations for API injection.

Optional apiDiagnostics

apiDiagnostics?: boolean

Default Value

true

When set to false it will disable OpenFin Diagnostics for the app.

Optional appLogsTimezone

appLogsTimezone?: TimeZones

Set the timezone for the app logs. When setting this value the timestamp will be in ISO 8601 format. By default, if no value is set, it will show the local time in this format: 'y-MM-dd HH:mm:ss.SSS'

Optional aspectRatio

aspectRatio?: number

Default Value

0

The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
an aspect ratio will not be enforced.

Optional autoShow

autoShow?: boolean

Automatically show the window when it is created.

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

Optional commands

commands?: ShortcutOverride[]

Configuration for keyboard commands. For details and usage, see Using Keyboard Commands.

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 denied pattern would be prohibited. See here for more details.

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 window.
Gives access to the devtools for the window.

Optional cornerRounding

cornerRounding?: Partial<CornerRounding>

Defines and applies rounded corners for a frameless window. NOTE: On macOS corner is not ellipse but circle rounded by the average of height and width.

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

Optional defaultCentered

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.

Optional defaultDomainSettings

defaultDomainSettings?: DomainSettings

Deprecated

Please use domainSettings instead

Optional defaultHeight

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.

Optional defaultLeft

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.

Optional defaultTop

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.

Optional defaultViewOptions

defaultViewOptions?: Partial<ViewOptions>

Platforms Only. Default view options apply to all platform views.

Optional defaultWidth

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 defaultWindowOptions

defaultWindowOptions?: Partial<PlatformWindowOptions>

Platforms Only. Default window options apply to all platform windows.

Optional disableDefaultCommands

disableDefaultCommands?: boolean

Optional disableIabSecureLogging

disableIabSecureLogging?: boolean

Default Value

false

Disables IAB secure logging for the app.

Optional domainSettings

domainSettings?: DomainSettings

Define the file download rules and domain-based api injection rules.

Optional enableBeforeUnload

enableBeforeUnload?: boolean

Default Value

false

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

Optional enableJumpList

enableJumpList?: boolean

Default Value

false

Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
Only relevant in Windows.

Optional frame

frame?: boolean

Default Value

true

Show the window's frame.

Optional hideOnClose

hideOnClose?: boolean

Default Value

false

Hides the window instead of closing it when the close button is pressed.

Optional icon

icon?: string

A URL for the icon to be shown in the window title bar and the taskbar. When omitted, inherits from the parent application.

Note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.

Optional ignoreSavedWindowState

ignoreSavedWindowState?: boolean

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

Optional interopBrokerConfiguration

interopBrokerConfiguration?: InteropBrokerOptions

Configuration for interop broker.

Optional isPlatformController

isPlatformController?: boolean

Optional loadErrorMessage

loadErrorMessage?: string

Default Value

'There was an error loading the application.'

An error message to display when the application (launched via manifest) fails to load. A dialog box will be launched with the error message just before the runtime exits. Load fails such as failed DNS resolutions or aborted connections as well as cancellations, e.g., window.stop(), will trigger this dialog. Client response codes such as 404 Not Found are not treated as fails as they are valid server responses.

Optional mainWindowOptions

mainWindowOptions?: WindowCreationOptions

The options of the main window of the application.

Optional maxHeight

maxHeight?: number

Default Value

-1

The maximum height of a window. Will default to the OS defined value if set to -1.

Optional maxViewPoolSize

maxViewPoolSize?: number

Default Value

1000

**Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
If you do not wish for views to be pooled on your platform, set this property to zero.

Optional maxWidth

maxWidth?: number

Default Value

-1

The maximum width of a window. Will default to the OS defined value if set to -1.

Optional maximizable

maximizable?: boolean

Default Value

true

Allows the window to be maximized.

Optional minHeight

minHeight?: number

Default Value

0

The minimum height of the window.

Optional minWidth

minWidth?: number

Default Value

true

The minimum width of the window.

Optional minimizable

minimizable?: boolean

Default Value

true

Allows the window to be minimized.

name

name: string

The name of the application.

Remarks

This property is used for naming the application logging folder, which will be sanitized to remove any special characters, spaces or international characters. It's also used in error messages, API security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/.

This property will be deprecated in the future.

Optional nonPersistent

nonPersistent?: boolean

Default Value

false

A flag to configure the application as non-persistent.
Runtime exits when there are no persistent apps running.

Optional opacity

opacity?: number

Default Value

1

A flag that specifies how transparent the window will be. Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there. This value is clamped between 0.0 and 1.0.

Optional permissions

permissions?: Partial<Permissions>

The permissions for secured APIs.

Optional plugins

plugins?: boolean

Default Value

false

Enable Flash at the application level.

Optional preloadScripts

preloadScripts?: PreloadScript[]

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

Optional preventQuitOnLastWindowClosed

preventQuitOnLastWindowClosed?: boolean

Default Value

false

**Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.

Note: if the Platform Provider is showing, it won't close automatically.
If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.

Optional providerUrl

providerUrl?: string

The provider url.

Optional resizable

resizable?: boolean

Default Value

true

A flag to allow the user to resize the window.

Optional resizeRegion

resizeRegion?: ResizeRegion

Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.

Optional saveWindowState

saveWindowState?: boolean

Default Value

true

Caches the location of the window.

Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.

Optional shadow

shadow?: boolean

Default Value

false

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

Optional showTaskbarIcon

showTaskbarIcon?: boolean

Default Value

true

Shows the window's icon in the taskbar.

Optional smallWindow

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.

Optional snapshot

snapshot?: Snapshot

Platforms Only. The snapshot to be applied.

Optional spellCheck

spellCheck?: boolean

Default Value

false

Enable spell check at the application level.

Optional state

state?: WindowState

Default Value

"normal"

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

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

Optional taskbarIconGroup

taskbarIconGroup?: string

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

Remarks

It's only updatable when enableJumpList is set to false.

Optional url

url?: string

Default Value

'about:blank'

The url to the application (specifically the application's main window).

uuid

uuid: string

The Unique Universal Identifier (UUID) of the application, unique within the set of all other applications running in the OpenFin Runtime.

Optional viewProcessAffinityStrategy

viewProcessAffinityStrategy?: ProcessAffinityStrategy

Strategy to assign views to process affinity by domain.

  • same - The views in the same domain will have same renderer processes.
  • different - The views in the same domain will have their own renderer processes.

Optional waitForPageLoad

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.

Optional webSecurity

webSecurity?: boolean

Default Value

true

When set to false it will disable the same-origin policy for the app.

Settings

Theme

On This Page

acceleratorallowLaunchIntoPlatformalwaysOnTopapiapiDiagnosticsappLogsTimezoneaspectRatioautoShowautoplayPolicybackgroundColorcommandscontentNavigationcontextMenucornerRoundingcustomDatacustomRequestHeadersdefaultCentereddefaultDomainSettingsdefaultHeightdefaultLeftdefaultTopdefaultViewOptionsdefaultWidthdefaultWindowOptionsdisableDefaultCommandsdisableIabSecureLoggingdomainSettingsenableBeforeUnloadenableJumpListframehideOnCloseiconignoreSavedWindowStateinteropBrokerConfigurationisPlatformControllerloadErrorMessagemainWindowOptionsmaxHeightmaxViewPoolSizemaxWidthmaximizableminHeightminWidthminimizablenamenonPersistentopacitypermissionspluginspreloadScriptspreventQuitOnLastWindowClosedproviderUrlresizableresizeRegionsaveWindowStateshadowshowTaskbarIconsmallWindowsnapshotspellCheckstatetaskbarIconGroupurluuidviewProcessAffinityStrategywaitForPageLoadwebSecurity