Methods

activate back canGoBack canGoForward close executeScript focus forward getActiveTab getAllTabs getHeight getIsOnMainScreen getLeft getMuted getName getPixelRatio getPositionAndSize getScreenNumber getStartPage getTitle getTop getUrl getVisible getWidth getZoom maximize minimize navigate navigateHome onClosed onMessage onPointerEvent openNewTab reload restore sendMessage setMuted setPositionAndSize setStartPage setVisible setZoom stop

Events

onActiveTabChanged onError onPageFinished onPageStarted onTabClosed onTabCreated onUrlChanged

Methods

activate

  • Activates the window.

    Returns void

back

  • Navigates one page back in the history, if possible.

    Returns void

canGoBack

  • Returns whether the history contains any previous pages.

    Returns boolean

canGoForward

  • Returns whether the history contains any next pages.

    Returns boolean

close

  • Closes the window.

    Returns void

executeScript

  • Executes the given script.

    Parameters

    • script: string

      The script to be executed.

    Returns void

focus

  • Focus the window.

    Returns void

forward

  • Navigates one page forward in the history, if possible.

    Returns void

getActiveTab

getAllTabs

getHeight

  • Returns the window's height.

    Returns number

getIsOnMainScreen

  • Returns whether this window is displayed on the main screen.

    Returns boolean

getLeft

  • Returns the window's left position.

    Returns number

getMuted

  • Returns the muted state.

    Returns boolean

getName

  • Returns the name of the window or null when this window is not named.

    Returns null | string

getPixelRatio

  • Returns the pixel ratio for the window.

    Returns number

getPositionAndSize

getScreenNumber

  • Returns the screen number this window is displayed at.

    Returns number

getStartPage

getTitle

  • Returns the window's title.

    Returns string

getTop

  • Returns the window's top position.

    Returns number

getUrl

  • Returns the currently set url.

    Returns string

getVisible

  • Returns whether the window is visible.

    Returns boolean

getWidth

  • Returns the window's width.

    Returns number

getZoom

  • Returns the zoom state.

    Returns number

maximize

  • Maximizes the window.

    Returns void

minimize

  • Minimizes the window.

    Returns void

navigate

  • Navigates to a given URL.

    Parameters

    • url: string

      The URL to be navigated to.

    Returns void

navigateHome

onClosed

  • Subscribes the closed event of this object, which will be fired when this has been closed,

    Parameters

    • callback: (() => void)

      The callback which will be invoked when this has been closed.

        • (): void

        • Returns void

    Returns EventSubscription

onMessage

onPointerEvent

openNewTab

  • Tries to open a new tab inside this BrowserWindow, returns the tab when successfully or null when failed.

    Returns null | BrowserTab

  • Tries to open a new tab inside this BrowserWindow, returns the tab when successfully or null when failed.

    Parameters

    • url: string

      The URL to be navigated to.

    Returns null | BrowserTab

  • Tries to open a new tab inside this BrowserWindow, returns the tab when successfully or null when failed.

    Parameters

    Returns null | BrowserTab

reload

  • Reloads the current page.

    Returns void

restore

  • Restores the window.

    Returns void

sendMessage

  • Sends a message to this web view window. The web page can subscribe to these messages using the message handler of the current window.

    Parameters

    • message: string

    Returns void

setMuted

  • Sets the muted state.

    Parameters

    • muted: boolean

      The muted state to be set.

    Returns void

setPositionAndSize

  • Sets the position and size of the window.

    Parameters

    • left: number

      The left position of the window.

    • top: number

      The top position of the window.

    • width: number

      The width of the window.

    • height: number

      The height of the window.

    Returns void

setStartPage

  • Sets the start page.

    Parameters

    • url: string

      The start page be set.

    Returns void

setVisible

  • Sets whether the window is visible.

    Parameters

    • visible: boolean

      The visible state.

    Returns void

setZoom

  • Sets the zoom state.

    Parameters

    • zoom: number

      The zoom state to be set.

    Returns void

stop

  • Stops the loading of the current page.

    Returns void

Events

onActiveTabChanged

  • Registers a callback which will be triggered when the active tab has been changed.

    Parameters

    • callback: ((tab: BrowserTab) => void)

      The callback which will be triggered when the active tab has been changed

    Returns EventSubscription

onError

  • Registers a callback which will be triggered when the page load results in an error.

    Parameters

    • callback: ((url: string, errorCode: number, errorName: string) => void)

      The callback which will be triggered when the page load results in an error.

        • (url: string, errorCode: number, errorName: string): void

        • Parameters

          • url: string
          • errorCode: number
          • errorName: string

          Returns void

    Returns EventSubscription

onPageFinished

  • Registers a callback which will be triggered when a page has completed loading.

    Parameters

    • callback: ((newUrl: string) => void)

      The callback which will be triggered when a page has completed loaded.

        • (newUrl: string): void

        • Parameters

          • newUrl: string

          Returns void

    Returns EventSubscription

onPageStarted

  • Registers a callback which will be triggered when a new page is being loaded.

    Parameters

    • callback: ((newUrl: string) => void)

      The callback which will be triggered when a new page is being loaded.

        • (newUrl: string): void

        • Parameters

          • newUrl: string

          Returns void

    Returns EventSubscription

onTabClosed

onTabCreated

onUrlChanged

  • Registers a callback which will be triggered when the URL has changed.

    Parameters

    • callback: ((url: string) => void)

      The callback which will be triggered when the URL has changed.

        • (url: string): void

        • Parameters

          • url: string

          Returns void

    Returns EventSubscription

Generated using TypeDoc