chrome.app.window

説明

chrome.app.window API を使用してウィンドウを作成します。ウィンドウには、タイトルバーとサイズ変更コントロールを備えたフレーム（省略可）があります。Chrome ブラウザのウィンドウには関連付けられていません。これらのオプションのデモについては、ウィンドウ状態のサンプルをご覧ください。

型

AppWindow

プロパティ

  • contentWindow

    ウィンドウ

    作成された子の JavaScript の「window」オブジェクト。

  • id

    文字列

    ウィンドウの作成に使用された ID。

  • innerBounds

    境界

    ウィンドウのコンテンツの位置、サイズ、制約。ウィンドウの装飾は含まれません。このプロパティは Chrome 36 で新しく追加されました。

  • outerBounds

    境界

    ウィンドウの位置、サイズ、制約。タイトルバーやフレームなどのウィンドウ装飾も含まれます。このプロパティは Chrome 36 で新しく追加されました。

  • clearAttention

    void

    ウィンドウへの注意をクリアします。

    clearAttention 関数は次のようになります。 

    () => {...}

  • 閉じる

    void

    ウィンドウを閉じます。

    close 関数は次のようになります。 

    () => {...}

  • drawAttention

    void

    ウィンドウに注目を集めます。

    drawAttention 関数は次のようになります。 

    () => {...}

  • ピント

    void

    ウィンドウにフォーカスします。

    focus 関数は次のようになります。 

    () => {...}

  • 全画面表示

    void

    ウィンドウを全画面表示にします。

    ESC キーを押すと、ウィンドウを復元できます。アプリケーションは、次のように、keydown ハンドラと keyup ハンドラで app.window.fullscreen.overrideEsc 権限をリクエストし、.preventDefault() を呼び出してイベントをキャンセルすることで、ESC キーが押されたときに全画面表示状態が終了しないようにすることができます。

    window.onkeydown = window.onkeyup = function(e) { if (e.keyCode == 27 /* ESC *\/) { e.preventDefault(); } };

    注: window.fullscreen() を使用すると、ウィンドウ全体が全画面表示になり、ユーザーの操作は必要ありません。HTML5 全画面 API を使用して全画面モードにすることもできます（詳しくは、Web API をご覧ください）。

    fullscreen 関数は次のようになります。 

    () => {...}

  • getBounds

    void

    非推奨

    innerBounds または outerBounds を使用します。

    ウィンドウの内部境界を ContentBounds オブジェクトとして取得します。

    getBounds 関数は次のようになります。 

    () => {...}

  • 非表示

    void

    ウィンドウを非表示にします。ウィンドウがすでに非表示になっている場合は何もしません。

    hide 関数は次のようになります。 

    () => {...}

  • isAlwaysOnTop

    void

    ウィンドウは常に最前面に表示されますか？

    isAlwaysOnTop 関数は次のようになります。 

    () => {...}

    • 戻り値

      ブール値

  • isFullscreen

    void

    ウィンドウは全画面表示になっていますか？ウィンドウが全画面表示で作成された場合、または AppWindow または HTML5 全画面 API を介して全画面表示になった場合、これは true になります。

    isFullscreen 関数は次のようになります。 

    () => {...}

    • 戻り値

      ブール値

  • isMaximized

    void

    ウィンドウは最大化されていますか？

    isMaximized 関数は次のようになります。 

    () => {...}

    • 戻り値

      ブール値

  • isMinimized

    void

    ウィンドウが最小化されているか？

    isMinimized 関数は次のようになります。 

    () => {...}

    • 戻り値

      ブール値

  • 最大化

    void

    ウィンドウを最大化します。

    maximize 関数は次のようになります。 

    () => {...}

  • 最小化

    void

    ウィンドウを最小化します。

    minimize 関数は次のようになります。 

    () => {...}

  • moveTo

    void

    Chrome 43 以降で非推奨

    outerBounds を使用します。

    ウィンドウを位置（left、top）に移動します。

    moveTo 関数は次のようになります。 

    (left: number, top: number) => {...}

    • 左

      数値

    • 上

      数値

  • resizeTo

    void

    Chrome 43 以降で非推奨

    outerBounds を使用します。

    ウィンドウのサイズを widthxheight ピクセルに変更します。

    resizeTo 関数は次のようになります。 

    (width: number, height: number) => {...}

    • 幅

      数値

    • height

      数値

  • restore

    void

    ウィンドウを復元し、最大化、最小化、全画面表示の状態を終了します。

    restore 関数は次のようになります。 

    () => {...}

  • setAlwaysOnTop

    void

    ウィンドウを他のほとんどのウィンドウの上に表示するかどうかを設定します。alwaysOnTopWindows のアクセス許可を得る必要があります。

    setAlwaysOnTop 関数は次のようになります。 

    (alwaysOnTop: boolean) => {...}

    • alwaysOnTop

      ブール値

  • setBounds

    void

    非推奨

    innerBounds または outerBounds を使用します。

    ウィンドウの内側の境界を設定します。

    setBounds 関数は次のようになります。 

    (bounds: ContentBounds) => {...}

  • setVisibleOnAllWorkspaces

    void

    ウィンドウをすべてのワークスペースに表示するかどうかを設定します。（この機能をサポートするプラットフォームのみ）。

    setVisibleOnAllWorkspaces 関数は次のようになります。 

    (alwaysVisible: boolean) => {...}

    • alwaysVisible

      ブール値

  • 表示する

    void

    ウィンドウを表示します。ウィンドウがすでに表示されている場合は何もしません。focused が true に設定されているか省略されている場合は、ウィンドウにフォーカスします。

    show 関数は次のようになります。 

    (focused?: boolean) => {...}

    • 手厚い支援

      ブール値（省略可）

Bounds

プロパティ

  • height

    数値

    このプロパティは、コンテンツまたはウィンドウの現在の高さを読み書きするために使用できます。

  • 左

    数値

    このプロパティは、コンテンツまたはウィンドウの現在の 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) => {...}

    • 幅

      数値

    • height

      数値

BoundsSpecification

プロパティ

  • height

    number 省略可

    コンテンツまたはウィンドウの高さ。

  • 左

    number 省略可

    コンテンツまたはウィンドウの X 座標。

  • maxHeight

    number 省略可

    コンテンツまたはウィンドウの最大高さ。

  • maxWidth

    number 省略可

    コンテンツまたはウィンドウの最大幅。

  • minHeight

    number 省略可

    コンテンツまたはウィンドウの最小の高さ。

  • minWidth

    number 省略可

    コンテンツまたはウィンドウの最小幅。

  • 上

    number 省略可

    コンテンツまたはウィンドウの Y 座標。

  • 幅

    number 省略可

    コンテンツまたはウィンドウの幅。

ContentBounds

プロパティ

  • height

    number 省略可

  • 左

    number 省略可

  • 上

    number 省略可

  • 幅

    number 省略可

CreateWindowOptions

プロパティ

  • alwaysOnTop

    ブール値（省略可）

    true の場合、ウィンドウは他のほとんどのウィンドウの上に表示されます。このようなウィンドウが複数ある場合は、現在フォーカスされているウィンドウがフォアグラウンドに表示されます。alwaysOnTopWindows 権限が必要です。デフォルトは false です。

    作成後にこのプロパティを変更するには、ウィンドウで setAlwaysOnTop() を呼び出します。

  • bounds

    ContentBounds 省略可

    非推奨

    innerBounds または outerBounds を使用します。

    ウィンドウ内のコンテンツのサイズと位置（タイトルバーを除く）。ID も指定されていて、一致する ID のウィンドウが以前に表示されたことがある場合は、代わりにウィンドウの記憶された境界が使用されます。

  • 手厚い支援

    ブール値（省略可）

    true の場合、ウィンドウは作成時にフォーカスされます。デフォルトは true です。

  • フレーム

    文字列 | FrameOptions 省略可

    フレームタイプ: none または chrome（デフォルトは chrome）。none の場合、-webkit-app-region CSS プロパティを使用して、アプリのウィンドウにドラッグ可能機能を適用できます。-webkit-app-region: drag を使用して、リージョンをドラッグ可能にすることができます。no-drag を使用して、ネストされた要素でこのスタイルを無効にできます。

    FrameOptions の使用は M36 で新たに導入されました。

  • 非表示

    ブール値（省略可）

    true の場合、ウィンドウは非表示状態で作成されます。作成されたウィンドウを表示するには、ウィンドウで show() を呼び出します。デフォルトは false です。

  • アイコン

    文字列 省略可

    Chrome 54 以降

    ウィンドウ アイコンの URL。showInShelf が true に設定されている場合、ウィンドウに独自のアイコンを設定できます。URL は、グローバル URL または拡張機能のローカル URL である必要があります。

  • id

    文字列 省略可

    ウィンドウを識別するための 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 で新しく追加されました。

  • サイズ変更可能

    ブール値（省略可）

    true の場合、ユーザーはウィンドウのサイズを変更できます。デフォルトは true です。

  • showInShelf

    ブール値（省略可）

    Chrome 54 以降

    true の場合、ウィンドウには独自のシェルフ アイコンが表示されます。それ以外の場合、ウィンドウはアプリに関連付けられている他のウィンドウとともにシェルフにグループ化されます。デフォルトは false です。showInShelf が true に設定されている場合は、ウィンドウの ID を指定する必要があります。

  • シングルトン

    ブール値（省略可）

    非推奨

    同じ ID の複数のウィンドウはサポートされなくなりました。

    デフォルトでは、ウィンドウの ID を指定した場合、同じ ID の別のウィンドウがまだ存在しない場合にのみ、ウィンドウが作成されます。同じ ID のウィンドウがすでに存在する場合は、代わりにそのウィンドウがアクティブになります。同じ ID で複数のウィンドウを作成する場合は、このプロパティを false に設定します。

  • state

    State（都道府県） 省略可

    ウィンドウの初期状態。全画面表示、最大化、最小化された状態で作成できます。デフォルトは「normal」です。

  • type

    WindowType 省略可

    Chrome 45 以降 Chrome 69 以降で非推奨

    すべてのアプリ ウィンドウが「シェル」ウィンドウ タイプを使用する

    作成するウィンドウのタイプ。

  • visibleOnAllWorkspaces

    ブール値（省略可）

    true で、プラットフォームでサポートされている場合、ウィンドウはすべてのワークスペースに表示されます。

FrameOptions

プロパティ

  • activeColor

    文字列 省略可

    アクティブなウィンドウのフレームの色を設定できます。フレームのカラーリングは、フレームタイプが chrome の場合にのみ使用できます。

    フレームのカラーリングは、フレームタイプが chrome の場合にのみ使用できます。

    フレームの色付けは Chrome 36 で導入された新機能です。

  • 色

    文字列 省略可

    フレームの色を設定できます。フレームのカラーリングは、フレームタイプが chrome の場合にのみ使用できます。

    フレームの色付けは Chrome 36 で導入された新機能です。

  • inactiveColor

    文字列 省略可

    非アクティブなウィンドウのフレームの色をアクティブな色とは異なる色に設定できます。フレームのカラーリングは、フレームタイプが chrome の場合にのみ使用できます。

    inactiveColor は color と併用する必要があります。

    フレームの色付けは Chrome 36 で導入された新機能です。

  • type

    文字列 省略可

    フレームタイプ: none または chrome（デフォルトは chrome）。

    none の場合、-webkit-app-region CSS プロパティを使用して、アプリのウィンドウにドラッグ可能機能を適用できます。

    -webkit-app-region: drag を使用して、リージョンをドラッグ可能にすることができます。no-drag を使用して、ネストされた要素でこのスタイルを無効にできます。

State

ウィンドウの状態: 通常、全画面表示、最大化、最小化。

列挙型

"normal"

"fullscreen"

"maximized"

"minimized"

WindowType

Chrome 45 以降

作成するウィンドウのタイプを指定します。

列挙型

"shell"
デフォルトのウィンドウ タイプ。

「panel」
OS 管理ウィンドウ（非推奨）。

メソッド

canSetVisibleOnAllWorkspaces()

chrome.app.window.canSetVisibleOnAllWorkspaces(): boolean

現在のプラットフォームが、すべてのワークスペースでウィンドウを表示することをサポートしているかどうか。

戻り値

  • ブール値

create()

Promise 
chrome.app.window.create(
  url: string,
  options?: CreateWindowOptions,
  callback?: function,
): Promise<AppWindow>

ウィンドウのサイズと位置は、さまざまな方法で指定できます。最も簡単な方法は、何も指定しないことです。この場合、デフォルトのサイズとプラットフォーム依存の位置が使用されます。

ウィンドウの位置、サイズ、制約を設定するには、innerBounds プロパティまたは outerBounds プロパティを使用します。内側の境界にはウィンドウ装飾は含まれません。外側の境界には、ウィンドウのタイトルバーとフレームが含まれます。内側の境界と外側の境界の間のパディングは OS によって決定されます。そのため、内側と外側の両方の境界に同じプロパティを設定することはエラーと見なされます（たとえば、innerBounds.left と outerBounds.left の両方を設定するなど）。

ウィンドウの位置を自動的に記憶するには、ウィンドウに ID を指定します。ウィンドウに ID がある場合、ウィンドウが移動またはサイズ変更されるたびに、この ID を使用してウィンドウのサイズと位置が記憶されます。このサイズと位置は、同じ ID のウィンドウを後で開く際に、指定された境界の代わりに使われます。ID を持つウィンドウを記憶されたデフォルト以外の場所に開く必要がある場合は、非表示で作成し、目的の場所に移動してから表示できます。

パラメータ

  • URL

    文字列

  • オプション

    CreateWindowOptions 省略可

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    (createdWindow: AppWindow) => void

戻り値

  • Promise<AppWindow>

    Chrome 117 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

current()

chrome.app.window.current(): AppWindow | undefined

現在のスクリプト コンテキスト（JavaScript の「window」オブジェクトなど）の AppWindow オブジェクトを返します。これは、別のページのスクリプト コンテキストのハンドル（otherWindow.chrome.app.window.current() など）でも呼び出すことができます。

戻り値

get()

chrome.app.window.get(
  id: string,
): AppWindow | undefined

指定された ID の AppWindow を取得します。指定された ID のウィンドウが存在しない場合は null が返されます。このメソッドは Chrome 33 で新しく追加されました。

パラメータ

  • id

    文字列

戻り値

getAll()

chrome.app.window.getAll(): AppWindow[]

現在作成されているすべてのアプリ ウィンドウの配列を取得します。このメソッドは 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 または 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