window(ウィンドウ)
プラグインウィンドウを表示、非表示、フルスクリーンなどのさまざまな操作を制御します。
以下は window
の一般的な機能の例です:
await eagle.window.show(); // プラグインウィンドウを表示する
await eagle.window.hide(); // プラグインウィンドウを隠す
await eagle.window.minimize(); // ウィンドウを最小化する
await eagle.window.restore(); // 最小化を元に戻す
await eagle.window.maximize(); // ウィンドウを最大化する
await eagle.window.unmaximize(); // 最大化を元に戻す
await eagle.window.setFullScreen(true); // フルスクリーンに設定する
await eagle.window.setFullScreen(false); // フルスクリーンを終了する
メソッド
show()
ウィンドウを表示し、フォーカスします。
戻り値
Promise<>
await eagle.window.show();
showInactive()
ウィンドウを表示しますが、フォーカスしません。
戻り値
Promise<>
await eagle.window.showInactive();
hide()
プラグインウィンドウを非表示にします。
戻り値
Promise<>
await eagle.window.hide();
focus()
プラグインウィンドウにフォーカスします。
戻り値
Promise<>
await eagle.window.focus();
minimize()
プラグインウィンドウを最小化します。
戻り値
Promise<>
await eagle.window.minimize();
isMinimized()
ウィンドウが最小化されているかどうかを判断します。
戻り値
Promise<minimized: boolean>
minimized
boolean - ウィンドウが最小化されているかどうか
let isMinimized = await eagle.window.isMinimized();
restore()
プラグインウィンドウを最小化状態から元の状態に戻します。
戻り値
Promise<>
await eagle.window.restore();
maximize()
プラグインウィンドウを最大化します。ウィンドウがまだ表示されていない場合、このメソッドはそれを表示します(ただし、フォーカスはしません)。
戻り値
Promise<>
await eagle.window.maximize();
unmaximize()
プラグインウィンドウの最大化を解除します
戻り値
Promise<>
await eagle.window.unmaximize();
isMaximized()
ウィンドウが最大化されているかどうかを判断します
戻り値
Promise<maximized: boolean>
maximized
boolean - ウィンドウが最大化されているかどうか
let isMaximized = await eagle.window.isMaximized();
setFullScreen(flag)
ウィンドウが全画面モードにするかどうかを設定します。
flag
boolean - 全画面にするかどうか返り値
Promise<>
await eagle.window.setFullScreen(true); // 全画面に入る
await eagle.window.setFullScreen(false); // 全画面から退出
isFullScreen()
ウィンドウが全画面かどうかを判断します。
返り値
Promise<fullscreen: boolean>
fullscreen
boolean - ウィンドウが全画面かどうか
let isMaximized = await eagle.window.isMaximized();
setAspectRatio(aspectRatio)
ウィンドウのアスペクト比を保持します。
aspectRatio
Float - 保持するアスペクト比(幅 / 高さ)返り値
Promise<>
await eagle.window.setAspectRatio(16/9); // ウィンドウのアスペクト比を 16:9 に制限
setBackgroundColor(backgroundColor)
ウィンドウの背景色を設定します。
backgroundColor
String - このパラメーターは、希望する背景色のHEXコードを表します。 Promise<>を返します。返り値
Promise<>
await eagle.window.setBackgroundColor("#FFFFFF");
setSize(width, height)
ウィンドウのサイズを設定します。
width
Integer - ウィンドウの幅height
- Integer - ウィンドウの高さ返り値
Promise<>
await eagle.window.setSize(720, 480);
getSize()
ウィンドウのサイズを取得します。
返り値
Promise<Integer[]>
await eagle.window.getSize();
setBounds(bounds)
ウィンドウのサイズを調整し、指定された境界に移動します。提供されていない属性は、現在の値がデフォルトとなります。
await eagle.window.setBounds({ x: 440, y: 225, width: 800, height: 600 })
getBounds()
ウィンドウの境界を取得します。
返り値
Promise<Rectangle[]>
- ウィンドウ境界のオブジェクト
await eagle.window.getBounds()
setResizable(resizable)
ウィンドウのサイズを調整できるかどうかを設定します。
resizable
boolean - サイズを調整できるかどうか返り値
Promise<>
await eagle.window.setResizable(true);
await eagle.window.setResizable(false);
isResizable()
ウィンドウのサイズを調整できるかどうかを判断します。
返り値
Promise<resizable: boolean>
resizable
boolean
let isResizable = await eagle.window.isResizable();
setAlwaysOnTop(flag)
ウィンドウが常に他のウィンドウの前に表示されるかどうかを設定します。
flag
boolean返り値
Promise<>
await eagle.window.setAlwaysOnTop(true);
await eagle.window.setAlwaysOnTop(false);
isAlwaysOnTop()
ウィンドウが常に他のウィンドウの前に表示されるかどうかを判断します。
返り値
Promise<alwaysOnTop: boolean>
alwaysOnTop
boolean
let isAlwaysOnTop = await eagle.window.isAlwaysOnTop();
setPosition(x, y)
ウィンドウを x と y に移動します。
x
Integery
Integer返り値
Promise<>
await eagle.window.setPosition(100, 200);
getPosition()
プラグインウィンドウの座標 x と y を取得します。
返り値
Promise<position: Integer[]>
position
Integer[]x - position[0]
y - position[1]
let position = await eagle.window.getPosition(); // [100, 200]
setOpacity(opacity)
ウィンドウの不透明度を設定します。範囲外の値は、[0, 1]の範囲に制限されます。
opacity
number - 0.0(完全に透明)と1.0(完全に不透明)の間返り値
Promise<>
await eagle.window.setOpacity(0.5);
getOpacity()
ウィンドウの透明度を取得します。0.0(完全に透明)から1.0(完全に不透明)の間。
返り値
Promise<opacity: number>
opacity
number
let opacity = await eagle.window.getOpacity();
flashFrame(flag)
ウィンドウのフレームの点滅を開始または停止して、ユーザーの注意を引きます。
flag
boolean - 点滅するかどうか返り値
Promise<>
await eagle.window.flashFrame(true);
await eagle.window.flashFrame(false);
setIgnoreMouseEvents(ignore)
ウィンドウ内のすべてのマウスイベントを無視します。このウィンドウで発生するすべてのマウスイベントは、このウィンドウの下のウィンドウに渡されますが、このウィンドウがフォーカスを持っている場合、キーボードイベントは引き続き受け取ります。
ignore
boolean - マウスイベントを無視するかどうか返り値
Promise<>
await eagle.window.setIgnoreMouseEvents(true);
await eagle.window.setIgnoreMouseEvents(false);
capturePage(rect)
指定された rect
エリア内のページのスナップショットをキャプチャします。rect
を省略すると、表示されているページ全体をキャプチャします。
rect
オブジェクト - 任意、スクリーンショット範囲x
数値y
数値width
数値height
数値
返り値
Promise<[NativeImage](https://www.electronjs.org/docs/latest/api/native-image)>
const image = await eagle.window.capturePage();
const base64 = image.toDataURL("image/jpeg");
const image2 = await eagle.window.capturePage({ x: 0, y: 0, width: 100, height: 50 });
const buffer = image2.toPNG();
setReferer(url)
関数は現在のリファラーURLを設定するために使用されます。リファラーが設定されると、その後のリクエストはこのリファラーを使用します。
url
string - リファラーのURL返り値
void
eagle.window.setReferer("https://jp.eagle.cool");
最終更新