Skip to content

ElectronWindow

Unofficial

Extended Electron BrowserWindow with internal properties.

Import:

import type { ElectronWindow } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronWindow extends ElectronBrowserWindow

Extends: ElectronBrowserWindow

Properties

Property Type Description
_browserViews unknown Internal browser views attached to the window.
_events unknown Internal event handlers map.
_eventsCount unknown Number of registered event handlers.
accessibleTitle string An alternative title provided only to accessibility tools such as screen readers. This string is not directly visible to users.
(Inherited from ElectronBrowserWindow)
autoHideMenuBar boolean Whether the window menu bar should hide itself automatically.
(Inherited from ElectronBrowserWindow)
closable boolean Whether the window can be manually closed by user. On Linux the setter is a no-op.
(Inherited from ElectronBrowserWindow)
devToolsWebContents unknown Web contents for the developer tools panel.
documentEdited boolean Whether the window's document has been edited (macOS only).
(Inherited from ElectronBrowserWindow)
excludedFromShownWindowsMenu boolean Whether the window is excluded from the application's Windows menu (macOS only).
(Inherited from ElectronBrowserWindow)
focusable boolean Whether the window is focusable (macOS and Windows).
(Inherited from ElectronBrowserWindow)
fullScreen boolean Whether the window is in fullscreen mode.
(Inherited from ElectronBrowserWindow)
fullScreenable boolean Whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.
(Inherited from ElectronBrowserWindow)
id number The unique identifier of the window, unique among all BrowserWindow instances of the entire application.
(Inherited from ElectronBrowserWindow)
kiosk boolean Whether the window is in kiosk mode.
(Inherited from ElectronBrowserWindow)
maximizable boolean Whether the window can be manually maximized by user. On Linux the setter is a no-op.
(Inherited from ElectronBrowserWindow)
menuBarVisible boolean Whether the menu bar should be visible (Windows and Linux).
(Inherited from ElectronBrowserWindow)
minimizable boolean Whether the window can be manually minimized by user. On Linux the setter is a no-op.
(Inherited from ElectronBrowserWindow)
movable boolean Whether the window can be moved by user. On Linux the setter is a no-op.
(Inherited from ElectronBrowserWindow)
representedFilename string The pathname of the file the window represents (macOS only).
(Inherited from ElectronBrowserWindow)
resizable boolean Whether the window can be manually resized by user.
(Inherited from ElectronBrowserWindow)
shadow boolean Whether the window has a shadow.
(Inherited from ElectronBrowserWindow)
simpleFullScreen boolean Whether the window is in simple (pre-Lion) fullscreen mode.
(Inherited from ElectronBrowserWindow)
title string The title of the native window.
(Inherited from ElectronBrowserWindow)
visibleOnAllWorkspaces boolean Whether the window is visible on all workspaces. Always returns false on Windows.
(Inherited from ElectronBrowserWindow)
webContents ElectronWebContents The web contents owned by this window. All web page related events and operations will be done via it.
(Inherited from ElectronBrowserWindow)

Methods

Method Returns Description
addBrowserView(browserView) void Replacement API for setBrowserView supporting work with multi browser views.
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this Registers a listener for the given window event.
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addListener(event, listener) this
(Inherited from ElectronBrowserWindow)
addTabbedWindow(browserWindow) void Adds a window as a tab on this window, after the tab for the window instance (macOS only).
(Inherited from ElectronBrowserWindow)
blur() void Removes focus from the window.
(Inherited from ElectronBrowserWindow)
blurWebView() void Removes focus from the web view.
(Inherited from ElectronBrowserWindow)
capturePage(rect?) Promise<ElectronNativeImage> Captures a snapshot of the page within rect. Omitting rect will capture the whole visible page.
(Inherited from ElectronBrowserWindow)
center() void Moves window to the center of the screen.
(Inherited from ElectronBrowserWindow)
close() void Tries to close the window. This has the same effect as a user manually clicking the close button.
(Inherited from ElectronBrowserWindow)
closeFilePreview() void Closes the currently open Quick Look panel (macOS only).
(Inherited from ElectronBrowserWindow)
destroy() void Force-closes the window; the unload and beforeunload events won't be emitted, but closed is guaranteed.
(Inherited from ElectronBrowserWindow)
flashFrame(flag) void Starts or stops flashing the window to attract user's attention.
(Inherited from ElectronBrowserWindow)
focus() void Focuses on the window.
(Inherited from ElectronBrowserWindow)
focusOnWebView() void Focuses on the web view.
(Inherited from ElectronBrowserWindow)
fromBrowserView(browserView) ElectronBrowserWindow | null Returns the window that owns the given browserView.
(Inherited from ElectronBrowserWindow)
fromId(id) ElectronBrowserWindow | null Returns the window with the given id.
(Inherited from ElectronBrowserWindow)
fromWebContents(webContents) ElectronBrowserWindow | null Returns the window that owns the given webContents.
(Inherited from ElectronBrowserWindow)
getAllWindows() ElectronBrowserWindow[] Returns all opened browser windows.
(Inherited from ElectronBrowserWindow)
getBackgroundColor() string Returns the background color of the window in Hex (#RRGGBB) format.
(Inherited from ElectronBrowserWindow)
getBounds() ElectronRectangle Returns the bounds of the window.
(Inherited from ElectronBrowserWindow)
getBrowserView() ElectronBrowserView | null Returns the BrowserView attached to this window.
(Inherited from ElectronBrowserWindow)
getBrowserViews() ElectronBrowserView[] Returns all views attached with addBrowserView or setBrowserView.
(Inherited from ElectronBrowserWindow)
getChildWindows() ElectronBrowserWindow[] Returns all child windows.
(Inherited from ElectronBrowserWindow)
getContentBounds() ElectronRectangle Returns the bounds of the window's client area.
(Inherited from ElectronBrowserWindow)
getContentSize() number[] Returns the window's client area's width and height.
(Inherited from ElectronBrowserWindow)
getFocusedWindow() ElectronBrowserWindow | null Returns the window that is focused in this application.
(Inherited from ElectronBrowserWindow)
getMaximumSize() number[] Returns the window's maximum width and height.
(Inherited from ElectronBrowserWindow)
getMediaSourceId() string Returns the window id in the format of DesktopCapturerSource's id.
(Inherited from ElectronBrowserWindow)
getMinimumSize() number[] Returns the window's minimum width and height.
(Inherited from ElectronBrowserWindow)
getNativeWindowHandle() Buffer Returns the platform-specific handle of the window.
(Inherited from ElectronBrowserWindow)
getNormalBounds() ElectronRectangle Returns the window bounds of the normal state, regardless of the current window state.
(Inherited from ElectronBrowserWindow)
getOpacity() number Returns the opacity of the window, between 0.0 (fully transparent) and 1.0 (fully opaque). On Linux, always returns 1.
(Inherited from ElectronBrowserWindow)
getParentWindow() ElectronBrowserWindow | null Returns the parent window.
(Inherited from ElectronBrowserWindow)
getPosition() number[] Returns the window's current position.
(Inherited from ElectronBrowserWindow)
getRepresentedFilename() string Returns the pathname of the file the window represents (macOS only).
(Inherited from ElectronBrowserWindow)
getSize() number[] Returns the window's width and height.
(Inherited from ElectronBrowserWindow)
getTitle() string Returns the title of the native window.
(Inherited from ElectronBrowserWindow)
getTrafficLightPosition() ElectronPoint Returns the custom position for the traffic light buttons in a frameless window (macOS only).
(Inherited from ElectronBrowserWindow)
hasShadow() boolean Returns whether the window has a shadow.
(Inherited from ElectronBrowserWindow)
hide() void Hides the window.
(Inherited from ElectronBrowserWindow)
hookWindowMessage(message, callback) void Hooks a windows message. The callback is called when the message is received in the WndProc (Windows only).
(Inherited from ElectronBrowserWindow)
isAlwaysOnTop() boolean Returns whether the window is always on top of other windows.
(Inherited from ElectronBrowserWindow)
isClosable() boolean Returns whether the window can be manually closed by user. On Linux always returns true (macOS and Windows).
(Inherited from ElectronBrowserWindow)
isDestroyed() boolean Returns whether the window has been destroyed.
(Inherited from ElectronBrowserWindow)
isDocumentEdited() boolean Returns whether the window's document has been edited (macOS only).
(Inherited from ElectronBrowserWindow)
isEnabled() boolean Returns whether the window is enabled.
(Inherited from ElectronBrowserWindow)
isFocusable() void Returns whether the window can be focused (macOS and Windows).
(Inherited from ElectronBrowserWindow)
isFocused() boolean Returns whether the window is focused.
(Inherited from ElectronBrowserWindow)
isFullScreen() boolean Returns whether the window is in fullscreen mode.
(Inherited from ElectronBrowserWindow)
isFullScreenable() boolean Returns whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.
(Inherited from ElectronBrowserWindow)
isKiosk() boolean Returns whether the window is in kiosk mode.
(Inherited from ElectronBrowserWindow)
isMaximizable() boolean Returns whether the window can be manually maximized by user. On Linux always returns true (macOS and Windows).
(Inherited from ElectronBrowserWindow)
isMaximized() boolean Returns whether the window is maximized.
(Inherited from ElectronBrowserWindow)
isMenuBarAutoHide() boolean Returns whether the menu bar automatically hides itself.
(Inherited from ElectronBrowserWindow)
isMenuBarVisible() boolean Returns whether the menu bar is visible.
(Inherited from ElectronBrowserWindow)
isMinimizable() boolean Returns whether the window can be manually minimized by user. On Linux always returns true (macOS and Windows).
(Inherited from ElectronBrowserWindow)
isMinimized() boolean Returns whether the window is minimized.
(Inherited from ElectronBrowserWindow)
isModal() boolean Returns whether the current window is a modal window.
(Inherited from ElectronBrowserWindow)
isMovable() boolean Returns whether the window can be moved by user. On Linux always returns true (macOS and Windows).
(Inherited from ElectronBrowserWindow)
isNormal() boolean Returns whether the window is in normal state (not maximized, not minimized, not in fullscreen mode).
(Inherited from ElectronBrowserWindow)
isResizable() boolean Returns whether the window can be manually resized by user.
(Inherited from ElectronBrowserWindow)
isSimpleFullScreen() boolean Returns whether the window is in simple (pre-Lion) fullscreen mode (macOS only).
(Inherited from ElectronBrowserWindow)
isTabletMode() boolean Returns whether the window is in Windows 10 tablet mode (Windows only).
(Inherited from ElectronBrowserWindow)
isVisible() boolean Returns whether the window is visible to the user.
(Inherited from ElectronBrowserWindow)
isVisibleOnAllWorkspaces() boolean Returns whether the window is visible on all workspaces. Always returns false on Windows.
(Inherited from ElectronBrowserWindow)
isWindowMessageHooked(message) boolean Returns whether the message is hooked (Windows only).
(Inherited from ElectronBrowserWindow)
loadFile(filePath, options?) Promise<void> Loads a file into the window. Same as webContents.loadFile.
(Inherited from ElectronBrowserWindow)
loadURL(url, options?) Promise<void> Loads a URL into the window. Same as webContents.loadURL.
(Inherited from ElectronBrowserWindow)
maximize() void Maximizes the window. This will also show (but not focus) the window if it isn't being displayed already.
(Inherited from ElectronBrowserWindow)
mergeAllWindows() void Merges all windows into one window with multiple tabs when native tabs are enabled (macOS only).
(Inherited from ElectronBrowserWindow)
minimize() void Minimizes the window. On some platforms the minimized window will be shown in the Dock.
(Inherited from ElectronBrowserWindow)
moveAbove(mediaSourceId) void Moves window above the source window in the sense of z-order.
(Inherited from ElectronBrowserWindow)
moveTabToNewWindow() void Moves the current tab into a new window if native tabs are enabled and there is more than one tab (macOS only).
(Inherited from ElectronBrowserWindow)
moveTop() void Moves window to top (z-order) regardless of focus.
(Inherited from ElectronBrowserWindow)
on('always-on-top-changed', listener) this Registers a listener for the given window event.
(Inherited from ElectronBrowserWindow)
on('app-command', listener) this
(Inherited from ElectronBrowserWindow)
on('blur', listener) this
(Inherited from ElectronBrowserWindow)
on('close', listener) this
(Inherited from ElectronBrowserWindow)
on('closed', listener) this
(Inherited from ElectronBrowserWindow)
on('enter-full-screen', listener) this
(Inherited from ElectronBrowserWindow)
on('enter-html-full-screen', listener) this
(Inherited from ElectronBrowserWindow)
on('focus', listener) this
(Inherited from ElectronBrowserWindow)
on('hide', listener) this
(Inherited from ElectronBrowserWindow)
on('leave-full-screen', listener) this
(Inherited from ElectronBrowserWindow)
on('leave-html-full-screen', listener) this
(Inherited from ElectronBrowserWindow)
on('maximize', listener) this
(Inherited from ElectronBrowserWindow)
on('minimize', listener) this
(Inherited from ElectronBrowserWindow)
on('move', listener) this
(Inherited from ElectronBrowserWindow)
on('moved', listener) this
(Inherited from ElectronBrowserWindow)
on('new-window-for-tab', listener) this
(Inherited from ElectronBrowserWindow)
on('page-title-updated', listener) this
(Inherited from ElectronBrowserWindow)
on('ready-to-show', listener) this
(Inherited from ElectronBrowserWindow)
on('resize', listener) this
(Inherited from ElectronBrowserWindow)
on('resized', listener) this
(Inherited from ElectronBrowserWindow)
on('responsive', listener) this
(Inherited from ElectronBrowserWindow)
on('restore', listener) this
(Inherited from ElectronBrowserWindow)
on('rotate-gesture', listener) this
(Inherited from ElectronBrowserWindow)
on('scroll-touch-begin', listener) this
(Inherited from ElectronBrowserWindow)
on('scroll-touch-edge', listener) this
(Inherited from ElectronBrowserWindow)
on('scroll-touch-end', listener) this
(Inherited from ElectronBrowserWindow)
on('session-end', listener) this
(Inherited from ElectronBrowserWindow)
on('sheet-begin', listener) this
(Inherited from ElectronBrowserWindow)
on('sheet-end', listener) this
(Inherited from ElectronBrowserWindow)
on('show', listener) this
(Inherited from ElectronBrowserWindow)
on('swipe', listener) this
(Inherited from ElectronBrowserWindow)
on('system-context-menu', listener) this
(Inherited from ElectronBrowserWindow)
on('unmaximize', listener) this
(Inherited from ElectronBrowserWindow)
on('unresponsive', listener) this
(Inherited from ElectronBrowserWindow)
on('will-move', listener) this
(Inherited from ElectronBrowserWindow)
on('will-resize', listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this Registers a one-time listener for the given window event.
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
once(event, listener) this
(Inherited from ElectronBrowserWindow)
previewFile(path, displayName?) void Uses Quick Look to preview a file at a given path (macOS only).
(Inherited from ElectronBrowserWindow)
reload() void Reloads the current page. Same as webContents.reload.
(Inherited from ElectronBrowserWindow)
removeBrowserView(browserView) void Removes a view added with addBrowserView or setBrowserView.
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this Removes a listener for the given window event.
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeListener(event, listener) this
(Inherited from ElectronBrowserWindow)
removeMenu() void Removes the window's menu bar (Linux and Windows).
(Inherited from ElectronBrowserWindow)
restore() void Restores the window from minimized state to its previous state.
(Inherited from ElectronBrowserWindow)
selectNextTab() void Selects the next tab when native tabs are enabled and there are other tabs in the window (macOS only).
(Inherited from ElectronBrowserWindow)
selectPreviousTab() void Selects the previous tab when native tabs are enabled and there are other tabs in the window (macOS only).
(Inherited from ElectronBrowserWindow)
setAlwaysOnTop(flag, level?, relativeLevel?) void Sets whether the window should show always on top of other windows.
(Inherited from ElectronBrowserWindow)
setAppDetails(options) void Sets the properties for the window's taskbar button (Windows only).
(Inherited from ElectronBrowserWindow)
setAspectRatio(aspectRatio, extraSize?) void Makes the window maintain an aspect ratio.
(Inherited from ElectronBrowserWindow)
setAutoHideCursor(autoHide) void Controls whether to hide the cursor when typing (macOS only).
(Inherited from ElectronBrowserWindow)
setAutoHideMenuBar(hide) void Sets whether the window menu bar should hide itself automatically.
(Inherited from ElectronBrowserWindow)
setBackgroundColor(backgroundColor) void Sets the background color of the window.
(Inherited from ElectronBrowserWindow)
setBounds(bounds, animate?) void Resizes and moves the window to the supplied bounds. Any properties not supplied default to their current values.
(Inherited from ElectronBrowserWindow)
setBrowserView(browserView) void Sets the view attached to the window.
(Inherited from ElectronBrowserWindow)
setClosable(closable) void Sets whether the window can be manually closed by user. On Linux does nothing (macOS and Windows).
(Inherited from ElectronBrowserWindow)
setContentBounds(bounds, animate?) void Resizes and moves the window's client area to the supplied bounds.
(Inherited from ElectronBrowserWindow)
setContentProtection(enable) void Prevents the window contents from being captured by other apps (macOS and Windows).
(Inherited from ElectronBrowserWindow)
setContentSize(width, height, animate?) void Resizes the window's client area to width and height.
(Inherited from ElectronBrowserWindow)
setDocumentEdited(edited) void Specifies whether the window's document has been edited (macOS only).
(Inherited from ElectronBrowserWindow)
setEnabled(enable) void Disables or enables the window.
(Inherited from ElectronBrowserWindow)
setFocusable(focusable) void Changes whether the window can be focused (macOS and Windows).
(Inherited from ElectronBrowserWindow)
setFullScreen(flag) void Sets whether the window should be in fullscreen mode.
(Inherited from ElectronBrowserWindow)
setFullScreenable(fullscreenable) void Sets whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.
(Inherited from ElectronBrowserWindow)
setHasShadow(hasShadow) void Sets whether the window should have a shadow.
(Inherited from ElectronBrowserWindow)
setIcon(icon) void Changes the window icon (Linux and Windows).
(Inherited from ElectronBrowserWindow)
setIgnoreMouseEvents(ignore, options?) void Makes the window ignore all mouse events.
(Inherited from ElectronBrowserWindow)
setKiosk(flag) void Enters or leaves kiosk mode.
(Inherited from ElectronBrowserWindow)
setMaximizable(maximizable) void Sets whether the window can be manually maximized by user. On Linux does nothing (macOS and Windows).
(Inherited from ElectronBrowserWindow)
setMaximumSize(width, height) void Sets the maximum size of the window.
(Inherited from ElectronBrowserWindow)
setMenu(menu) void Sets the menu as the window's menu bar (Linux and Windows).
(Inherited from ElectronBrowserWindow)
setMenuBarVisibility(visible) void Sets whether the menu bar should be visible (Linux and Windows).
(Inherited from ElectronBrowserWindow)
setMinimizable(minimizable) void Sets whether the window can be manually minimized by user. On Linux does nothing (macOS and Windows).
(Inherited from ElectronBrowserWindow)
setMinimumSize(width, height) void Sets the minimum size of the window.
(Inherited from ElectronBrowserWindow)
setMovable(movable) void Sets whether the window can be moved by user. On Linux does nothing (macOS and Windows).
(Inherited from ElectronBrowserWindow)
setOpacity(opacity) void Sets the opacity of the window. On Linux, does nothing. Out of bound values are clamped to the [0, 1] range.
(Inherited from ElectronBrowserWindow)
setOverlayIcon(overlay, description) void Sets a 16 x 16 pixel overlay onto the current taskbar icon (Windows only).
(Inherited from ElectronBrowserWindow)
setParentWindow(parent) void Sets the parent window. Passing null will turn the current window into a top-level window.
(Inherited from ElectronBrowserWindow)
setPosition(x, y, animate?) void Moves the window to x and y.
(Inherited from ElectronBrowserWindow)
setProgressBar(progress, options?) void Sets the progress value in the progress bar. Valid range is [0, 1.0].
(Inherited from ElectronBrowserWindow)
setRepresentedFilename(filename) void Sets the pathname of the file the window represents (macOS only).
(Inherited from ElectronBrowserWindow)
setResizable(resizable) void Sets whether the window can be manually resized by user.
(Inherited from ElectronBrowserWindow)
setShape(rects) void Sets a window shape determining the area within the window where drawing and user interaction are permitted (Linux and Windows).
(Inherited from ElectronBrowserWindow)
setSheetOffset(offsetY, offsetX?) void Changes the attachment point for sheets on macOS (macOS only).
(Inherited from ElectronBrowserWindow)
setSimpleFullScreen(flag) void Enters or leaves simple fullscreen mode (macOS only).
(Inherited from ElectronBrowserWindow)
setSize(width, height, animate?) void Resizes the window to width and height.
(Inherited from ElectronBrowserWindow)
setSkipTaskbar(skip) void Makes the window not show in the taskbar.
(Inherited from ElectronBrowserWindow)
setThumbarButtons(buttons) boolean Adds a thumbnail toolbar with a specified set of buttons to the thumbnail image of a window (Windows only).
(Inherited from ElectronBrowserWindow)
setThumbnailClip(region) void Sets the region of the window to show as the thumbnail image displayed when hovering over the window in the taskbar (Windows only).
(Inherited from ElectronBrowserWindow)
setThumbnailToolTip(toolTip) void Sets the tooltip displayed when hovering over the window thumbnail in the taskbar (Windows only).
(Inherited from ElectronBrowserWindow)
setTitle(title) void Changes the title of the native window.
(Inherited from ElectronBrowserWindow)
setTitleBarOverlay(options) void On a window with Window Controls Overlay already enabled, updates the style of the title bar overlay (Windows only).
(Inherited from ElectronBrowserWindow)
setTopBrowserView(browserView) void Raises browserView above other views attached to the window.
(Inherited from ElectronBrowserWindow)
setTouchBar(touchBar) void Sets the touch bar layout for the current window. Specifying null or undefined clears the touch bar (macOS only).
(Inherited from ElectronBrowserWindow)
setTrafficLightPosition(position) void Sets a custom position for the traffic light buttons in a frameless window (macOS only).
(Inherited from ElectronBrowserWindow)
setVibrancy(type) void Adds a vibrancy effect to the browser window. Passing null or an empty string removes the effect (macOS only).
(Inherited from ElectronBrowserWindow)
setVisibleOnAllWorkspaces(visible, options?) void Sets whether the window should be visible on all workspaces. Does nothing on Windows.
(Inherited from ElectronBrowserWindow)
setWindowButtonVisibility(visible) void Sets whether the window traffic light buttons should be visible (macOS only).
(Inherited from ElectronBrowserWindow)
show() void Shows and gives focus to the window.
(Inherited from ElectronBrowserWindow)
showDefinitionForSelection() void Shows the definition for the selected word (macOS only). Same as webContents.showDefinitionForSelection().
(Inherited from ElectronBrowserWindow)
showInactive() void Shows the window but doesn't focus on it.
(Inherited from ElectronBrowserWindow)
toggleTabBar() void Toggles the visibility of the tab bar if native tabs are enabled and there is only one tab (macOS only).
(Inherited from ElectronBrowserWindow)
unhookAllWindowMessages() void Unhooks all of the window messages (Windows only).
(Inherited from ElectronBrowserWindow)
unhookWindowMessage(message) void Unhooks the window message (Windows only).
(Inherited from ElectronBrowserWindow)
unmaximize() void Unmaximizes the window.
(Inherited from ElectronBrowserWindow)

Links to this page: