AboutSupportDeveloper GuideVersion 22.3.24

Interface BrowserInitConfig

Configuration for initializing a Browser.

interface BrowserInitConfig {
    browserIconSize?: IconSize;
    defaultPageOptions?: Pick<Page,
        | "iconUrl"
        | "unsavedIconUrl"
        | "closeButton"
        | "panels">;
    defaultViewOptions?: Partial<ViewOptions>;
    defaultWindowOptions?: Partial<BrowserCreateWindowRequest>;
    interopOverride?: OverrideCallback<InteropBroker, InteropBroker>;
    overrideCallback?: WorkspacePlatformOverrideCallback;
    title?: string;
}

Properties

browserIconSize? defaultPageOptions? defaultViewOptions? defaultWindowOptions? interopOverride? overrideCallback? title?

Properties

OptionalbrowserIconSize

browserIconSize?: IconSize

By default, the icons in the browser are displayed at the default size. If you want to display the icons at a larger size, set this property to 'large'. This will increase the size of the icons in the browser. If you have custom icons that are PNGs you will need to update these assets for best results.

OptionaldefaultPageOptions

defaultPageOptions?: Pick<Page,
    | "iconUrl"
    | "unsavedIconUrl"
    | "closeButton"
    | "panels">

Default options when creating a new page. If iconUrl, unsavedIconUrl, panels or closeButton are not defined when creating a page, setting will default to defaultPageOptions.

OptionaldefaultViewOptions

defaultViewOptions?: Partial<ViewOptions>

The default options when creating a new browser window. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.

OptionaldefaultWindowOptions

defaultWindowOptions?: Partial<BrowserCreateWindowRequest>

Default options for creating a new Browser window. These options are not applied on any non-Browser windows that get created. These default options will take precedence over defaultWindowOptions included in the manifest. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createWindow(options) call will default to the value provided in this field.

OptionalinteropOverride

interopOverride?: OverrideCallback<InteropBroker, InteropBroker>

Deprecated

Override workspace platform interop behavior

https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.InteropBroker.html

OptionaloverrideCallback

overrideCallback?: WorkspacePlatformOverrideCallback

Override workspace platform behavior

Deprecated

Please use the overrideCallback property of WorkspacePlatformInitConfig

Optionaltitle

title?: string

The platform title. UI friendly title for the platform in browser.

Settings

On This Page

Properties