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