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

    Interface PopupOptions

    Popup window options.

    interface PopupOptions {
        additionalOptions?: Partial<MutableWindowOptions>;
        blurBehavior?: PopupBlurBehavior;
        focus?: boolean;
        height?: number;
        hideOnClose?: boolean;
        initialOptions?: Optional<WindowCreationOptions, "name">;
        name?: string;
        onPopupReady?: (popupWindow: _Window) => any;
        onPopupResult?: (payload: PopupResult) => any;
        resultDispatchBehavior?: PopupResultBehavior;
        url?: string;
        width?: number;
        x?: number;
        y?: number;
    }
    Index
    additionalOptions? blurBehavior? focus? height? hideOnClose? initialOptions? name? onPopupReady? onPopupResult? resultDispatchBehavior? url? width? x? y?
    additionalOptions?: Partial<MutableWindowOptions>

    Updatable window options applied to new and existing windows when shown as popups.

    blurBehavior?: PopupBlurBehavior

    Determines what happens if the popup window is blurred.

    • 'modal' restricts resizing and positioning in the caller.
    • 'hide' hides the popup window on blur.
    • 'close' closes the popup window on blur.
    'close'
    focus?: boolean

    Determines if the popup window should or should not be focused when it is shown.

    true
    height?: number

    Height of the popup window in pixels (takes priority over intialOptions size properties).

    300
    hideOnClose?: boolean

    Hide the popup window instead of closing when close is called on it.

    Note: if this is true and blurBehavior and/or resultDispatchBehavior are set to close, the window will be hidden.

    false
    initialOptions?: Optional<WindowCreationOptions, "name">

    Window creation options when using showPopupWindow to create a new window.

    name?: string

    If a window with this name exists, it will be shown as a popup. Otherwise, a new window with this name will be created. If this name is undefined, initialOptions.name will be used. If this name and intialOptions.name are both undefined, a name will be generated.

    onPopupReady?: (popupWindow: _Window) => any

    Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.

    onPopupResult?: (payload: PopupResult) => any

    Executed when this window's popup calls dispatchPopupResult.

    Note: If this is defined, showPopupWindow will not return a PopupResult.

    resultDispatchBehavior?: PopupResultBehavior

    Determines what happens when the popup window calls dispatchPopupResult.

    • 'none' will do nothing.
    • 'hide' hides the popup window on dispatchPopupResult.
    • 'close' closes the popup window on dispatchPopupResult.
    'close'
    url?: string

    Navigates to this url if showing an existing window as a popup, otherwise the newly created window will load this url.

    width?: number

    Width of the popup window in pixels (takes priority over intialOptions size properties).

    300
    x?: number

    Left position in pixels where the popup window will be shown (relative to the window calling showPopupWindow).

    0
    y?: number

    Top position in pixels where the popup window will be shown (relative to the window calling showPopupWindow).

    0

    Settings

    On This Page
    Properties