browser.system.display

Description

Utilisez l'API system.display pour interroger les métadonnées d'affichage.

Autorisations

system.display

Types

ActiveState

Chrome 117+ browser.* depuis Chrome 148

Énumération indiquant si l'écran est détecté et utilisé par le système. L'écran est considéré comme "inactif" s'il n'est pas détecté par le système (il est peut-être déconnecté ou considéré comme déconnecté en raison du mode veille, etc.). Cet état est utilisé pour conserver l'affichage existant lorsque tous les écrans sont déconnectés, par exemple.

Énumération

"active"

"inactive"

Bounds

Propriétés

• height

  nombre

  Hauteur de l'écran en pixels.

• gauche

  nombre

  Coordonnée X de l'angle supérieur gauche.

• top

  nombre

  Coordonnée Y de l'angle supérieur gauche.

• width

  nombre

  Largeur de l'écran en pixels.

DisplayLayout

Chrome 53 et versions ultérieures browser.* depuis Chrome 148

Propriétés

• id

  chaîne

  Identifiant unique de l'écran.

• offset

  nombre

  Décalage de l'écran le long du bord connecté. La valeur 0 indique que les angles supérieurs ou les plus à gauche sont alignés.

• parentId

  chaîne

  Identifiant unique de l'affichage parent. Vide s'il s'agit de la racine.

• position

  LayoutPosition

  Position de la mise en page de cet écran par rapport au parent. Ce paramètre sera ignoré pour la racine.

DisplayMode

Chrome 52 et versions ultérieures browser.* depuis Chrome 148

Propriétés

• deviceScaleFactor

  nombre

  Facteur de scaling de l'appareil en mode d'affichage.

• height

  nombre

  Hauteur du mode d'affichage en pixels indépendants de l'appareil (visibles par l'utilisateur).

• heightInNativePixels

  nombre

  Hauteur du mode d'affichage en pixels natifs.

• isInterlaced

  boolean facultatif

  Chrome 74 ou version ultérieure browser.* depuis Chrome 148

  "True" si ce mode est entrelacé, "false" si non fourni.

• isNative

  booléen

  "True" si le mode est le mode natif de l'écran.

• isSelected

  booléen

  "True" si le mode d'affichage est actuellement sélectionné.

• refreshRate

  nombre

  Chrome 67+ browser.* depuis Chrome 148

  Fréquence d'actualisation du mode d'affichage en hertz.

• uiScale

  number facultatif

  Obsolète depuis Chrome 70

  Utiliser displayZoomFactor

  Facteur de scaling de l'UI du mode d'affichage.

• width

  nombre

  Largeur du mode d'affichage en pixels indépendants de l'appareil (visibles par l'utilisateur).

• widthInNativePixels

  nombre

  Largeur du mode d'affichage en pixels natifs.

DisplayProperties

Propriétés

• boundsOriginX

  number facultatif

  Si cette option est définie, elle met à jour l'origine des limites logiques de l'écran le long de l'axe X. Appliqué avec boundsOriginY. La valeur par défaut est la valeur actuelle si elle n'est pas définie et que boundsOriginY est défini. Notez que lorsque vous mettez à jour l'origine de l'affichage, certaines contraintes sont appliquées. L'origine finale des limites peut donc être différente de celle définie. Les limites finales peuvent être récupérées à l'aide de getInfo. Impossible de modifier l'origine des limites sur l'écran principal.

• boundsOriginY

  number facultatif

  Si cette option est définie, elle met à jour l'origine des limites logiques de l'écran le long de l'axe Y. Consultez la documentation sur le paramètre boundsOriginX.

• displayMode

  DisplayMode facultatif

  Chrome 52 et versions ultérieures browser.* depuis Chrome 148

  Si ce paramètre est défini, le mode d'affichage est mis à jour pour correspondre à cette valeur. Si d'autres paramètres ne sont pas valides, cela ne sera pas appliqué. Si le mode d'affichage n'est pas valide, il ne sera pas appliqué et une erreur sera définie, mais les autres propriétés seront toujours appliquées.

• displayZoomFactor

  number facultatif

  Chrome 65 et versions ultérieures browser.* depuis Chrome 148

  Si cette option est définie, elle met à jour le zoom associé à l'écran. Ce zoom effectue une nouvelle mise en page et un nouveau rendu, ce qui permet d'obtenir un zoom de meilleure qualité qu'un simple agrandissement pixel par pixel.

• isPrimary

  boolean facultatif

  Si la valeur est "true", l'écran devient l'écran principal. Aucune opération si la valeur est "false". Remarque : Si cette option est définie, l'écran est considéré comme principal pour toutes les autres propriétés (par exemple, isUnified peut être défini, mais pas l'origine des limites).

• isUnified

  boolean facultatif

  Chrome 59 ou version ultérieure browser.* depuis Chrome 148

  ChromeOS uniquement. Si elle est définie sur "True", le mode d'affichage passe au bureau unifié (voir enableUnifiedDesktop pour en savoir plus). Si elle est définie sur "False", le mode Bureau unifié est désactivé. Cela n'est valable que pour l'écran principal. Si cet élément est fourni, mirroringSourceId ne doit pas l'être, et les autres propriétés seront ignorées. Ce paramètre n'a aucun effet s'il n'est pas fourni.

• mirroringSourceId

  chaîne facultatif

  Obsolète depuis Chrome 68

  Utilisez setMirrorMode.

  ChromeOS uniquement. Si cette règle est définie et n'est pas vide, elle active la mise en miroir pour cet écran uniquement. Sinon, désactive la duplication pour tous les écrans. Cette valeur doit indiquer l'ID de l'écran source à dupliquer, qui ne doit pas être identique à l'ID transmis à setDisplayProperties. Si elle est définie, aucune autre propriété ne peut l'être.

• surbalayage

  Insets facultatif

  Si cette option est définie, elle définit les marges de surbalayage de l'écran sur les valeurs fournies. Notez que les valeurs de surbalayage ne peuvent pas être négatives ni supérieures à la moitié de la taille de l'écran. L'overscan ne peut pas être modifié sur l'écran interne.

• rotation

  number facultatif

  Si cette option est définie, elle met à jour la rotation de l'écran. Les valeurs autorisées sont [0, 90, 180, 270]. La rotation est définie dans le sens des aiguilles d'une montre, par rapport à la position verticale de l'écran.

DisplayUnitInfo

Propriétés

• activeState

  ActiveState

  Chrome 117+ browser.* depuis Chrome 148

  "Actif" si l'écran est détecté et utilisé par le système.

• availableDisplayZoomFactors

  number[]

  Chrome 67+ browser.* depuis Chrome 148

  Liste des valeurs de facteur de zoom pouvant être définies pour l'affichage.

• bounds

  Limites

  Limites logiques de l'affichage.

• displayZoomFactor

  nombre

  Chrome 65 et versions ultérieures browser.* depuis Chrome 148

  Ratio entre le zoom actuel et le zoom par défaut de l'écran. Par exemple, la valeur 1 équivaut à un zoom de 100 % et la valeur 1, 5 à un zoom de 150 %.

• dpiX

  nombre

  Nombre de pixels par pouce le long de l'axe X.

• dpiY

  nombre

  Nombre de pixels par pouce le long de l'axe Y.

• edid

  Edid facultatif

  Chrome 67+ browser.* depuis Chrome 148

  REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS.

• hasTouchSupport

  booléen

  Chrome 57 et versions ultérieures browser.* depuis Chrome 148

  "True" si cet écran est associé à un périphérique de saisie tactile.

• id

  chaîne

  Identifiant unique de l'écran.

• isEnabled

  booléen

  "True" si cet affichage est activé.

• isPrimary

  booléen

  "True" s'il s'agit de l'écran principal.

• isUnified

  booléen

  Chrome 59 ou version ultérieure browser.* depuis Chrome 148

  "True" pour tous les écrans en mode Bureau unifié. Consultez la documentation sur enableUnifiedDesktop.

• mirroringDestinationIds

  chaîne[]

  Chrome 64+ browser.* depuis Chrome 148

  ChromeOS uniquement. Identifiants des écrans sur lesquels l'écran source est dupliqué. Ce champ est vide si aucun écran n'est mis en miroir. Cette valeur sera la même pour tous les écrans. Il ne doit pas inclure mirroringSourceId.

• mirroringSourceId

  chaîne

  ChromeOS uniquement. Identifiant de l'écran mis en miroir si la mise en miroir est activée, sinon vide. Cette option sera définie pour tous les écrans (y compris l'écran mis en miroir).

• modes

  DisplayMode[]

  Chrome 52 et versions ultérieures browser.* depuis Chrome 148

  Liste des modes d'affichage disponibles. Le mode actuel aura la valeur isSelected=true. Disponible uniquement sur ChromeOS. Sera défini sur un tableau vide sur les autres plates-formes.

• nom

  chaîne

  Nom convivial (par exemple, "Écran LCD HP").

• surbalayage

  Encarts

  Marges intérieures de l'affichage dans les limites de l'écran. Actuellement exposé uniquement sur ChromeOS. Sera défini sur des encarts vides sur les autres plates-formes.

• rotation

  nombre

  Rotation de l'écran dans le sens des aiguilles d'une montre, en degrés, par rapport à la position verticale. Actuellement exposé uniquement sur ChromeOS. Sera défini sur 0 sur les autres plates-formes. La valeur -1 sera interprétée comme une rotation automatique lorsque l'appareil est en mode Tablette.

• workArea

  Limites

  Zone de travail utilisable de l'écran dans les limites de l'écran. La zone de travail exclut les zones de l'écran réservées à l'OS, par exemple la barre des tâches et le lanceur d'applications.

Edid

Chrome 67+ browser.* depuis Chrome 148

Propriétés

• manufacturerId

  chaîne

  Code fabricant à trois caractères. Voir la section 3.4.1, page 21. Obligatoire dans la version 1.4.

• productId

  chaîne

  Code de deux octets attribué par le fabricant, section 3.4.2, page 21. Obligatoire dans la version 1.4.

• yearOfManufacture

  nombre

  Année de fabrication, section 3.4.4, page 22. Obligatoire dans la version 1.4.

GetInfoFlags

Chrome 59 ou version ultérieure browser.* depuis Chrome 148

Propriétés

• singleUnified

  boolean facultatif

  Si cette règle est définie sur "True", un seul DisplayUnitInfo sera renvoyé par getInfo en mode Bureau unifié (voir enableUnifiedDesktop). La valeur par défaut est "False".

Insets

Propriétés

• depuis le bord inférieur

  nombre

  Distance de l'axe des ordonnées par rapport à la limite inférieure.

• gauche

  nombre

  Distance de l'axe X par rapport à la limite gauche.

• droite

  nombre

  Distance de l'axe X par rapport à la limite droite.

• top

  nombre

  Distance de l'axe des ordonnées par rapport à la limite supérieure.

LayoutPosition

Chrome 53 et versions ultérieures browser.* depuis Chrome 148

Position de la mise en page, c'est-à-dire le bord du parent auquel l'affichage est associé.

Énumération

"top"

"right"

"bottom"

"left"

MirrorMode

Chrome 65 et versions ultérieures browser.* depuis Chrome 148

Mode miroir, c'est-à-dire différentes manières de dupliquer un écran sur d'autres écrans.

Énumération

"off"
Spécifie le mode par défaut (bureau étendu ou unifié).

"normal"
Indique que l'affichage source par défaut sera dupliqué sur tous les autres écrans.

"mixed"
Indique que l'écran source spécifié sera dupliqué sur les écrans de destination fournis. Tous les autres écrans connectés seront étendus.

MirrorModeInfo

Chrome 65 et versions ultérieures browser.* depuis Chrome 148

Propriétés

• mirroringDestinationIds

  string[] facultatif

  Les ID des écrans de destination de la mise en miroir. Cette option n'est valide que pour "mixed".

• mirroringSourceId

  chaîne facultatif

  ID de l'écran source de la mise en miroir. Cette option n'est valide que pour "mixed".

• mode

  MirrorMode

  Mode miroir à définir.

Point

Chrome 57 et versions ultérieures browser.* depuis Chrome 148

Propriétés

• x

  nombre

  Coordonnée X du point.

• y

  nombre

  Coordonnée Y du point.

TouchCalibrationPair

Chrome 57 et versions ultérieures browser.* depuis Chrome 148

Propriétés

• displayPoint

  Point

  Coordonnées du point d'affichage.

• touchPoint

  Point

  Coordonnées du point de contact correspondant au point d'affichage.

TouchCalibrationPairQuad

Chrome 57 et versions ultérieures browser.* depuis Chrome 148

Propriétés

• pair1

  TouchCalibrationPair

  Première paire de points de contact et d'affichage requise pour l'étalonnage tactile.

• pair2

  TouchCalibrationPair

  Deuxième paire de points de contact et d'affichage requise pour l'étalonnage tactile.

• pair3

  TouchCalibrationPair

  Une troisième paire de points de contact et d'affichage est requise pour l'étalonnage tactile.

• pair4

  TouchCalibrationPair

  Quatrième paire de points tactiles et d'affichage requise pour l'étalonnage tactile.

Méthodes

clearTouchCalibration()

Chrome 57 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.clearTouchCalibration(
  id: string,
): void

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Réinitialise l'étalonnage de l'écran tactile et le rétablit à son état par défaut en effaçant toutes les données d'étalonnage de l'écran tactile associées à l'écran.

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

completeCustomTouchCalibration()

Chrome 57 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
): void

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Définit les paires d'étalonnage tactile d'un écran. Ces pairs seront utilisés pour calibrer l'écran tactile pour l'affichage avec id appelé dans startCustomTouchCalibration(). Appelez toujours startCustomTouchCalibration avant d'appeler cette méthode. Si un autre étalonnage tactile est déjà en cours, une erreur sera générée.

Paramètres

• paires

  TouchCalibrationPairQuad

  Paires de points utilisées pour calibrer l'affichage.

• bounds

  Limites

  Limites de l'écran lorsque l'étalonnage tactile a été effectué. Les valeurs bounds.left et bounds.top sont ignorées.

enableUnifiedDesktop()

Chrome 46 ou version ultérieure browser.* depuis Chrome 148

browser.system.display.enableUnifiedDesktop(
  enabled: boolean,
): void

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Active/Désactive la fonctionnalité de bureau unifié. Si cette option est activée alors que la mise en miroir est active, le mode ordinateur ne changera pas tant que la mise en miroir ne sera pas désactivée. Sinon, le mode ordinateur passera immédiatement en mode unifié.

Paramètres

• activé

  booléen

  "True" si le bureau unifié doit être activé.

getDisplayLayout()

Chrome 53 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.getDisplayLayout(): Promise<DisplayLayout[]>

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Demande les informations de mise en page pour tous les écrans.

Renvoie

• Promise<DisplayLayout[]>

  Chrome 91 et versions ultérieures browser.* depuis Chrome 148

  Promesse qui se résout avec les résultats.

getInfo()

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

Demande les informations pour tous les appareils d'affichage connectés.

Paramètres

• flags

  GetInfoFlags facultatif

  Chrome 59 ou version ultérieure browser.* depuis Chrome 148

  Options affectant la façon dont les informations sont renvoyées.

Renvoie

• Promise<DisplayUnitInfo[]>

  Chrome 91 et versions ultérieures browser.* depuis Chrome 148

  Promesse qui se résout avec les résultats.

overscanCalibrationAdjust()

Chrome 53 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
): void

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Ajuste les encarts de surbalayage actuels d'un écran. En règle générale, cela doit déplacer l'affichage le long d'un axe (par exemple, gauche et droite ont la même valeur) ou le mettre à l'échelle le long d'un axe (par exemple, haut et bas ont des valeurs opposées). Chaque appel Adjust est cumulatif avec les appels précédents depuis Start.

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

• delta

  Encarts

  Montant de modification des encarts de surbalayage.

overscanCalibrationComplete()

Chrome 53 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.overscanCalibrationComplete(
  id: string,
): void

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Terminez les réglages de surbalayage d'un écran en enregistrant les valeurs actuelles et en masquant la superposition.

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

overscanCalibrationReset()

Chrome 53 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.overscanCalibrationReset(
  id: string,
): void

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Réinitialise les marges d'overscan d'un écran à la dernière valeur enregistrée (c'est-à-dire avant l'appel de Start).

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

overscanCalibrationStart()

Chrome 53 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.overscanCalibrationStart(
  id: string,
): void

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Démarre l'étalonnage du surbalayage pour un écran. Une superposition s'affiche alors à l'écran, indiquant les encarts de surbalayage actuels. Si l'étalonnage du surbalayage de l'écran id est en cours, il sera réinitialisé.

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

setDisplayLayout()

Chrome 53 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
): Promise<void>

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Définissez la mise en page pour tous les écrans. Les écrans non inclus utiliseront la mise en page par défaut. Si une mise en page se chevauche ou n'est pas valide, elle sera ajustée pour devenir valide. Une fois la mise en page résolue, un événement onDisplayChanged est déclenché.

Paramètres

• Mises en page

  DisplayLayout[]

  Informations sur la mise en page, requises pour tous les écrans, à l'exception de l'écran principal.

Renvoie

• Promise<void>

  Chrome 91 et versions ultérieures browser.* depuis Chrome 148

  Promesse qui se résout lorsque la fonction se termine.

setDisplayProperties()

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

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Met à jour les propriétés de l'écran spécifié par id, en fonction des informations fournies dans info. En cas d'échec, runtime.lastError sera défini.

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

• info

  DisplayProperties

  Informations sur les propriétés d'affichage à modifier. Une propriété ne sera modifiée que si une nouvelle valeur est spécifiée dans info.

Renvoie

• Promise<void>

  Chrome 91 et versions ultérieures browser.* depuis Chrome 148

  Promesse qui se résout lorsque la fonction se termine.

setMirrorMode()

Chrome 65 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.setMirrorMode(
  info: MirrorModeInfo,
): Promise<void>

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Définit le mode d'affichage sur le mode miroir spécifié. Chaque appel réinitialise l'état des appels précédents. L'appel de setDisplayProperties() échouera pour les écrans de destination de la mise en miroir.

Paramètres

• info

  MirrorModeInfo

  Informations sur le mode miroir à appliquer au mode d'affichage.

Renvoie

• Promise<void>

  Chrome 91 et versions ultérieures browser.* depuis Chrome 148

  Promesse qui se résout lorsque la fonction se termine.

showNativeTouchCalibration()

Chrome 57 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.showNativeTouchCalibration(
  id: string,
): Promise<boolean>

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Affiche l'UX d'étalonnage tactile native pour l'écran avec l'ID d'écran id. Une superposition s'affiche alors à l'écran avec les instructions à suivre. Le rappel ne sera invoqué que si le calibrage réussit. Si l'étalonnage échoue, une erreur est générée.

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

Renvoie

• Promise<boolean>

  Chrome 91 et versions ultérieures browser.* depuis Chrome 148

  Promesse qui se résout pour informer l'appelant que l'étalonnage tactile est terminé. La valeur booléenne indique si l'étalonnage a réussi ou non.

startCustomTouchCalibration()

Chrome 57 et versions ultérieures browser.* depuis Chrome 148

browser.system.display.startCustomTouchCalibration(
  id: string,
): void

REMARQUE : Cette option n'est disponible que pour les applications kiosque ChromeOS. Démarre l'étalonnage tactile personnalisé d'un écran. Cette méthode doit être appelée lorsque vous utilisez une UX personnalisée pour collecter des données d'étalonnage. Si un autre étalonnage tactile est déjà en cours, une erreur sera générée.

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

Événements

onDisplayChanged

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

Se déclenche lorsque la configuration d'affichage est modifiée.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  () => void