chrome.system.display

説明

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

権限

system.display

型

ActiveState

Chrome 117 以降

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

列挙型

"active"

"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

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

  • mirroringSourceId

    文字列

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

  • modes

    DisplayMode[]

    Chrome 52 以降

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

  • name

    文字列

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

  • オーバースキャン

    インセット

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

  • 回転

    数値

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

  • workArea

    境界

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

Edid

Chrome 67 以降

プロパティ

  • manufacturerId

    文字列

    3 文字のメーカーコード。Sec. 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 に設定すると、統合デスクトップ モードの場合（enableUnifiedDesktop を参照）、getInfo は 1 つの DisplayUnitInfo のみを返します。デフォルトは 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。これは「mixed」の場合にのみ有効です。

  • mirroringSourceId

    文字列 省略可

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

  • モード

    MirrorMode

    設定するミラーモード。

Point

Chrome 57+

プロパティ

  • x

    数値

    ポイントの x 座標。

  • y

    数値

    ポイントの y 座標。

TouchCalibrationPair

Chrome 57+

プロパティ

  • displayPoint

    Point

    表示ポイントの座標。

  • touchPoint

    Point

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

TouchCalibrationPairQuad

Chrome 57+

プロパティ

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

  • タッチ調整には 2 組目のタッチポイントとディスプレイ ポイントが必要です。

  • タッチ調整に必要な 3 つ目のタッチ ポイントとディスプレイ ポイント。

  • タッチ調整に必要な 4 つ目のタッチポイントとディスプレイ ポイント。

メソッド

clearTouchCalibration()

Chrome 57+ 
chrome.system.display.clearTouchCalibration(
  id: string,
): void

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

パラメータ

  • id

    文字列

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

completeCustomTouchCalibration()

Chrome 57+ 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
): void

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

パラメータ

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

  • bounds

    境界

    タッチ調整が実行されたときのディスプレイの境界。bounds.left と bounds.top の値は無視されます。

enableUnifiedDesktop()

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

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

パラメータ

  • 有効

    ブール値

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

getDisplayLayout()

Chrome 53 以降 
chrome.system.display.getDisplayLayout(): Promise<DisplayLayout[]>

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

戻り値

getInfo()

chrome.system.display.getInfo(
  flags?: GetInfoFlags,
): Promise<DisplayUnitInfo[]>

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

パラメータ

  • flags

    GetInfoFlags 省略可

    Chrome 59+

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

戻り値

overscanCalibrationAdjust()

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

ディスプレイの現在のオーバースキャン インセットを調整します。通常、これは軸に沿って表示を移動するか（左右の値が同じなど）、軸に沿って表示を拡大縮小します（上下の値が逆など）。Adjust の各呼び出しは、Start 以降の以前の呼び出しと累積されます。

パラメータ

  • id

    文字列

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

  • デルタ

    インセット

    オーバースキャン インセットを変更する量。

overscanCalibrationComplete()

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

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

パラメータ

  • id

    文字列

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

overscanCalibrationReset()

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

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

パラメータ

  • id

    文字列

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

overscanCalibrationStart()

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

ディスプレイのオーバースキャン調整を開始します。画面にオーバーレイが表示され、現在のオーバースキャン インセットが示されます。ディスプレイ id のオーバースキャン調整が進行中の場合、調整がリセットされます。

パラメータ

  • id

    文字列

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

setDisplayLayout()

Chrome 53 以降 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
): Promise<void>

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

パラメータ

  • レイアウト

    DisplayLayout[]

    レイアウト情報。プライマリ ディスプレイ以外のすべてのディスプレイで必要です。

戻り値

  • Promise<void>

    Chrome 91 以降

setDisplayProperties()

chrome.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
): Promise<void>

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

パラメータ

  • id

    文字列

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

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

戻り値

  • Promise<void>

    Chrome 91 以降

setMirrorMode()

Chrome 65 以降 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
): Promise<void>

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

パラメータ

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

戻り値

  • Promise<void>

    Chrome 91 以降

showNativeTouchCalibration()

Chrome 57+ 
chrome.system.display.showNativeTouchCalibration(
  id: string,
): Promise<boolean>

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

パラメータ

  • id

    文字列

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

戻り値

  • Promise<boolean>

    Chrome 91 以降

startCustomTouchCalibration()

Chrome 57+ 
chrome.system.display.startCustomTouchCalibration(
  id: string,
): void

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

パラメータ

  • id

    文字列

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

イベント

onDisplayChanged

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

ディスプレイ構成が変更されると起動されます。

パラメータ

  • callback

    関数

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

    () => void