説明
system.display API を使用して表示メタデータをクエリします。
権限
system.display型
ActiveState
ディスプレイがシステムによって検出され、使用されているかどうかを示す列挙型。ディスプレイがシステムによって検出されない場合（接続が切断されている、スリープモードなどにより切断されていると見なされるなど）、ディスプレイは「非アクティブ」と見なされます。この状態は、たとえば、すべてのディスプレイが切断されたときに既存のディスプレイを保持するために使用されます。
列挙型
「有効」
"inactive"
Bounds
プロパティ
-
height
数値
ディスプレイの高さ（ピクセル単位）。
-
左
数値
左上隅の X 座標。
-
上
数値
左上隅の Y 座標。
-
width
数値
ディスプレイの幅（ピクセル単位）。
DisplayLayout
プロパティ
-
id
文字列
ディスプレイの固有識別子。
-
offset
数値
接続されたエッジに沿ったディスプレイのオフセット。0 は、最上部または左端の角が揃っていることを示します。
-
parentId
文字列
親ディスプレイの固有識別子。これがルートの場合は空になります。
-
position
親に対するこのディスプレイのレイアウト位置。これはルートでは無視されます。
DisplayMode
プロパティ
-
deviceScaleFactor
数値
ディスプレイ モードのデバイス スケーリング ファクタ。
-
height
数値
デバイスに依存しない（ユーザーに表示される）ピクセル単位のディスプレイ モードの高さ。
-
heightInNativePixels
数値
ネイティブ ピクセル単位のディスプレイ モードの高さ。
-
isInterlaced
boolean 省略可
Chrome 74 以降 Chrome 148 以降の browser.*このモードがインターレースの場合は true、指定されていない場合は false。
-
isNative
ブール値
モードがディスプレイのネイティブ モードの場合は true。
-
isSelected
ブール値
表示モードが現在選択されている場合は true。
-
refreshRate
数値
Chrome 67 以降 Chrome 148 以降の browser.*ディスプレイ モードのリフレッシュ レート（ヘルツ単位）。
-
uiScale
number 省略可
Chrome 70 以降、非推奨displayZoomFactorを使用するディスプレイ モードの UI スケーリング ファクタ。
-
width
数値
デバイスに依存しない（ユーザーに表示される）ピクセル単位のディスプレイ モードの幅。
-
widthInNativePixels
数値
ネイティブ ピクセル単位のディスプレイ モードの幅。
DisplayProperties
プロパティ
-
boundsOriginX
number 省略可
設定されている場合、ディスプレイの論理境界の X 軸に沿った原点を更新します。
boundsOriginYと一緒に適用されます。設定されておらず、boundsOriginYが設定されている場合は、デフォルトで現在の値になります。表示の原点を更新する際、いくつかの制約が適用されるため、最終的な境界の原点は設定したものとは異なる場合があります。最終的な境界はgetInfoを使用して取得できます。メイン ディスプレイでは境界の起点を変更できません。 -
boundsOriginY
number 省略可
設定されている場合、ディスプレイの論理境界の原点を Y 軸に沿って更新します。
boundsOriginXパラメータのドキュメントをご覧ください。 -
displayMode
DisplayMode 省略可
Chrome 52 以降 Chrome 148 以降の browser.*設定すると、表示モードがこの値に一致するモードに更新されます。他のパラメータが無効な場合、これは適用されません。表示モードが無効な場合、そのモードは適用されず、エラーが設定されますが、他のプロパティは適用されます。
-
displayZoomFactor
number 省略可
Chrome 65 以降 Chrome 148 以降の browser.*設定されている場合、ディスプレイに関連付けられているズームを更新します。このズームでは、再レイアウトと再描画が行われるため、ピクセル単位で拡大するだけのズームよりも高品質なズームが実現します。
-
isPrimary
boolean 省略可
true に設定すると、ディスプレイがメインになります。false に設定すると、no-op になります。注: 設定されている場合、ディスプレイは他のすべてのプロパティのプライマリと見なされます（つまり、
isUnifiedが設定され、境界の原点が設定されていない可能性があります）。 -
isUnified
boolean 省略可
Chrome 59 以降 Chrome 148 以降の browser.*ChromeOS のみ。true に設定した場合、表示モードが統合デスクトップに変更されます（詳しくは
enableUnifiedDesktopをご覧ください）。false に設定した場合、デスクトップ画面統合モードは無効になります。これはプライマリ ディスプレイでのみ有効です。指定する場合、mirroringSourceId は指定しないでください。他のプロパティは無視されます。指定しない場合、この設定は無効になります。 -
mirroringSourceId
文字列 省略可
Chrome 68 以降は非推奨setMirrorModeを使用します。ChromeOS のみ。設定されていて空でない場合、このディスプレイでのみミラーリングが有効になります。それ以外の場合は、すべてのディスプレイでミラーリングを無効にします。この値は、ミラーリングするソース ディスプレイの ID を示す必要があります。この ID は、setDisplayProperties に渡される ID と同じであってはなりません。設定した場合、他のプロパティは設定できません。
-
オーバースキャン
Insets 省略可
設定されている場合、ディスプレイのオーバースキャン インセットを指定された値に設定します。各オーバースキャン インセットは、負の値にしたり、画面サイズの 4 分の 1 より大きくしたりすることはできません。内部モニターではオーバースキャンを変更できません。
-
ローテーション
number 省略可
設定されている場合、ディスプレイの回転を更新します。有効な値は [0, 90, 180, 270] です。回転は、ディスプレイの垂直方向を基準として時計回りに設定されます。
DisplayUnitInfo
プロパティ
-
activeStateChrome 117 以降 Chrome 148 以降の browser.*
ディスプレイが検出され、システムで使用されている場合はアクティブ。
-
availableDisplayZoomFactors
number[]
Chrome 67 以降 Chrome 148 以降の browser.*ディスプレイに設定できるズーム係数の値のリスト。
-
bounds
ディスプレイの論理境界。
-
displayZoomFactor
数値
Chrome 65 以降 Chrome 148 以降の browser.*ディスプレイの現在のズームとデフォルトのズームの比率。たとえば、値 1 は 100% ズームに相当し、値 1.5 は 150% ズームに相当します。
-
dpiX
数値
X 軸に沿った 1 インチあたりのピクセル数。
-
dpiY
数値
Y 軸方向の 1 インチあたりのピクセル数。
-
edid
Edid 省略可
Chrome 67 以降 Chrome 148 以降の browser.*注: これは ChromeOS キオスクアプリでのみ利用できます。
-
hasTouchSupport
ブール値
Chrome 57 以降 Chrome 148 以降の browser.*このディスプレイに関連付けられたタップ入力デバイスがある場合は true。
-
id
文字列
ディスプレイの固有識別子。
-
isEnabled
ブール値
このディスプレイが有効な場合は true。
-
isPrimary
ブール値
プライマリ ディスプレイの場合は true。
-
isUnified
ブール値
Chrome 59 以降 Chrome 148 以降の browser.*デスクトップ画面統合モードの場合は、すべてのディスプレイで true になります。
enableUnifiedDesktopのドキュメントをご覧ください。 -
mirroringDestinationIds
string[]
Chrome 64 以降 Chrome 148 以降の browser.*ChromeOS のみ。ソース ディスプレイがミラーリングされているディスプレイの識別子。ミラーリングされているディスプレイがない場合は空になります。これは、すべてのディスプレイで同じ値に設定されます。
mirroringSourceIdは含めないでください。 -
mirroringSourceId
文字列
ChromeOS のみ。ミラーリングが有効になっている場合は、ミラーリングされているディスプレイの識別子。それ以外の場合は空。これは、すべてのディスプレイ（ミラーリングされているディスプレイを含む）に設定されます。
-
モードChrome 52 以降 Chrome 148 以降の browser.*
使用可能な表示モードのリスト。現在のモードでは isSelected=true になります。ChromeOS でのみ利用できます。他のプラットフォームでは空の配列に設定されます。
-
name
文字列
ユーザー フレンドリーな名前（例: 「HP LCD モニター」）。
-
オーバースキャン
画面の境界内にあるディスプレイのインセット。現在は ChromeOS でのみ公開されています。他のプラットフォームでは空のインセットに設定されます。
-
ローテーション
数値
垂直方向を基準としたディスプレイの時計回りの回転角度。現在は ChromeOS でのみ公開されています。他のプラットフォームでは 0 に設定されます。値が -1 の場合、デバイスが物理的なタブレット状態のときに自動回転として解釈されます。
-
workArea
ディスプレイの境界内にあるディスプレイの使用可能な作業領域。作業領域には、OS 用に予約されているディスプレイの領域（タスクバーやランチャーなど）は含まれません。
Edid
プロパティ
-
manufacturerId
文字列
3 文字のメーカーコード。セクション 3.4.1（21 ページ）を参照。v1.4 で必須。
-
productId
文字列
2 バイトのメーカー割り当てコード（セクション 3.4.2、21 ページ）。v1.4 で必須。
-
yearOfManufacture
数値
製造年、セクション 3.4.4、22 ページ。v1.4 で必須。
GetInfoFlags
プロパティ
-
singleUnified
boolean 省略可
true に設定すると、デスクトップ画面統合モード（
enableUnifiedDesktopを参照）の場合、getInfoによって 1 つのDisplayUnitInfoのみが返されます。デフォルトは false です。
Insets
プロパティ
-
下
数値
下限からの Y 軸の距離。
-
左
数値
左端からの X 軸の距離。
-
右
数値
右端からの X 軸の距離。
-
上
数値
上端からの Y 軸距離。
LayoutPosition
レイアウト位置。つまり、ディスプレイが接続されている親の端。
列挙型
"top"
"right"
"bottom"
"left"
MirrorMode
ミラーモード。ディスプレイを他のディスプレイにミラーリングするさまざまな方法。
列挙型
"off"
デフォルトのモード（拡張デスクトップまたは統合デスクトップ）を指定します。
"normal"
デフォルトのソース ディスプレイが他のすべてのディスプレイにミラーリングされることを指定します。
"mixed"
指定されたソースディスプレイが、指定された宛先ディスプレイにミラーリングされることを指定します。接続されている他のディスプレイはすべて拡張されます。
MirrorModeInfo
プロパティ
-
mirroringDestinationIds
string[] 省略可
ミラーリング宛先の ID が表示されます。これは「mixed」の場合にのみ有効です。
-
mirroringSourceId
文字列 省略可
ミラーリング元のディスプレイの ID。これは「mixed」の場合にのみ有効です。
-
モード
設定するミラーモード。
Point
プロパティ
-
x
数値
点の X 座標。
-
y
数値
ポイントの Y 座標。
TouchCalibrationPair
TouchCalibrationPairQuad
プロパティ
-
pair1
タッチ キャリブレーションには、タッチポイントとディスプレイ ポイントの最初のペアが必要です。
-
pair2
タッチ キャリブレーションには、2 つ目のタッチポイントとディスプレイ ポイントのペアが必要です。
-
pair3
タッチ キャリブレーションには、3 組目のタッチポイントとディスプレイ ポイントが必要です。
-
pair4
タッチ キャリブレーションに必要な 4 番目のタッチポイントとディスプレイ ポイント。
メソッド
clearTouchCalibration()
browser.system.display.clearTouchCalibration(
id: string,
): void
注: これは ChromeOS キオスクアプリでのみ利用できます。ディスプレイのタッチ キャリブレーションをリセットし、ディスプレイに関連付けられているタッチ キャリブレーション データを消去して、デフォルトの状態に戻します。
パラメータ
-
id
文字列
ディスプレイの固有識別子。
completeCustomTouchCalibration()
browser.system.display.completeCustomTouchCalibration(
pairs: TouchCalibrationPairQuad,
bounds: Bounds,
): void
注: これは ChromeOS キオスクアプリでのみ利用できます。ディスプレイのタッチ キャリブレーション ペアを設定します。これらの pairs は、startCustomTouchCalibration() で呼び出された id を使用してディスプレイのタッチスクリーンを調整するために使用されます。このメソッドを呼び出す前に、必ず startCustomTouchCalibration を呼び出してください。別のタッチ キャリブレーションがすでに進行中の場合は、エラーがスローされます。
パラメータ
-
ディスプレイの調整に使用されるポイントのペア。
-
bounds
タッチ キャリブレーションが実行されたときのディスプレイの境界。
bounds.leftとbounds.topの値は無視されます。
enableUnifiedDesktop()
browser.system.display.enableUnifiedDesktop(
enabled: boolean,
): void
注: これは ChromeOS キオスクアプリでのみ利用できます。統合デスクトップ機能を有効または無効にします。ミラーリングが有効なときにこのポリシーを有効にした場合、ミラーリングをオフにするまでデスクトップ モードは変更されません。それ以外の場合は、デスクトップ モードはすぐに統合モードに切り替わります。
パラメータ
-
有効
ブール値
統合デスクトップを有効にする場合は true。
getDisplayLayout()
browser.system.display.getDisplayLayout(): Promise<DisplayLayout[]>
注: これは ChromeOS キオスクアプリでのみ利用できます。すべてのディスプレイのレイアウト情報をリクエストします。
戻り値
-
Promise<DisplayLayout[]>
Chrome 91 以降 Chrome 148 以降の browser.*結果を解決する Promise。
getInfo()
browser.system.display.getInfo(
flags?: GetInfoFlags,
): Promise<DisplayUnitInfo[]>
接続されているすべてのディスプレイ デバイスの情報をリクエストします。
パラメータ
-
flags
GetInfoFlags 省略可
Chrome 59 以降 Chrome 148 以降の browser.*情報の返され方に影響するオプション。
戻り値
-
Promise<DisplayUnitInfo[]>
Chrome 91 以降 Chrome 148 以降の browser.*結果を解決する Promise。
overscanCalibrationAdjust()
browser.system.display.overscanCalibrationAdjust(
id: string,
delta: Insets,
): void
注: これは ChromeOS キオスクアプリでのみ利用できます。ディスプレイの現在のオーバースキャン インセットを調整します。通常、これはディスプレイを軸に沿って移動するか（例: 左右が同じ値）、軸に沿ってスケーリングします（例: 上下が反対の値）。各 Adjust 呼び出しは、Start 以降の以前の呼び出しと累積されます。
パラメータ
-
id
文字列
ディスプレイの固有識別子。
-
デルタ
オーバースキャン インセットを変更する量。
overscanCalibrationComplete()
browser.system.display.overscanCalibrationComplete(
id: string,
): void
注: これは ChromeOS キオスクアプリでのみ利用できます。現在の値を保存してオーバーレイを非表示にすることで、ディスプレイのオーバースキャン調整を完了します。
パラメータ
-
id
文字列
ディスプレイの固有識別子。
overscanCalibrationReset()
browser.system.display.overscanCalibrationReset(
id: string,
): void
注: これは ChromeOS キオスクアプリでのみ利用できます。ディスプレイのオーバースキャン インセットを、最後に保存された値（つまり、Start が呼び出される前の値）にリセットします。
パラメータ
-
id
文字列
ディスプレイの固有識別子。
overscanCalibrationStart()
browser.system.display.overscanCalibrationStart(
id: string,
): void
注: これは ChromeOS キオスクアプリでのみ利用できます。ディスプレイのオーバースキャン キャリブレーションを開始します。これにより、現在のオーバースキャン インセットを示すオーバーレイが画面に表示されます。ディスプレイ id のオーバースキャン キャリブレーションが進行中の場合、キャリブレーションがリセットされます。
パラメータ
-
id
文字列
ディスプレイの固有識別子。
setDisplayLayout()
browser.system.display.setDisplayLayout(
layouts: DisplayLayout[],
): Promise<void>
注: これは ChromeOS キオスクアプリでのみ利用できます。すべてのディスプレイのレイアウトを設定します。含まれていないディスプレイでは、デフォルトのレイアウトが使用されます。レイアウトが重複する場合や、その他の理由で無効な場合は、有効なレイアウトに調整されます。レイアウトが解決されると、onDisplayChanged イベントがトリガーされます。
パラメータ
-
レイアウト
レイアウト情報。プライマリ ディスプレイを除くすべてのディスプレイで必要です。
戻り値
-
Promise<void>
Chrome 91 以降 Chrome 148 以降の browser.*関数の終了時に解決される Promise。
setDisplayProperties()
browser.system.display.setDisplayProperties(
id: string,
info: DisplayProperties,
): Promise<void>
注: これは ChromeOS キオスクアプリでのみ利用できます。info で指定された情報に従って、id で指定されたディスプレイのプロパティを更新します。失敗すると、runtime.lastError が設定されます。
パラメータ
-
id
文字列
ディスプレイの固有識別子。
-
変更する必要があるディスプレイ プロパティに関する情報。プロパティは、
infoで新しい値が指定されている場合にのみ変更されます。
戻り値
-
Promise<void>
Chrome 91 以降 Chrome 148 以降の browser.*関数の終了時に解決される Promise。
setMirrorMode()
browser.system.display.setMirrorMode(
info: MirrorModeInfo,
): Promise<void>
注: これは ChromeOS キオスクアプリでのみ利用できます。ディスプレイ モードを指定されたミラーモードに設定します。呼び出しごとに、以前の呼び出しの状態がリセットされます。ミラーリング先のディスプレイに対して setDisplayProperties() を呼び出すと失敗します。
パラメータ
-
ディスプレイ モードに適用する必要があるミラーモードの情報。
戻り値
-
Promise<void>
Chrome 91 以降 Chrome 148 以降の browser.*関数の終了時に解決される Promise。
showNativeTouchCalibration()
browser.system.display.showNativeTouchCalibration(
id: string,
): Promise<boolean>
注: これは ChromeOS キオスクアプリでのみ利用できます。ディスプレイ ID が id のディスプレイのネイティブ タッチ キャリブレーション UX を表示します。画面にオーバーレイが表示され、必要な手順が示されます。このコールバックは、キャリブレーションが成功した場合にのみ呼び出されます。キャリブレーションに失敗すると、エラーがスローされます。
パラメータ
-
id
文字列
ディスプレイの固有識別子。
戻り値
-
Promise<boolean>
Chrome 91 以降 Chrome 148 以降の browser.*タッチ キャリブレーションが終了したことを呼び出し元に通知する Promise。ブール値は、キャリブレーションが成功したかどうかを示します。
startCustomTouchCalibration()
browser.system.display.startCustomTouchCalibration(
id: string,
): void
注: これは ChromeOS キオスクアプリでのみ利用できます。ディスプレイのカスタム タッチ キャリブレーションを開始します。これは、キャリブレーション データを収集するためにカスタム UX を使用する場合に呼び出す必要があります。別のタッチ キャリブレーションがすでに進行中の場合は、エラーがスローされます。
パラメータ
-
id
文字列
ディスプレイの固有識別子。
イベント
onDisplayChanged
browser.system.display.onDisplayChanged.addListener(
callback: function,
)
ディスプレイ構成に変更があった場合に呼び出されます。
パラメータ
-
callback
関数
callbackパラメータは次のようになります。() => void