Beschreibung
Verwenden Sie die system.display
API, um Displaymetadaten abzufragen.
Berechtigungen
system.display
Typen
ActiveState
Ein Enum, das angibt, ob das Display vom System erkannt und verwendet wird. Das Display wird als inaktiv betrachtet, wenn es vom System nicht erkannt wird (z. B. getrennt oder aufgrund des Ruhemodus als getrennt betrachtet). Dieser Status wird verwendet, um das vorhandene Display beizubehalten, wenn beispielsweise alle Displays getrennt sind.
Enum
„active“
„inactive“
Bounds
Attribute
-
Höhe
Zahl
Die Höhe des Displays in Pixeln.
-
links
Zahl
Die X-Koordinate der linken oberen Ecke.
-
oben
Zahl
Die Y-Koordinate der linken oberen Ecke.
-
Breite
Zahl
Die Breite des Displays in Pixeln.
DisplayLayout
Attribute
-
id
String
Die eindeutige Kennung des Displays.
-
kompensiert
Zahl
Der Versatz des Displays entlang der verbundenen Kante. „0“ gibt an, dass die oberste oder linkeste Ecke ausgerichtet ist.
-
parentId
String
Die eindeutige Kennung des übergeordneten Displays. Leeres Feld, wenn dies der Stamm ist.
-
position
Die Layoutposition dieses Displays relativ zum übergeordneten Element. Für den Stamm wird dies ignoriert.
DisplayMode
Attribute
-
deviceScaleFactor
Zahl
Der Skalierungsfaktor des Geräts im Anzeigemodus.
-
Höhe
Zahl
Die Höhe des Displaymodus in geräteunabhängigen (für Nutzer sichtbaren) Pixeln.
-
heightInNativePixels
Zahl
Die Höhe des Anzeigemodus in nativen Pixeln.
-
isInterlaced
boolescher Wert optional
Chrome 74 und höher„True“, wenn dieser Modus interlaced ist, „False“, wenn er nicht angegeben ist.
-
isNative
boolean
„True“, wenn der Modus der native Modus des Displays ist.
-
isSelected
boolean
„Wahr“, wenn der Anzeigemodus derzeit ausgewählt ist.
-
refreshRate
Zahl
Chrome 67 und höherDie Aktualisierungsrate des Displaymodus in Hertz.
-
uiScale
number optional
Seit Chrome 70 eingestellt„
displayZoomFactor
“ verwendenDer Skalierungsfaktor der Benutzeroberfläche im Displaymodus.
-
Breite
Zahl
Die Breite des Displaymodus in geräteunabhängigen (für Nutzer sichtbaren) Pixeln.
-
widthInNativePixels
Zahl
Die Breite des Anzeigemodus in nativen Pixeln.
DisplayProperties
Attribute
-
boundsOriginX
number optional
Wenn festgelegt, wird der Ursprung der logischen Grenzen des Displays entlang der X-Achse aktualisiert. Wird zusammen mit
boundsOriginY
angewendet. Enthält standardmäßig den aktuellen Wert, wenn er nicht festgelegt ist undboundsOriginY
festgelegt ist. Beachten Sie, dass beim Aktualisieren des Ursprungs der Anzeige einige Einschränkungen angewendet werden. Daher kann der endgültige Ursprung der Grenzen von dem festgelegten abweichen. Die endgültigen Grenzen können mitgetInfo
abgerufen werden. Der Ursprung der Begrenzungen kann auf dem primären Display nicht geändert werden. -
boundsOriginY
number optional
Wenn festgelegt, wird der Ursprung der logischen Begrenzungen des Displays entlang der y-Achse aktualisiert. Weitere Informationen finden Sie in der Dokumentation zum Parameter
boundsOriginX
. -
displayMode
DisplayMode optional
Chrome 52 und höherWenn dieser Wert festgelegt ist, wird der Anzeigemodus auf den zugehörigen Modus aktualisiert. Wenn andere Parameter ungültig sind, wird dieser Parameter nicht angewendet. Wenn der Anzeigemodus ungültig ist, wird er nicht angewendet und ein Fehler wird ausgegeben. Andere Properties werden jedoch weiterhin angewendet.
-
displayZoomFactor
number optional
Chrome 65 und höherWenn diese Option festgelegt ist, wird der Zoom für das Display aktualisiert. Bei diesem Zoom wird das Layout neu angeordnet und neu gerendert. Dadurch ist die Qualität höher als bei einer einfachen Pixel-für-Pixel-Vergrößerung.
-
isPrimary
boolescher Wert optional
Wenn diese Option auf „wahr“ gesetzt ist, wird das Display als primär festgelegt. Wird auf „false“ gesetzt, hat dies keine Auswirkungen. Hinweis: Wenn festgelegt, wird das Display für alle anderen Properties als primär betrachtet. Das bedeutet, dass
isUnified
festgelegt sein kann, der Ursprung des Bereichs aber nicht. -
isUnified
boolescher Wert optional
Chrome 59 und höherNur ChromeOS. Wenn diese Option auf „wahr“ gesetzt ist, wird der Anzeigemodus in „Unified Desktop“ geändert (weitere Informationen finden Sie unter
enableUnifiedDesktop
). Ist die Einstellung auf „false“ gesetzt, wird der Unified Desktop-Modus deaktiviert. Dies gilt nur für das primäre Display. Wenn diese Angabe erfolgt, darf „mirroringSourceId“ nicht angegeben werden und andere Properties werden ignoriert. Wenn Sie dieses Attribut nicht angeben, hat das keine Auswirkungen. -
mirroringSourceId
String optional
Seit Chrome 68 eingestelltVerwenden Sie
setMirrorMode
.Nur ChromeOS. Wenn diese Einstellung festgelegt und nicht leer ist, wird die Spiegelung nur für dieses Display aktiviert. Andernfalls wird die Spiegelung für alle Displays deaktiviert. Dieser Wert sollte die ID des zu spiegelnden Quelldisplays angeben. Sie darf nicht mit der ID übereinstimmen, die an „setDisplayProperties“ übergeben wird. Wenn diese Option festgelegt ist, kann keine andere Property festgelegt werden.
-
Overscan
Rahmen optional
Wenn festgelegt, werden die Overscan-Inlays des Displays auf die angegebenen Werte gesetzt. Die Werte für den Overscan dürfen nicht negativ sein oder mehr als die Hälfte der Bildschirmgröße betragen. Der Overscan kann auf dem internen Monitor nicht geändert werden.
-
Drehung
number optional
Wenn diese Option festgelegt ist, wird die Bildschirmdrehung aktualisiert. Gültige Werte sind [0, 90, 180, 270]. Die Drehung wird im Uhrzeigersinn relativ zur vertikalen Position des Displays festgelegt.
DisplayUnitInfo
Attribute
-
activeStateChrome 117 und höher
Aktiv, wenn das Display vom System erkannt und verwendet wird.
-
availableDisplayZoomFactors
number[]
Chrome 67 und höherEine Liste der Zoomfaktorwerte, die für die Anzeige festgelegt werden können.
-
Grenzen
Die logischen Grenzen des Displays.
-
displayZoomFactor
Zahl
Chrome 65 und höherDas Verhältnis zwischen dem aktuellen und dem Standardzoom des Displays. Der Wert 1 entspricht beispielsweise einem Zoom von 100% und der Wert 1,5 einem Zoom von 150 %.
-
dpiX
Zahl
Die Anzahl der Pixel pro Zoll entlang der X-Achse.
-
dpiY
Zahl
Die Anzahl der Pixel pro Zoll entlang der y-Achse.
-
edid
Edid optional
Chrome 67 und höherHINWEIS: Diese Funktion ist nur für ChromeOS-Kiosk-Apps und die Web-Benutzeroberfläche verfügbar.
-
hasTouchSupport
boolean
Chrome 57 und höher„Wahr“, wenn diesem Display ein Eingabegerät mit Touchbedienung zugewiesen ist.
-
id
String
Die eindeutige Kennung des Displays.
-
isEnabled
boolean
„True“, wenn dieses Display aktiviert ist.
-
isPrimary
boolean
„True“, wenn dies der primäre Bildschirm ist.
-
isUnified
boolean
Chrome 59 und höherIm Unified Desktop-Modus gilt dies für alle Displays. Weitere Informationen finden Sie in der Dokumentation für
enableUnifiedDesktop
. -
mirroringDestinationIds
String[]
Chrome 64 und höherNur ChromeOS. IDs der Displays, auf die das Quelldisplay gespiegelt wird. Leer, wenn keine Displays gespiegelt werden. Dieser Wert wird für alle Displays auf denselben Wert festgelegt.
mirroringSourceId
darf nicht enthalten sein. -
mirroringSourceId
String
Nur ChromeOS. Die Kennung des gespiegelten Displays, wenn die Spiegelung aktiviert ist, andernfalls leer. Diese Einstellung wird für alle Displays festgelegt, einschließlich des gespiegelten Displays.
-
ModiChrome 52 und höher
Liste der verfügbaren Anzeigemodi. Für den aktuellen Modus gilt isSelected=true. Nur unter ChromeOS verfügbar. Wird auf anderen Plattformen auf ein leeres Array gesetzt.
-
name
String
Der nutzerfreundliche Name (z. B. „HP LCD-Monitor“)
-
Overscan
Die Einschnitte des Displays innerhalb des Bildschirms. Derzeit nur unter ChromeOS verfügbar. Auf anderen Plattformen werden leere Einleger verwendet.
-
Drehung
Zahl
Die Drehung des Displays im Uhrzeigersinn in Grad relativ zur vertikalen Position. Derzeit nur unter ChromeOS verfügbar. Wird auf anderen Plattformen auf „0“ gesetzt. Ein Wert von -1 wird als „Automatische Drehung“, wenn sich das Gerät im Tablet-Modus befindet, interpretiert.
-
workArea
Der nutzbare Arbeitsbereich des Displays innerhalb der Displaygrenzen. Der Arbeitsbereich schließt Bereiche des Displays aus, die für das Betriebssystem reserviert sind, z. B. die Taskleiste und den Launcher.
Edid
Attribute
-
manufacturerId
String
Dreistelliger Herstellercode. Siehe Abschnitt 3.4.1 auf Seite 21. In Version 1.4 erforderlich.
-
productId
String
Vom Hersteller zugewiesener 2-Byte-Code, Abschnitt 3.4.2, Seite 21. In Version 1.4 erforderlich.
-
yearOfManufacture
Zahl
Herstellungsjahr, Abschnitt 3.4.4, Seite 22. In Version 1.4 erforderlich.
GetInfoFlags
Attribute
-
singleUnified
boolescher Wert optional
Wenn dieser Wert auf „wahr“ gesetzt ist, gibt
getInfo
im Unified Desktop-Modus nur eine einzigeDisplayUnitInfo
zurück (sieheenableUnifiedDesktop
). Standardmäßig ist der Wert „falsch“.
Insets
Attribute
-
unten
Zahl
Der Abstand der Y-Achse von der unteren Begrenzung.
-
links
Zahl
Der Abstand der X-Achse von der linken Begrenzung.
-
rechts
Zahl
Der Abstand der X-Achse von der rechten Begrenzung.
-
oben
Zahl
Der Abstand der Y-Achse von der Obergrenze.
LayoutPosition
Layoutposition, d.h. Kante des übergeordneten Elements, an dem das Display angehängt ist.
Enum
„top“
„right“
„bottom“
"left"
MirrorMode
Spiegelmodus, d.h. verschiedene Möglichkeiten, wie ein Display auf anderen Displays gespiegelt wird.
Enum
„off“
Definiert den Standardmodus (erweiterter oder Unified Desktop).
„normal“
Gibt an, dass das Standard-Queldisplay auf allen anderen Displays gespiegelt wird.
„mixed“
Gibt an, dass das angegebene Quelldisplay auf die angegebenen Zieldisplays gespiegelt wird. Alle anderen verbundenen Displays werden verlängert.
MirrorModeInfo
Attribute
-
mirroringDestinationIds
string[] optional
Die IDs des Spiegelungsziels werden angezeigt. Das gilt nur für „gemischt“.
-
mirroringSourceId
String optional
Die ID des Displays der Spiegelungsquelle. Das gilt nur für „gemischt“.
-
Modus
Der Spiegelmodus, der festgelegt werden soll.
Point
Attribute
-
x
Zahl
Die x-Koordinate des Punkts.
-
y
Zahl
Die y-Koordinate des Punkts.
TouchCalibrationPair
Attribute
-
displayPoint
Die Koordinaten des Anzeigepunkts.
-
touchPoint
Die Koordinaten des Touch-Punkts, der dem Displaypunkt entspricht.
TouchCalibrationPairQuad
Attribute
-
pair1
Erstes Paar aus Touch- und Displaypunkt, das für die Touch-Kalibrierung erforderlich ist.
-
pair2
Für die Touch-Kalibrierung ist ein zweites Paar aus Touch- und Displaypunkt erforderlich.
-
pair3
Für die Touch-Kalibrierung ist ein drittes Paar aus Touch- und Displaypunkt erforderlich.
-
pair4
Viertes Paar aus Touch- und Displaypunkt, das für die Touch-Kalibrierung erforderlich ist.
Methoden
clearTouchCalibration()
chrome.system.display.clearTouchCalibration(
id: string,
)
Die Touchbedienung wird für das Display zurückgesetzt und in den Standardzustand versetzt, indem alle mit dem Display verknüpften Touchbedienungsdaten gelöscht werden.
Parameter
-
id
String
Die eindeutige Kennung des Displays.
completeCustomTouchCalibration()
chrome.system.display.completeCustomTouchCalibration(
pairs: TouchCalibrationPairQuad,
bounds: Bounds,
)
Legt die Touch-Kalibrierungspaare für ein Display fest. Diese pairs
werden verwendet, um den Touchscreen für das Display zu kalibrieren. id
wird in startCustomTouchCalibration() aufgerufen. Rufen Sie immer startCustomTouchCalibration
auf, bevor Sie diese Methode aufrufen. Wenn bereits eine andere Touchbedienungskalibrierung läuft, wird ein Fehler ausgegeben.
Parameter
-
Paare
Die Punktpaare, die zum Kalibrieren des Displays verwendet werden.
-
Grenzen
Ränder des Displays bei der Touchbedienungskalibrierung.
bounds.left
- undbounds.top
-Werte werden ignoriert.
enableUnifiedDesktop()
chrome.system.display.enableUnifiedDesktop(
enabled: boolean,
)
Hiermit wird die Funktion „Unified Desktop“ aktiviert oder deaktiviert. Wenn die Funktion aktiviert ist, während die Spiegelung aktiv ist, ändert sich der Desktopmodus erst, wenn die Spiegelung deaktiviert wird. Andernfalls wird der Desktopmodus sofort in den einheitlichen Modus umgeschaltet. HINWEIS: Diese Funktion ist nur für ChromeOS-Kiosk-Apps und die Web-Benutzeroberfläche verfügbar.
Parameter
-
aktiviert
boolean
„True“, wenn der einheitliche Desktop aktiviert werden soll.
getDisplayLayout()
chrome.system.display.getDisplayLayout(
callback?: function,
)
Hier werden die Layoutinformationen für alle Displays angefordert. HINWEIS: Diese Funktion ist nur für ChromeOS-Kiosk-Apps und die Web-Benutzeroberfläche verfügbar.
Parameter
-
callback
function optional
Der Parameter
callback
sieht so aus:(layouts: DisplayLayout[]) => void
-
layouts
-
Ausgabe
-
Promise<DisplayLayout[]>
Chrome 91 und höherVersprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können beide nicht für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.
getInfo()
chrome.system.display.getInfo(
flags?: GetInfoFlags,
callback?: function,
)
Hier werden die Informationen für alle angeschlossenen Displaygeräte angefordert.
Parameter
-
flags
GetInfoFlags optional
Chrome 59 und höherOptionen, die sich auf die Rückgabe der Informationen auswirken.
-
callback
function optional
Der Parameter
callback
sieht so aus:(displayInfo: DisplayUnitInfo[]) => void
-
displayInfo
-
Ausgabe
-
Promise<DisplayUnitInfo[]>
Chrome 91 und höherVersprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können nicht beide für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.
overscanCalibrationAdjust()
chrome.system.display.overscanCalibrationAdjust(
id: string,
delta: Insets,
)
Passt die aktuellen Overscan-Einschnitte für ein Display an. Normalerweise sollte das Display entweder entlang einer Achse verschoben (z.B. haben „links“ und „rechts“ denselben Wert) oder entlang einer Achse skaliert werden (z.B. haben „oben“ und „unten“ entgegengesetzte Werte). Jeder Adjust-Aufruf ist kumulativ mit vorherigen Aufrufen seit Start.
Parameter
-
id
String
Die eindeutige Kennung des Displays.
-
delta
Der Wert, um den die Überblendungsbereiche geändert werden sollen.
overscanCalibrationComplete()
chrome.system.display.overscanCalibrationComplete(
id: string,
)
Schließen Sie die Anpassungen des Overscans für ein Display ab, indem Sie die aktuellen Werte speichern und das Overlay ausblenden.
Parameter
-
id
String
Die eindeutige Kennung des Displays.
overscanCalibrationReset()
chrome.system.display.overscanCalibrationReset(
id: string,
)
Die Überblendungsbereiche für ein Display werden auf den zuletzt gespeicherten Wert zurückgesetzt (d. h. vor dem Aufruf von „Start“).
Parameter
-
id
String
Die eindeutige Kennung des Displays.
overscanCalibrationStart()
chrome.system.display.overscanCalibrationStart(
id: string,
)
Startet die Kalibrierung des Overscans für ein Display. Daraufhin wird ein Overlay auf dem Bildschirm angezeigt, das die aktuellen Overscan-Einblendungen angibt. Wenn die Kalibrierung des Overscans für das Display id
gerade ausgeführt wird, wird die Kalibrierung zurückgesetzt.
Parameter
-
id
String
Die eindeutige Kennung des Displays.
setDisplayLayout()
chrome.system.display.setDisplayLayout(
layouts: DisplayLayout[],
callback?: function,
)
Legen Sie das Layout für alle Displays fest. Für nicht enthaltene Displays wird das Standardlayout verwendet. Wenn ein Layout überlappen würde oder anderweitig ungültig ist, wird es an ein gültiges Layout angepasst. Nachdem das Layout ermittelt wurde, wird das Ereignis „onDisplayChanged“ ausgelöst. HINWEIS: Diese Funktion ist nur für ChromeOS-Kiosk-Apps und die Web-Benutzeroberfläche verfügbar.
Parameter
-
layouts
Layoutinformationen, erforderlich für alle Displays mit Ausnahme des primären Displays.
-
callback
function optional
Der Parameter
callback
sieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 91 und höherVersprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können beide nicht für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.
setDisplayProperties()
chrome.system.display.setDisplayProperties(
id: string,
info: DisplayProperties,
callback?: function,
)
Aktualisiert die Eigenschaften für das Display, das durch id
angegeben ist, gemäß den Informationen in info
. Bei einem Fehler wird runtime.lastError
festgelegt. HINWEIS: Diese Funktion ist nur für ChromeOS-Kiosk-Apps und die Web-Benutzeroberfläche verfügbar.
Parameter
-
id
String
Die eindeutige Kennung des Displays.
-
Info
Informationen zu den Anzeigeeigenschaften, die geändert werden sollen. Eine Property wird nur geändert, wenn in
info
ein neuer Wert für sie angegeben wird. -
callback
function optional
Der Parameter
callback
sieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 91 und höherVersprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können beide nicht für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.
setMirrorMode()
chrome.system.display.setMirrorMode(
info: MirrorModeInfo,
callback?: function,
)
Legt den Anzeigemodus auf den angegebenen Spiegelmodus fest. Bei jedem Aufruf wird der Status der vorherigen Aufrufe zurückgesetzt. Der Aufruf von setDisplayProperties() schlägt für die Zielbildschirme der Spiegelung fehl. HINWEIS: Diese Funktion ist nur für ChromeOS-Kiosk-Apps und die Web-Benutzeroberfläche verfügbar.
Parameter
-
Info
Die Informationen zum Spiegelmodus, die auf den Anzeigemodus angewendet werden sollen.
-
callback
function optional
Der Parameter
callback
sieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 91 und höherVersprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können beide nicht für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.
showNativeTouchCalibration()
chrome.system.display.showNativeTouchCalibration(
id: string,
callback?: function,
)
Die native Touch-Kalibrierungs-UX für das Display mit id
als Display-ID wird angezeigt. Daraufhin wird ein Overlay mit einer Anleitung auf dem Bildschirm angezeigt. Der Rückruf wird nur bei erfolgreicher Kalibrierung aufgerufen. Wenn die Kalibrierung fehlschlägt, wird ein Fehler ausgegeben.
Parameter
-
id
String
Die eindeutige Kennung des Displays.
-
callback
function optional
Der Parameter
callback
sieht so aus:(success: boolean) => void
-
Erfolg
boolean
-
Ausgabe
-
Promise<boolean>
Chrome 91 und höherVersprechen werden in Manifest V3 und höher unterstützt, aber Callbacks sind für die Abwärtskompatibilität verfügbar. Sie können nicht beide für denselben Funktionsaufruf verwenden. Das Versprechen wird mit demselben Typ aufgelöst, der an den Rückruf übergeben wird.
startCustomTouchCalibration()
chrome.system.display.startCustomTouchCalibration(
id: string,
)
Startet die benutzerdefinierte Touchbedienungskalibrierung für ein Display. Diese Funktion sollte aufgerufen werden, wenn Sie eine benutzerdefinierte UX für die Erfassung von Kalibrierungsdaten verwenden. Wenn bereits eine andere Touchbedienungskalibrierung läuft, wird ein Fehler ausgegeben.
Parameter
-
id
String
Die eindeutige Kennung des Displays.
Ereignisse
onDisplayChanged
chrome.system.display.onDisplayChanged.addListener(
callback: function,
)
Wird ausgelöst, wenn sich die Displaykonfiguration ändert.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:() => void