chrome.system.display

説明

system.display API を使用してディスプレイのメタデータをクエリします。

権限

system.display

型

ActiveState

Chrome 117 以降

ディスプレイが検出され、システムで使用されているかどうかを示す列挙型。ディスプレイがシステムで検出されない場合（接続が切断されている場合や、スリープ モードのため接続が切断されていると見なされる場合など）は、ディスプレイは「非アクティブ」と見なされます。この状態は、すべてのディスプレイが切断されたときに既存のディスプレイを保持するために使用されます。

列挙型

「active」

「無効」

Bounds

プロパティ

  • height

    数値

    ディスプレイの高さ（ピクセル単位）。

  • 左

    数値

    左上の x 座標。

  • 上

    数値

    左上の y 座標。

  • 幅

    数値

    ディスプレイの幅（ピクセル単位）。

DisplayLayout

Chrome 53 以降

プロパティ

  • id

    文字列

    ディスプレイの一意の識別子。

  • offset

    数値

    接続されたエッジに沿ったディスプレイのオフセット。0 は、左上または右上の角が揃っていることを示します。

  • parentId

    文字列

    親ディスプレイの一意の識別子。これがルートの場合は空白です。

  • position

    LayoutPosition

    このディスプレイのレイアウト位置（親を基準とする）。これはルートでは無視されます。

DisplayMode

Chrome 52 以降

プロパティ

  • deviceScaleFactor

    数値

    表示モードのデバイスのスケーリング ファクタ。

  • height

    数値

    ディスプレイ モードの高さ（デバイスに依存しない（ユーザーに表示される）ピクセル単位）。

  • heightInNativePixels

    数値

    表示モードの高さ（ネイティブ ピクセル単位）。

  • isInterlaced

    ブール値（省略可）

    Chrome 74 以降

    このモードがインターレースの場合は true、指定されていない場合は false。

  • isNative

    ブール値

    モードがディスプレイのネイティブ モードの場合、true。

  • isSelected

    ブール値

    表示モードが現在選択されている場合は true。

  • refreshRate

    数値

    Chrome 67 以降

    ディスプレイ モードのリフレッシュ レート（ヘルツ）。

  • uiScale

    number（省略可）

    Chrome 70 で非推奨

    displayZoomFactor

    ディスプレイ モードの UI スケール係数。

  • 幅

    数値

    ディスプレイ モードの幅（デバイス非依存（ユーザー表示）ピクセル単位）。

  • widthInNativePixels

    数値

    ディスプレイ モードの幅（ネイティブ ピクセル単位）。

DisplayProperties

プロパティ

  • boundsOriginX

    number（省略可）

    設定すると、ディスプレイの論理境界の原点を x 軸に沿って更新します。boundsOriginY と組み合わせて適用します。設定されていない場合、および boundsOriginY が設定されている場合は、デフォルトで現在の値になります。表示の原点を更新すると、一部の制約が適用されるため、最終的な境界の原点は設定された原点とは異なる場合があります。最終的な境界は getInfo を使用して取得できます。メインのディスプレイでは境界の原点は変更できません。

  • boundsOriginY

    number（省略可）

    設定すると、ディスプレイの論理境界の原点を y 軸に沿って更新します。boundsOriginX パラメータのドキュメントをご覧ください。

  • displayMode

    DisplayMode 省略可

    Chrome 52 以降

    設定されている場合、この値に一致するモードにディスプレイ モードが更新されます。他のパラメータが無効な場合、このパラメータは適用されません。表示モードが無効な場合、そのモードは適用されず、エラーが設定されますが、他のプロパティは適用されます。

  • displayZoomFactor

    number（省略可）

    Chrome 65 以降

    設定されている場合、ディスプレイに関連付けられたズームが更新されます。このズームでは、再レイアウトと再描画が行われるため、ピクセル単位の拡大よりも高画質のズームが実現できます。

  • isPrimary

    ブール値（省略可）

    true に設定すると、ディスプレイがプライマリになります。false に設定した場合は何も実行されません。注: 設定されている場合、そのディスプレイは他のすべてのプロパティに対してプライマリと見なされます（つまり、isUnified は設定されていても、境界の起点は設定されていない場合があります）。

  • isUnified

    ブール値（省略可）

    Chrome 59 以降

    ChromeOS のみ。true に設定すると、ディスプレイ モードが統合デスクトップに変更されます（詳細については、enableUnifiedDesktop をご覧ください）。false に設定すると、デスクトップ統合モードは無効になります。これはプライマリ ディスプレイでのみ有効です。指定する場合は、mirroringSourceId を指定しないでください。他のプロパティは無視されます。指定しない場合、この値は無視されます。

  • mirroringSourceId

    文字列 省略可

    Chrome 68 で非推奨

    setMirrorMode を使用します。

    ChromeOS のみ。設定され、空でない場合、このディスプレイのみのミラーリングが有効になります。それ以外の場合は、すべてのディスプレイのミラーリングが無効になります。この値は、ミラーリングするソース ディスプレイの ID を指定します。この ID は、setDisplayProperties に渡された ID と同じであってはなりません。設定されている場合、他のプロパティは設定できません。

  • オーバースキャン

    インセット 省略可

    設定されている場合、ディスプレイのオーバースキャンの切れ込みを指定された値に設定します。オーバースキャン値は負の値にしたり、画面サイズの半分より大きくしたりすることはできません。内部モニターでオーバースキャンを変更することはできません。

  • 回転

    number（省略可）

    設定すると、ディスプレイの回転が更新されます。有効な値は [0、90、180、270] です。回転は、ディスプレイの垂直方向を基準として時計回りに設定されます。

DisplayUnitInfo

プロパティ

  • activeState

    ActiveState

    Chrome 117 以降

    ディスプレイが検出され、システムで使用されている場合はアクティブです。

  • availableDisplayZoomFactors

    number[]

    Chrome 67 以降

    ディスプレイに設定できるズーム倍率の値のリスト。

  • bounds

    境界

    ディスプレイの論理境界。

  • displayZoomFactor

    数値

    Chrome 65 以降

    ディスプレイの現在のズームとデフォルトのズームの比率。たとえば、値 1 は 100% ズームに相当し、値 1.5 は 150% ズームに相当します。

  • dpiX

    数値

    x 軸に沿った 1 インチあたりのピクセル数。

  • dpiY

    数値

    Y 軸に沿った 1 インチあたりのピクセル数。

  • edid

    Edid 省略可

    Chrome 67 以降

    注: これは ChromeOS キオスクアプリとウェブ UI でのみ使用できます。

  • hasTouchSupport

    ブール値

    Chrome 57 以降

    このディスプレイにタッチ入力デバイスが関連付けられている場合は true。

  • id

    文字列

    ディスプレイの一意の識別子。

  • isEnabled

    ブール値

    このディスプレイが有効な場合は true です。

  • isPrimary

    ブール値

    これがプライマリ ディスプレイの場合は true。

  • isUnified

    ブール値

    Chrome 59 以降

    デスクトップ画面統合モードでは、すべてのディスプレイで true です。enableUnifiedDesktop のドキュメントをご覧ください。

  • mirroringDestinationIds

    string[]

    Chrome 64 以降

    ChromeOS のみ。ソース ディスプレイがミラーリングされているディスプレイの ID。ミラーリングされているディスプレイがない場合は空になります。この値は、すべてのディスプレイで同じ値に設定されます。mirroringSourceId を含めてはいけません。

  • mirroringSourceId

    文字列

    ChromeOS のみ。ミラーリングが有効になっている場合はミラーリングされているディスプレイの ID、それ以外の場合は空。これは、すべてのディスプレイ（ミラーリングされているディスプレイを含む）に設定されます。

  • modes

    DisplayMode[]

    Chrome 52 以降

    使用可能なディスプレイ モードのリスト。現在のモードには isSelected=true が設定されます。ChromeOS でのみご利用いただけます。他のプラットフォームでは空の配列に設定されます。

  • name

    文字列

    ユーザー フレンドリーな名前（「HP LCD monitor」など）。

  • オーバースキャン

    インセット

    画面の境界内のディスプレイの切り欠き。現在は ChromeOS でのみ公開されています。他のプラットフォームでは、空のインセットに設定されます。

  • 回転

    数値

    垂直方向からの時計回りのディスプレイの回転角度（度）。現在は ChromeOS でのみ公開されています。他のプラットフォームでは 0 に設定されます。デバイスが物理的なタブレット状態にある場合、値 -1 は自動回転として解釈されます。

  • workArea

    境界

    ディスプレイの境界内のディスプレイの使用可能な作業領域。作業領域には、タスクバーやランチャーなど、OS 用に予約されているディスプレイ領域は含まれません。

Edid

Chrome 67 以降

プロパティ

  • manufacturerId

    文字列

    3 文字のメーカーコード。セクション 3.4.1 ページ 21 をご覧ください。v1.4 では必須。

  • productId

    文字列

    2 バイトのメーカー指定コード、セクション 3.4.2 ページ 21。v1.4 では必須。

  • yearOfManufacture

    数値

    製造年、第 3.4.4 条、ページ 22。v1.4 では必須。

GetInfoFlags

Chrome 59 以降

プロパティ

  • singleUnified

    ブール値（省略可）

    true に設定すると、統合デスクトップ モードで getInfo から返される DisplayUnitInfo は 1 つだけになります（enableUnifiedDesktop を参照）。デフォルトは false です。

Insets

プロパティ

  • 下

    数値

    下限からの Y 軸の距離。

  • 左

    数値

    左の境界からの x 軸の距離。

  • 右

    数値

    右の境界からの x 軸の距離。

  • 上

    数値

    上限からの Y 軸の距離。

LayoutPosition

Chrome 53 以降

レイアウトの位置（ディスプレイが取り付けられている親の端）。

列挙型

「top」

「right」

「bottom」

「left」

MirrorMode

Chrome 65 以降

ミラーモード（ディスプレイを他のディスプレイにミラーリングするさまざまな方法）。

列挙型

「off」
デフォルトのモード（拡張デスクトップまたは統合デスクトップ）を指定します。

「normal」
デフォルトのソース ディスプレイが他のすべてのディスプレイにミラーリングされることを指定します。

「mixed」
指定されたソース ディスプレイが指定された宛先ディスプレイにミラーリングされることを指定します。接続されている他のすべてのディスプレイは延長されます。

MirrorModeInfo

Chrome 65 以降

プロパティ

  • mirroringDestinationIds

    string[] 省略可

    ミラーリング先の ID が表示されます。これは「混合」の場合のみ有効です。

  • mirroringSourceId

    文字列 省略可

    ミラーリング ソース ディスプレイの ID。これは「混合」の場合のみ有効です。

  • モード

    MirrorMode

    設定するミラーモード。

Point

Chrome 57 以降

プロパティ

  • x

    数値

    点の x 座標。

  • y

    数値

    点の y 座標。

TouchCalibrationPair

Chrome 57 以降

プロパティ

  • displayPoint

    ポイント

    表示ポイントの座標。

  • touchPoint

    ポイント

    ディスプレイ ポイントに対応するタップポイントの座標。

TouchCalibrationPairQuad

Chrome 57 以降

プロパティ

  • タップ キャリブレーションに必要なタップとディスプレイ ポイントの最初のペア。

  • タッチ キャリブレーションに必要な 2 つ目のタッチポイントとディスプレイ ポイント。

  • タップ キャリブレーションに必要な 3 つ目のタップポイントとディスプレイ ポイント。

  • タップ キャリブレーションに必要な 4 つ目のタップポイントとディスプレイ ポイント。

メソッド

clearTouchCalibration()

Chrome 57 以降 
chrome.system.display.clearTouchCalibration(
  id: string,
)

ディスプレイに関連付けられたタップ キャリブレーション データを消去して、ディスプレイのタップ キャリブレーションをリセットし、デフォルト状態に戻します。

パラメータ

  • id

    文字列

    ディスプレイの一意の識別子。

completeCustomTouchCalibration()

Chrome 57 以降 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
)

ディスプレイのタッチ キャリブレーション ペアを設定します。これらの pairs は、startCustomTouchCalibration() で呼び出される id を使用して、ディスプレイ用にタッチスクリーンを調整するために使用されます。このメソッドを呼び出す前に、必ず startCustomTouchCalibration を呼び出してください。別のタップ キャリブレーションがすでに進行中の場合は、エラーがスローされます。

パラメータ

  • ディスプレイの調整に使用される点のペア。

  • bounds

    境界

    タップ キャリブレーションが実行されたときのディスプレイの境界。bounds.left と bounds.top の値は無視されます。

enableUnifiedDesktop()

Chrome 46 以降 
chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
)

統合デスクトップ機能を有効または無効にします。ミラーリング中に有効にした場合、ミラーリングをオフにするまでデスクトップ モードは変わりません。それ以外の場合は、デスクトップ モードはすぐに統合モードに切り替わります。注: これは ChromeOS キオスクアプリとウェブ UI でのみ使用できます。

パラメータ

  • 有効

    ブール値

    統合デスクトップを有効にする場合は true に設定します。

getDisplayLayout()

Promise Chrome 53 以降 
chrome.system.display.getDisplayLayout(
  callback?: function,
)

すべてのディスプレイのレイアウト情報をリクエストします。注: これは ChromeOS キオスクアプリとウェブ UI でのみ使用できます。

パラメータ

  • callback

    function 省略可

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

    (layouts: DisplayLayout[]) => void

戻り値

  • Promise<DisplayLayout[]>

    Chrome 91 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

getInfo()

Promise 
chrome.system.display.getInfo(
  flags?: GetInfoFlags,
  callback?: function,
)

接続されているすべてのディスプレイ デバイスに関する情報をリクエストします。

パラメータ

  • flags

    GetInfoFlags 省略可

    Chrome 59 以降

    情報の返却方法に影響するオプション。

  • callback

    function 省略可

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

    (displayInfo: DisplayUnitInfo[]) => void

戻り値

  • Promise<DisplayUnitInfo[]>

    Chrome 91 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

overscanCalibrationAdjust()

Chrome 53 以降 
chrome.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
)

ディスプレイの現在のオーバースキャンの切り抜きを調整します。通常、これは軸に沿ってディスプレイを移動するか（例: 左と右の値が同じ）、軸に沿ってディスプレイをスケーリングします（例: 上と下の値が反対）。各 Adjust 呼び出しは、開始以降の以前の呼び出しと累積されます。

パラメータ

  • id

    文字列

    ディスプレイの一意の識別子。

  • デルタ

    インセット

    オーバースキャンの切り抜きを変更する量。

overscanCalibrationComplete()

Chrome 53 以降 
chrome.system.display.overscanCalibrationComplete(
  id: string,
)

現在の値を保存してオーバースキャンの調整を完了し、オーバーレイを非表示にします。

パラメータ

  • id

    文字列

    ディスプレイの一意の識別子。

overscanCalibrationReset()

Chrome 53 以降 
chrome.system.display.overscanCalibrationReset(
  id: string,
)

ディスプレイのオーバースキャンの切り抜きを、最後に保存された値（Start が呼び出される前）にリセットします。

パラメータ

  • id

    文字列

    ディスプレイの一意の識別子。

overscanCalibrationStart()

Chrome 53 以降 
chrome.system.display.overscanCalibrationStart(
  id: string,
)

ディスプレイのオーバースキャン キャリブレーションを開始します。これにより、現在のオーバースキャンの切り抜きが表示されます。ディスプレイ id のオーバースキャン調整が進行中の場合は、調整がリセットされます。

パラメータ

  • id

    文字列

    ディスプレイの一意の識別子。

setDisplayLayout()

Promise Chrome 53 以降 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

すべてのディスプレイのレイアウトを設定します。指定されていないディスプレイには、デフォルトのレイアウトが使用されます。レイアウトが重複する場合や、無効な場合は、有効なレイアウトに調整されます。レイアウトが解決されると、onDisplayChanged イベントがトリガーされます。注: これは ChromeOS キオスクアプリとウェブ UI でのみ使用できます。

パラメータ

  • layouts

    DisplayLayout[]

    レイアウト情報。プライマリ ディスプレイを除くすべてのディスプレイに必要です。

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

setDisplayProperties()

Promise 
chrome.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
  callback?: function,
)

info で指定された情報に基づいて、id で指定されたディスプレイのプロパティを更新します。失敗すると、runtime.lastError が設定されます。注: これは ChromeOS キオスクアプリとウェブ UI でのみ使用できます。

パラメータ

  • id

    文字列

    ディスプレイの一意の識別子。

  • 変更する必要があるディスプレイ プロパティに関する情報。プロパティが変更されるのは、info で新しい値が指定されている場合のみです。

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

setMirrorMode()

Promise Chrome 65 以降 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
  callback?: function,
)

ディスプレイ モードを指定されたミラーモードに設定します。呼び出すたびに、前の呼び出しの状態がリセットされます。ミラーリング先のディスプレイで setDisplayProperties() を呼び出すと、エラーが発生します。注: これは ChromeOS キオスクアプリとウェブ UI でのみ使用できます。

パラメータ

  • ディスプレイ モードに適用するミラーモードの情報。

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

showNativeTouchCalibration()

Promise Chrome 57 以降 
chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

ディスプレイ ID が id のディスプレイのネイティブ タッチ キャリブレーション UX を表示します。画面にオーバーレイが表示され、必要な手順が表示されます。コールバックは、キャリブレーションが正常に完了した場合にのみ呼び出されます。キャリブレーションに失敗すると、エラーがスローされます。

パラメータ

  • id

    文字列

    ディスプレイの一意の識別子。

  • callback

    function 省略可

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

    (success: boolean) => void

    • success

      ブール値

戻り値

  • Promise<boolean>

    Chrome 91 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

startCustomTouchCalibration()

Chrome 57 以降 
chrome.system.display.startCustomTouchCalibration(
  id: string,
)

ディスプレイのカスタム タップ キャリブレーションを開始します。これは、カスタム UX を使用してキャリブレーション データを収集する場合に呼び出す必要があります。別のタップ キャリブレーションがすでに進行中の場合は、エラーがスローされます。

パラメータ

  • id

    文字列

    ディスプレイの一意の識別子。

イベント

onDisplayChanged

chrome.system.display.onDisplayChanged.addListener(
  callback: function,
)

ディスプレイの構成が変更されたときにトリガーされます。

パラメータ

  • callback

    関数

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

    () => void