chrome.system.display

説明

system.display API を使用して、表示メタデータをクエリします。

権限

system.display

型

ActiveState

Chrome 117 以降

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

列挙型

「有効」

"inactive"

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

    数値（省略可）

    <ph type="x-smartling-placeholder"></ph> Chrome 70 以降非推奨

    displayZoomFactor

    表示モード UI のスケール ファクタ。

  • 幅

    数値

    デバイス非依存（ユーザー可視）ピクセルの表示モードの幅。

  • widthInNativePixels

    数値

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

DisplayProperties

プロパティ

  • boundsOriginX

    数値（省略可）

    設定すると、ディスプレイの論理境界の原点が X 軸に沿って更新されます。boundsOriginY と一緒に適用されます。設定されず、boundsOriginY が設定されている場合のデフォルトは現在の値になります。ディスプレイの起点を更新すると、いくつかの制約が適用されるため、最終的な境界の起点が設定されたものとは異なる場合があります。最終的な境界は、getInfo を使用して取得できます。プライマリ ディスプレイで境界の起点を変更することはできません。

  • boundsOriginY

    数値（省略可）

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

  • displayMode

    DisplayMode （省略可）

    Chrome 52 以降

    設定すると、表示モードをこの値に一致するモードに更新します。他のパラメータが無効な場合、これは適用されません。表示モードが無効な場合、無効な表示モードは適用されず、エラーが設定されますが、他のプロパティは引き続き適用されます。

  • displayZoomFactor

    数値（省略可）

    Chrome 65 以降

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

  • isPrimary

    ブール値（省略可）

    true に設定すると、ディスプレイがプライマリになります。false に設定されている場合は処理を行いません。注: 設定すると、他のすべてのプロパティでディスプレイがプライマリと見なされます（たとえば、isUnified は設定されても、境界のオリジンは設定されません）。

  • isUnified

    ブール値（省略可）

    Chrome 59 以降

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

  • mirroringSourceId

    文字列（省略可）

    <ph type="x-smartling-placeholder"></ph> Chrome 68 以降非推奨

    setMirrorMode を使用します。

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

  • オーバースキャン

    インセット （省略可）

    設定すると、ディスプレイのオーバースキャン インセットが指定された値に設定されます。オーバースキャンの値を負の値にしたり、画面サイズの半分を超えて設定したりすることはできません。内部モニターでオーバースキャンを変更することはできません。

  • 回転

    数値（省略可）

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

DisplayUnitInfo

プロパティ

  • activeState

    ActiveState

    Chrome 117 以降

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

  • availableDisplayZoomFactors

    数値 []

    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 のみ。ソース ディスプレイのミラーリング先となるディスプレイの識別子。ミラーリングされているディスプレイがない場合は空になります。この値は、すべてのディスプレイで同じ値に設定されます。mirroringSourceId を含めることはできません。

  • mirroringSourceId

    文字列

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

  • modes

    DisplayMode[]

    Chrome 52 以降

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

  • name

    文字列

    わかりやすい名前（例: 「HP LCD モニター」）。

  • オーバースキャン

    インセット

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

  • 回転

    数値

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

  • workArea

    境界

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

Edid

Chrome 67 以降

プロパティ

  • manufacturerId

    文字列

    3 文字のメーカーコード。詳細については、3.4.1 21 ページ。バージョン 1.4 では必須です。

  • productId

    文字列

    メーカーが割り当てた 2 バイトのコード、3.4.2 ページ 21.バージョン 1.4 では必須です。

  • yearOfManufacture

    数値

    製造年、3.4.4 ページ 22.バージョン 1.4 では必須です。

GetInfoFlags

Chrome 59 以降

プロパティ

  • singleUnified

    ブール値（省略可）

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

Insets

プロパティ

  • 下

    数値

    下限からの Y 軸の距離。

  • 左

    数値

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

  • 右

    数値

    右端からの X 軸の距離。

  • 上

    数値

    上限からの Y 軸の距離。

LayoutPosition

Chrome 53 以降

レイアウト位置（ディスプレイが接続されている親の端）。

列挙型

"top"

"right"

"ボトム"

「left」

MirrorMode

Chrome 65 以降

ミラーモード。つまり、ディスプレイを他のディスプレイにさまざまな方法でミラーリングできます。

列挙型

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

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

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

MirrorModeInfo

Chrome 65 以降

プロパティ

  • mirroringDestinationIds

    文字列 [] 省略可

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

  • mirroringSourceId

    文字列（省略可）

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

  • モード

    MirrorMode

    設定するミラーモード。

Point

Chrome 57 以降

プロパティ

  • x

    数値

    点の x 座標。

  • y

    数値

    点の y 座標。

TouchCalibrationPair

Chrome 57 以降

プロパティ

TouchCalibrationPairQuad

Chrome 57 以降

プロパティ

  • タッチ キャリブレーションを行うには、最初の 1 組のタッチポイントとディスプレイ ポイントが必要です。

  • タッチ キャリブレーションには、もう 1 組のタッチポイントとディスプレイ ポイントが必要です。

  • タップの調整には、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()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 53 以降 をご覧ください。
chrome.system.display.getDisplayLayout(
  callback?: function,
)

すべてのディスプレイのレイアウト情報をリクエストします。注: この機能は ChromeOS キオスクアプリとウェブ UI でのみご利用いただけます。

パラメータ

  • callback

    関数（省略可）

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

    (layouts: DisplayLayout[]) => void

戻り値

  • Promise&lt;DisplayLayout[]&gt;

    Chrome 91 以降

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

getInfo()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.system.display.getInfo(
  flags?: GetInfoFlags,
  callback?: function,
)

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

パラメータ

  • flags

    GetInfoFlags（オプション）

    Chrome 59 以降

    情報を返す方法に影響を与えるオプション。

  • callback

    関数（省略可）

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

    (displayInfo: DisplayUnitInfo[]) => void

戻り値

  • Promise&lt;DisplayUnitInfo[]&gt;

    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()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 53 以降 をご覧ください。
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

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

パラメータ

  • レイアウト

    DisplayLayout[]

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

setDisplayProperties()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
  callback?: function,
)

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

パラメータ

  • id

    文字列

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

  • 変更が必要な表示プロパティに関する情報。プロパティは、info で新しい値が指定された場合にのみ変更されます。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

setMirrorMode()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 65 以降 をご覧ください。
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
  callback?: function,
)

表示モードを指定のミラーモードに設定します。呼び出しごとに、以前の呼び出しの状態がリセットされます。ミラーリング デスティネーション ディスプレイで setDisplayProperties() の呼び出しが失敗します。注: この機能は ChromeOS キオスクアプリとウェブ UI でのみご利用いただけます。

パラメータ

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

showNativeTouchCalibration()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 57 以降 をご覧ください。
chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

ディスプレイ ID として id を使用して、ディスプレイのネイティブ タッチ調整 UX を表示します。これにより、必要な手順を示すオーバーレイが画面に表示されます。コールバックは、調整が成功した場合にのみ呼び出されます。調整に失敗した場合は、エラーがスローされます。

パラメータ

  • id

    文字列

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

  • callback

    関数（省略可）

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

    (success: boolean) => void

    • success

      ブール値

戻り値

  • Promise&lt;boolean&gt;

    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