AboutSupportDeveloper GuideVersion 41.134.102.6

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

Optionalaccelerator

accelerator?: Partial<Accelerator>

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

OptionalallowLaunchIntoPlatform

allowLaunchIntoPlatform?: boolean

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.

Default

true

OptionalalwaysOnTop

alwaysOnTop?: boolean

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

Default

false

Optionalapi

api?: ApiSettings

Configurations for API injection.

OptionalapiDiagnostics

apiDiagnostics?: boolean

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

Default

true

OptionalappLogsTimezone

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'

OptionalaspectRatio

aspectRatio?: number

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.

Default

0

OptionalautoShow

autoShow?: boolean

Automatically show the window when it is created.

OptionalautoplayPolicy

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.

OptionalbackgroundColor

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.

Optionalcommands

commands?: ShortcutOverride[]

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

OptionalcontentNavigation

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.

OptionalcontextMenu

contextMenu?: boolean

Deprecated

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

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

Default

true

OptionalcornerRounding

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.

OptionalcustomData

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.

OptionalcustomRequestHeaders

customRequestHeaders?: CustomRequestHeaders[]

Custom headers for requests sent by the window.

OptionaldefaultCentered

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.

OptionaldefaultDomainSettings

defaultDomainSettings?: DomainSettings

Deprecated

Please use domainSettings instead

OptionaldefaultHeight

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.

Default

500

OptionaldefaultLeft

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.

Default

100

OptionaldefaultTop

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.

Default

100

OptionaldefaultViewOptions

defaultViewOptions?: Partial<ViewOptions>

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

OptionaldefaultWidth

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.

Default

800

OptionaldefaultWindowOptions

defaultWindowOptions?: Partial<PlatformWindowOptions>

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

OptionaldisableDefaultCommands

disableDefaultCommands?: boolean

OptionaldisableIabSecureLogging

disableIabSecureLogging?: boolean

Disables IAB secure logging for the app.

Default

false

OptionaldomainSettings

domainSettings?: DomainSettings

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

OptionalenableBeforeUnload

enableBeforeUnload?: boolean

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

Default

false

OptionalenableJumpList

enableJumpList?: boolean

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

Default

false

Optionalframe

frame?: boolean

Deprecated

Will be removed in runtime version 45

Default Value

true

Show the window's frame.

Default

true

OptionalhideOnClose

hideOnClose?: boolean

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

Default

false

Optionalicon

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.

OptionalignoreSavedWindowState

ignoreSavedWindowState?: boolean

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

OptionalinteropBrokerConfiguration

interopBrokerConfiguration?: InteropBrokerOptions

Configuration for interop broker.

OptionalisPlatformController

isPlatformController?: boolean

OptionalloadErrorMessage

loadErrorMessage?: string

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.

Default

'There was an error loading the application.'

OptionalmainWindowOptions

mainWindowOptions?: WindowCreationOptions

The options of the main window of the application.

OptionalmaxHeight

maxHeight?: number

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

Default

-1

OptionalmaxViewPoolSize

maxViewPoolSize?: number

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.

Default

1000

OptionalmaxWidth

maxWidth?: number

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

Default

-1

Optionalmaximizable

maximizable?: boolean

Allows the window to be maximized.

Default

true

OptionalminHeight

minHeight?: number

The minimum height of the window.

Default

0

OptionalminWidth

minWidth?: number

The minimum width of the window.

Default

true

Optionalminimizable

minimizable?: boolean

Allows the window to be minimized.

Default

true

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.

OptionalnonPersistent

nonPersistent?: boolean

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

Default

false

Optionalopacity

opacity?: number

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. In software composition mode, the runtime flag --allow-unsafe-compositing is required.

Default

1

Optionalpermissions

permissions?: Partial<Permissions>

The permissions for secured APIs.

Optionalplugins

plugins?: boolean

Enable Flash at the application level.

Default

false

OptionalpreloadScripts

preloadScripts?: PreloadScript[]

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

OptionalpreventQuitOnLastWindowClosed

preventQuitOnLastWindowClosed?: boolean

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.

Default

false

OptionalproviderUrl

providerUrl?: string

The provider url.

Optionalresizable

resizable?: boolean

A flag to allow the user to resize the window.

Default

true

OptionalresizeRegion

resizeRegion?: ResizeRegion

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

OptionalsaveWindowState

saveWindowState?: boolean

Caches the location of the window.

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

Default

true

Optionalshadow

shadow?: boolean

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

Default

false

OptionalshowTaskbarIcon

showTaskbarIcon?: boolean

Shows the window's icon in the taskbar.

Default

true

OptionalsmallWindow

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.

Default

false

Optionalsnapshot

snapshot?: Snapshot

Platforms Only. The snapshot to be applied.

OptionalspellCheck

spellCheck?: boolean

Enable spell check at the application level.

Default

false

Optionalstate

state?: WindowState

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

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

Default

"normal"

OptionaltaskbarIconGroup

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. If omitted, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid).

Remarks

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

Optionalurl

url?: string

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

Default

'about:blank'

uuid

uuid: string

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

OptionalviewProcessAffinityStrategy

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.

OptionalwaitForPageLoad

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.

Default

false

OptionalwebSecurity

webSecurity?: boolean

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

Default

true

Settings

On This Page

Properties
acceleratorallowLaunchIntoPlatformalwaysOnTopapiapiDiagnosticsappLogsTimezoneaspectRatioautoShowautoplayPolicybackgroundColorcommandscontentNavigationcontextMenucornerRoundingcustomDatacustomRequestHeadersdefaultCentereddefaultDomainSettingsdefaultHeightdefaultLeftdefaultTopdefaultViewOptionsdefaultWidthdefaultWindowOptionsdisableDefaultCommandsdisableIabSecureLoggingdomainSettingsenableBeforeUnloadenableJumpListframehideOnCloseiconignoreSavedWindowStateinteropBrokerConfigurationisPlatformControllerloadErrorMessagemainWindowOptionsmaxHeightmaxViewPoolSizemaxWidthmaximizableminHeightminWidthminimizablenamenonPersistentopacitypermissionspluginspreloadScriptspreventQuitOnLastWindowClosedproviderUrlresizableresizeRegionsaveWindowStateshadowshowTaskbarIconsmallWindowsnapshotspellCheckstatetaskbarIconGroupurluuidviewProcessAffinityStrategywaitForPageLoadwebSecurity
""