説明
chrome.app.window
API を使用してウィンドウを作成します。ウィンドウには、タイトルバーとサイズ コントロールを備えたオプションのフレームがあります。Chrome ブラウザ ウィンドウには関連付けられていません。これらのオプションのデモについては、ウィンドウ状態のサンプルをご覧ください。
型
AppWindow
プロパティ
-
contentWindow
ウィンドウ
作成される子の JavaScript 「window」オブジェクト。
-
id
string
ウィンドウの作成に使用された ID。
-
innerBounds
ウィンドウの装飾を含まない、ウィンドウのコンテンツの位置、サイズ、制約。このプロパティは Chrome 36 で新しく導入されました。
-
outerBounds
タイトルバーやフレームなどのウィンドウの装飾を含む、ウィンドウの位置、サイズ、制約。このプロパティは Chrome 36 で新しく導入されました。
-
clearAttention
void
窓にはっきりと目を向けましょう。
clearAttention
関数は次のようになります。() => {...}
-
閉じる
void
ウィンドウを閉じます。
close
関数は次のようになります。() => {...}
-
drawAttention
void
窓に注意を向けてください。
drawAttention
関数は次のようになります。() => {...}
-
ピント
void
ウィンドウにフォーカスする。
focus
関数は次のようになります。() => {...}
-
全画面表示
void
ウィンドウを全画面表示します。
ユーザーは Esc キーを押してウィンドウを復元できます。アプリケーションで
app.window.fullscreen.overrideEsc
権限をリクエストし、keydown ハンドラと keyup ハンドラで .preventDefault() を呼び出してイベントをキャンセルすることで、ESC が押されたときに全画面表示の状態が残らないようにすることができます。次に例を示します。window.onkeydown = window.onkeyup = function(e) { if (e.keyCode == 27 /* ESC *\/) { e.preventDefault(); } };
window.fullscreen()
はウィンドウ全体を全画面表示にし、ユーザー操作を必要としません。HTML5 Fullscreen API を使用して全画面モードにすることもできます(詳しくは、ウェブ API をご覧ください)。fullscreen
関数は次のようになります。() => {...}
-
getBounds
void
非推奨innerBounds または outerBounds を使用します。
ウィンドウの内部境界を
ContentBounds
オブジェクトとして取得します。getBounds
関数は次のようになります。() => {...}
-
非表示
void
ウィンドウを非表示にする。ウィンドウがすでに非表示の場合は、何もしません。
hide
関数は次のようになります。() => {...}
-
isAlwaysOnTop
void
ウィンドウは常に上に表示されますか?
isAlwaysOnTop
関数は次のようになります。() => {...}
-
戻り値
boolean
-
-
isFullscreen
void
ウィンドウは全画面表示になっていますか?ウィンドウが全画面表示になっているか、
AppWindow
または HTML5 Fullscreen API によって全画面になっている場合は、これに該当します。isFullscreen
関数は次のようになります。() => {...}
-
戻り値
boolean
-
-
isMaximized
void
ウィンドウは最大化されていますか?
isMaximized
関数は次のようになります。() => {...}
-
戻り値
boolean
-
-
isMinimized
void
ウィンドウは最小化されていますか?
isMinimized
関数は次のようになります。() => {...}
-
戻り値
boolean
-
-
最大化
void
ウィンドウを最大化します。
maximize
関数は次のようになります。() => {...}
-
最小化
void
ウィンドウを最小化します。
minimize
関数は次のようになります。() => {...}
-
moveTo
void
Chrome 43 以降でサポートが終了outerBounds を使用します。
ウィンドウを位置(
left
、top
)に移動します。moveTo
関数は次のようになります。(left: number, top: number) => {...}
-
左
数値
-
上
数値
-
-
resizeTo
void
Chrome 43 以降でサポートが終了outerBounds を使用します。
ウィンドウのサイズを
width
xheight
ピクセルに変更します。resizeTo
関数は次のようになります。(width: number, height: number) => {...}
-
幅
数値
-
身長
数値
-
-
restore
void
最大化、最小化、または全画面表示の状態を終了して、ウィンドウを復元します。
restore
関数は次のようになります。() => {...}
-
setAlwaysOnTop
void
ウィンドウを他のほとんどのウィンドウより上に維持するかどうかを設定します。
alwaysOnTopWindows
のアクセス許可を得る必要があります。setAlwaysOnTop
関数は次のようになります。(alwaysOnTop: boolean) => {...}
-
alwaysOnTop
boolean
-
-
setBounds
void
非推奨innerBounds または outerBounds を使用します。
ウィンドウの内側の境界を設定します。
setBounds
関数は次のようになります。(bounds: ContentBounds) => {...}
-
bounds
-
-
setVisibleOnAllWorkspaces
void
すべてのワークスペースでウィンドウを表示するかどうかを設定します。(これをサポートするプラットフォームのみ)。
setVisibleOnAllWorkspaces
関数は次のようになります。(alwaysVisible: boolean) => {...}
-
alwaysVisible
boolean
-
-
表示する
void
ウィンドウを表示します。ウィンドウがすでに表示されている場合は、何もしません。
focused
が true に設定されているか省略されている場合は、ウィンドウにフォーカスします。show
関数は次のようになります。(focused?: boolean) => {...}
-
手厚い支援
ブール値(省略可)
-
Bounds
プロパティ
-
身長
数値
このプロパティを使用すると、コンテンツやウィンドウの現在の高さを読み書きできます。
-
左
数値
このプロパティを使用すると、コンテンツまたはウィンドウの現在の X 座標を読み書きできます。
-
maxHeight
number(省略可)
このプロパティを使用すると、コンテンツやウィンドウの現在の最大高さを読み書きできます。値
null
は「未指定」を示します。 -
maxWidth
number(省略可)
このプロパティを使用すると、コンテンツやウィンドウの現在の最大幅を読み書きできます。値
null
は「未指定」を示します。 -
minHeight
number(省略可)
このプロパティを使用すると、コンテンツやウィンドウの現在の最小の高さを読み書きできます。値
null
は「未指定」を示します。 -
minWidth
number(省略可)
このプロパティを使用すると、コンテンツやウィンドウの現在の最小幅の読み取りと書き込みを行うことができます。値
null
は「未指定」を示します。 -
上
数値
このプロパティを使用すると、コンテンツまたはウィンドウの現在の Y 座標を読み書きできます。
-
幅
数値
このプロパティを使用すると、コンテンツやウィンドウの現在の幅を読み書きできます。
-
setMaximumSize
void
コンテンツまたはウィンドウの最大サイズの制約を設定します。最大の幅または最大の高さを
null
に設定すると、制約を削除できます。値をundefined
にすると、制約は変更されません。setMaximumSize
関数は次のようになります。(maxWidth: number, maxHeight: number) => {...}
-
maxWidth
数値
-
maxHeight
数値
-
-
setMinimumSize
void
コンテンツまたはウィンドウの最小サイズ制約を設定します。最小の幅または高さを
null
に設定すると、制約を削除できます。値をundefined
にすると、制約は変更されません。setMinimumSize
関数は次のようになります。(minWidth: number, minHeight: number) => {...}
-
minWidth
数値
-
minHeight
数値
-
-
setPosition
void
コンテンツまたはウィンドウの左位置と上位置を設定します。
setPosition
関数は次のようになります。(left: number, top: number) => {...}
-
左
数値
-
上
数値
-
-
setSize
void
コンテンツまたはウィンドウの幅と高さを設定します。
setSize
関数は次のようになります。(width: number, height: number) => {...}
-
幅
数値
-
身長
数値
-
BoundsSpecification
プロパティ
-
身長
number(省略可)
コンテンツまたはウィンドウの高さ。
-
左
number(省略可)
コンテンツまたはウィンドウの X 座標。
-
maxHeight
number(省略可)
コンテンツまたはウィンドウの最大の高さ。
-
maxWidth
number(省略可)
コンテンツまたはウィンドウの最大幅。
-
minHeight
number(省略可)
コンテンツまたはウィンドウの最小の高さ。
-
minWidth
number(省略可)
コンテンツまたはウィンドウの最小幅。
-
上
number(省略可)
コンテンツまたはウィンドウの Y 座標。
-
幅
number(省略可)
コンテンツまたはウィンドウの幅。
ContentBounds
プロパティ
-
身長
number(省略可)
-
左
number(省略可)
-
上
number(省略可)
-
幅
number(省略可)
CreateWindowOptions
プロパティ
-
alwaysOnTop
ブール値(省略可)
true の場合、ウィンドウは他のほとんどのウィンドウより上に表示されます。このようなウィンドウが複数ある場合は、現在フォーカスされているウィンドウがフォアグラウンドに表示されます。
alwaysOnTopWindows
権限が必要です。デフォルトは false です。作成後にこのプロパティを変更するには、ウィンドウで
setAlwaysOnTop()
を呼び出します。 -
bounds
ContentBounds 省略可
非推奨innerBounds または outerBounds を使用します。
ウィンドウ内のコンテンツのサイズと位置(タイトルバーを除く)。id も指定されていて、一致する ID を持つウィンドウが以前に表示された場合は、ウィンドウの記憶された境界が代わりに使用されます。
-
手厚い支援
ブール値(省略可)
true の場合、ウィンドウは作成時にフォーカスされます。デフォルトは true です。
-
フレーム
string | FrameOptions 省略可
フレームタイプ:
none
またはchrome
(デフォルトはchrome
)。none
では、-webkit-app-region
CSS プロパティを使用して、アプリのウィンドウにドラッグ可能にすることができます。-webkit-app-region: drag
を使用すると、領域をドラッグ可能としてマークできます。no-drag
を使用すると、ネストされた要素でこのスタイルを無効にできます。FrameOptions
の使用は M36 で新たに導入されました。 -
ブール値(省略可)
true の場合、ウィンドウは非表示の状態で作成されます。作成されたウィンドウを表示するには、show() を呼び出します。デフォルトは false です。
-
アイコン
string(省略可)
Chrome 54 以降ウィンドウ アイコンの URL。showInShelf が true に設定されている場合、ウィンドウに独自のアイコンを設定できます。URL はグローバル URL または拡張機能のローカル URL にする必要があります。
-
id
string(省略可)
ウィンドウを識別する ID。ウィンドウのサイズと位置を記憶し、同じ ID のウィンドウを後で開いたときにそのジオメトリを復元するために使用します。ある特定の ID のウィンドウが作成されたときに、同じ ID の別のウィンドウがすでに存在する場合は、新しいウィンドウを作成する代わりに、現在開いているウィンドウがフォーカスされます。
-
innerBounds
BoundsSpecification(省略可)
ウィンドウ コンテンツの初期位置、初期サイズ、制約(ウィンドウの装飾を除く)を指定するために使用します。
id
も指定されていて、id
が一致するウィンドウが以前に表示された場合は、記憶された境界が代わりに使用されます。内側と外側の境界の間のパディングは OS によって決定されます。そのため、
innerBounds
とouterBounds
の両方に同じ境界プロパティを設定すると、エラーが発生します。このプロパティは Chrome 36 で新しく導入されました。
-
maxHeight
number(省略可)
非推奨innerBounds または outerBounds を使用します。
ウィンドウの最大の高さ。
-
maxWidth
number(省略可)
非推奨innerBounds または outerBounds を使用します。
ウィンドウの最大幅。
-
minHeight
number(省略可)
非推奨innerBounds または outerBounds を使用します。
ウィンドウの最小の高さ。
-
minWidth
number(省略可)
非推奨innerBounds または outerBounds を使用します。
ウィンドウの最小幅。
-
outerBounds
BoundsSpecification(省略可)
ウィンドウの初期位置、初期サイズ、制約(タイトルバーやフレームなどのウィンドウの装飾を含む)を指定するために使用します。
id
も指定されていて、id
が一致するウィンドウが以前に表示された場合は、記憶された境界が代わりに使用されます。内側と外側の境界の間のパディングは OS によって決定されます。そのため、
innerBounds
とouterBounds
の両方に同じ境界プロパティを設定すると、エラーが発生します。このプロパティは Chrome 36 で新しく導入されました。
-
resizable
ブール値(省略可)
true の場合、ユーザーがウィンドウのサイズを変更できます。デフォルトは true です。
-
showInShelf
ブール値(省略可)
Chrome 54 以降true の場合、ウィンドウには独自のシェルフ アイコンが表示されます。それ以外の場合は、アプリに関連付けられている他のウィンドウとともにシェルフでグループ化されます。デフォルトは false です。showInShelf が true に設定されている場合は、ウィンドウの ID を指定する必要があります。
-
シングルトン
ブール値(省略可)
非推奨同じ ID を持つ複数のウィンドウはサポートされなくなりました。
デフォルトでは、ウィンドウに ID を指定すると、同じ ID を持つ別のウィンドウが存在しない場合にのみウィンドウが作成されます。同じ ID のウィンドウがすでに存在する場合、そのウィンドウがアクティブになります。同じ ID で複数のウィンドウを作成する場合は、このプロパティを false に設定します。
-
state
都道府県 省略可
ウィンドウの初期状態。すでに全画面表示、最大化、または最小化されています。デフォルトは「normal」です。
-
type
WindowType 省略可
Chrome 45 以降 Chrome 69 以降、非推奨すべてのアプリ ウィンドウが「シェル」のウィンドウ タイプを使用する
作成するウィンドウのタイプ。
-
visibleOnAllWorkspaces
ブール値(省略可)
true で、プラットフォームでサポートされている場合は、すべてのワークスペースにウィンドウが表示されます。
FrameOptions
プロパティ
-
activeColor
string(省略可)
アクティブなときのウィンドウのフレームの色を設定します。フレームの色は、フレームタイプが
chrome
の場合にのみ使用できます。フレームの色は、フレームタイプが
chrome
の場合にのみ使用できます。フレームの色は Chrome 36 で新たに導入されました。
-
color
string(省略可)
フレームの色を設定できます。フレームの色は、フレームタイプが
chrome
の場合にのみ使用できます。フレームの色は Chrome 36 で新たに導入されました。
-
inactiveColor
string(省略可)
アクティブでないときのウィンドウのフレームの色をアクティブ カラーとは異なるように設定します。フレームの色は、フレームタイプが
chrome
の場合にのみ使用できます。inactiveColor
はcolor
と組み合わせて使用する必要があります。フレームの色は Chrome 36 で新たに導入されました。
-
type
string(省略可)
フレームタイプ:
none
またはchrome
(デフォルトはchrome
)。none
では、-webkit-app-region
CSS プロパティを使用して、アプリのウィンドウにドラッグ可能性を適用できます。-webkit-app-region: drag
を使用すると、領域をドラッグ可能としてマークできます。no-drag
を使用すると、ネストされた要素でこのスタイルを無効にできます。
State
ウィンドウの状態: 標準、全画面表示、最大化、最小化
列挙型
"normal"
WindowType
作成するウィンドウのタイプを指定します。
列挙型
"shell"
デフォルトのウィンドウ タイプ。
"panel"
OS 管理ウィンドウ(非推奨)。
メソッド
canSetVisibleOnAllWorkspaces()
chrome.app.window.canSetVisibleOnAllWorkspaces()
現在のプラットフォームが、すべてのワークスペースに表示されるウィンドウをサポートしているかどうか。
戻り値
-
boolean
create()
chrome.app.window.create(
url: string,
options?: CreateWindowOptions,
callback?: function,
)
ウィンドウのサイズと位置は、さまざまな方法で指定できます。最も簡単なオプションは、何も指定しないことです。その場合は、デフォルトのサイズとプラットフォームに依存する位置が使用されます。
ウィンドウの位置、サイズ、制約を設定するには、innerBounds
プロパティまたは outerBounds
プロパティを使用します。内側の境界にウィンドウの装飾は含まれません。外側の境界には、ウィンドウのタイトルバーとフレームが含まれます。内側と外側の境界の間のパディングは OS によって決定されます。そのため、内側と外側の両方に同じプロパティを設定すると、エラーとみなされます(たとえば、innerBounds.left
と outerBounds.left
の両方を設定した場合)。
ウィンドウの位置を自動的に記憶するには、ウィンドウに ID を割り当てます。ウィンドウに ID が設定されている場合、移動やサイズ変更が行われるたびに、この ID を使用してウィンドウのサイズと位置が記憶されます。このサイズと位置は、同じ ID のウィンドウが次に開くときに、指定された境界の代わりに使用されます。記憶されているデフォルト以外の場所にある ID を持つウィンドウを開く必要がある場合は、非表示にし、目的の場所に移動してから表示します。
パラメータ
-
url
string
-
オプション
-
callback
関数(省略可)
callback
パラメータは次のようになります。(createdWindow: AppWindow) => void
-
createdWindow
-
戻り値
-
Promise<AppWindow>
Chrome 117 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
current()
chrome.app.window.current()
現在のスクリプト コンテキスト(JavaScript の「window」オブジェクト)の AppWindow
オブジェクトを返します。また、別のページのスクリプト コンテキストのハンドルで呼び出すこともできます(例: otherWindow.chrome.app.window.current())。
戻り値
-
AppWindow | 未定義
get()
chrome.app.window.get(
id: string,
)
指定された ID の AppWindow
を取得します。指定された ID を持つウィンドウが存在しない場合は null が返されます。この方法は Chrome 33 で新たに導入されました。
パラメータ
-
id
string
戻り値
-
AppWindow | 未定義
getAll()
chrome.app.window.getAll()
現在作成されているすべてのアプリ ウィンドウの配列を取得します。この方法は Chrome 33 で新たに導入されました。
戻り値
イベント
onBoundsChanged
chrome.app.window.onBoundsChanged.addListener(
callback: function,
)
ウィンドウのサイズが変更されたときに呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。() => void
onClosed
chrome.app.window.onClosed.addListener(
callback: function,
)
ウィンドウが閉じられたときに呼び出されます。なお、このメソッドは、閉じているウィンドウ以外のウィンドウ(バックグラウンド ページなど)からリッスンする必要があります。これは、イベントが発生したときに、閉じるウィンドウが破棄されるプロセスであるためです。つまり、ウィンドウのスクリプト コンテキストのすべての API が機能するわけではないからです。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。() => void
onFullscreened
chrome.app.window.onFullscreened.addListener(
callback: function,
)
ウィンドウが(AppWindow
API または HTML5 API を介して)全画面表示されたときに呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。() => void
onMaximized
chrome.app.window.onMaximized.addListener(
callback: function,
)
ウィンドウが最大化されたときに呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。() => void
onMinimized
chrome.app.window.onMinimized.addListener(
callback: function,
)
ウィンドウが最小化されたときに呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。() => void
onRestored
chrome.app.window.onRestored.addListener(
callback: function,
)
ウィンドウが最小化または最大化から復元されたときに呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。() => void