chrome.system.display

Description

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

Autorisations

system.display

Types

ActiveState

Chrome 117 et versions ultérieures

É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 (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

  • hauteur

    Total

    Hauteur de l'écran en pixels.

  • gauche

    Total

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

  • top

    Total

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

  • largeur

    Total

    Largeur de l'écran en pixels.

DisplayLayout

Chrome 53 et versions ultérieures

Propriétés

  • id

    chaîne

    Identifiant unique de l'écran.

  • offset

    Total

    Décalage de l'écran le long du bord connecté. 0 indique que les angles les plus hauts 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 affichage par rapport au parent. Cette valeur sera ignorée pour la racine.

DisplayMode

Chrome 52 et versions ultérieures

Propriétés

  • deviceScaleFactor

    Total

    Facteur d'échelle de l'appareil pour le mode d'affichage.

  • hauteur

    Total

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

  • heightInNativePixels

    Total

    Hauteur du mode d'affichage en pixels natifs.

  • isInterlaced

    booléen facultatif

    Chrome 74 et versions ultérieures

    "True" si ce mode est entrelacé, "false" si aucune valeur n'est fournie.

  • 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

    Total

    Chrome 67 et versions ultérieures

    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.

  • largeur

    Total

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

  • widthInNativePixels

    Total

    Largeur du mode d'affichage en pixels natifs.

DisplayProperties

Propriétés

  • boundsOriginX

    number facultatif

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

  • boundsOriginY

    number facultatif

    Si cette valeur 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

    Si cette valeur est définie, le mode d'affichage est mis à jour pour correspondre à cette valeur. Si d'autres paramètres ne sont pas valides, ce paramètre 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

    Si cette valeur est définie, elle met à jour le zoom associé à l'affichage. 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

    booléen facultatif

    Si la valeur est "true", l'écran devient l'écran principal. Aucune opération si la valeur est définie sur "false". Remarque : Si la propriété "display" est définie, elle est considérée comme principale pour toutes les autres propriétés (c'est-à-dire que isUnified peut être défini, mais pas l'origine des limites).

  • isUnified

    booléen facultatif

    Chrome 59 et versions ultérieures

    ChromeOS uniquement. Si cette règle est définie sur "true", le mode d'affichage passe au bureau unifié (pour en savoir plus, consultez enableUnifiedDesktop). Si elle est définie sur "False", le mode Bureau unifié est désactivé. Cette option n'est valable que pour l'écran principal. Si la propriété mirroringSourceId est fournie, les autres propriétés seront ignorées. Cette valeur n'a aucun effet si elle n'est pas fournie.

  • mirroringSourceId

    chaîne facultative

    Obsolète depuis Chrome 68

    Utilisez setMirrorMode.

    ChromeOS uniquement. Si cette option est définie et non vide, la mise en miroir est activée uniquement pour cet écran. Sinon, la duplication est désactivée 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 cette propriété est définie, aucune autre propriété ne peut l'être.

  • surbalayage

    Encarts 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. Il n'est pas possible de modifier le surbalayage sur l'écran interne.

  • rotation

    number facultatif

    Si elle est définie, la rotation de l'écran est mise à jour. Les valeurs légales 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 et versions ultérieures

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

  • availableDisplayZoomFactors

    number[]

    Chrome 67 et versions ultérieures

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

  • limites

    Limites

    Limites logiques de l'écran.

  • displayZoomFactor

    Total

    Chrome 65 et versions ultérieures

    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

    Total

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

  • dpiY

    Total

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

  • edid

    Edid facultatif

    Chrome 67 et versions ultérieures

    REMARQUE : Cette fonctionnalité n'est disponible que pour les applications kiosque ChromeOS et l'interface utilisateur Web.

  • hasTouchSupport

    booléen

    Chrome 57 et versions ultérieures

    La valeur est "true" si un périphérique d'entrée tactile est associé à cet écran.

  • id

    chaîne

    Identifiant unique de l'écran.

  • isEnabled

    booléen

    "True" si cet écran est activé.

  • isPrimary

    booléen

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

  • isUnified

    booléen

    Chrome 59 et versions ultérieures

    Vrai pour tous les écrans en mode Bureau unifié. Consultez la documentation pour enableUnifiedDesktop.

  • mirroringDestinationIds

    chaîne[]

    Chrome 64 et versions ultérieures

    ChromeOS uniquement. Identifiants des écrans sur lesquels l'écran source est mis en miroir. Vide si aucun écran n'est mis en miroir. Cette valeur sera la même pour tous les écrans. Cela 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. Elle sera définie pour tous les écrans (y compris celui qui est mis en miroir).

  • modes

    DisplayMode[]

    Chrome 52 et versions ultérieures

    Liste des modes d'affichage disponibles. Le mode actuel aura isSelected=true. Uniquement disponible sur ChromeOS. Sur les autres plates-formes, il sera défini sur un tableau vide.

  • nom

    chaîne

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

  • surbalayage

    Encarts

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

  • rotation

    Total

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

  • 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 et versions ultérieures

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

    Total

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

GetInfoFlags

Chrome 59 et versions ultérieures

Propriétés

  • singleUnified

    booléen facultatif

    Si la valeur est définie sur "true", une seule DisplayUnitInfo sera renvoyée par getInfo en mode Bureau unifié (voir enableUnifiedDesktop). La valeur par défaut est "false".

Insets

Propriétés

  • en bas

    Total

    Distance de l'axe Y par rapport à la limite inférieure.

  • gauche

    Total

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

  • droite

    Total

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

  • top

    Total

    Distance de l'axe Y par rapport à la limite supérieure.

LayoutPosition

Chrome 53 et versions ultérieures

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

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 de la source par défaut sera mis en miroir sur tous les autres écrans.

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

MirrorModeInfo

Chrome 65 et versions ultérieures

Propriétés

  • mirroringDestinationIds

    string[] facultatif

    Les ID des destinations de duplication s'affichent. Cette valeur n'est valide que pour "mixed".

  • mirroringSourceId

    chaîne facultative

    ID de l'écran source de la duplication. Cette valeur n'est valide que pour "mixed".

  • mode

    MirrorMode

    Mode miroir à définir.

Point

Chrome 57 et versions ultérieures

Propriétés

  • x

    Total

    Coordonnée X du point.

  • y

    Total

    Coordonnée Y du point.

TouchCalibrationPair

Chrome 57 et versions ultérieures

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

Propriétés

  • La première paire de points de contact et d'affichage est requise pour l'étalonnage de l'écran tactile.

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

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

  • Quatrième paire de points de contact et d'affichage requise pour la calibration tactile.

Méthodes

clearTouchCalibration()

Chrome 57 et versions ultérieures 
chrome.system.display.clearTouchCalibration(
  id: string,
): void

Réinitialise l'étalonnage de l'écran tactile et le ramène à son état par défaut en effaçant toutes les données d'étalonnage associées à l'écran.

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

completeCustomTouchCalibration()

Chrome 57 et versions ultérieures 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
): void

Définit les paires de calibrage tactile pour un écran. Ces pairs seraient 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 une autre calibration tactile est déjà en cours, une erreur sera générée.

Paramètres

  • Paires de points utilisées pour calibrer l'écran.

  • limites

    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 et versions ultérieures 
chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
): void

Active/Désactive la fonctionnalité de bureau unifié. Si le mode Bureau est activé pendant la mise en miroir, il ne changera pas tant que la mise en miroir ne sera pas désactivée. Sinon, le mode Bureau passera immédiatement en mode Bureau unifié. REMARQUE : Cette fonctionnalité n'est disponible que pour les applications kiosque ChromeOS et l'interface utilisateur Web.

Paramètres

  • activé

    booléen

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

getDisplayLayout()

Promise Chrome 53 et versions ultérieures 
chrome.system.display.getDisplayLayout(
  callback?: function,
): Promise<DisplayLayout[]>

Demande les informations de mise en page pour tous les écrans. REMARQUE : Cette fonctionnalité n'est disponible que pour les applications kiosque ChromeOS et l'interface utilisateur Web.

Paramètres

  • callback

    function facultatif

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

    (layouts: DisplayLayout[]) => void

Renvoie

  • Promise<DisplayLayout[]>

    Chrome 91 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getInfo()

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

Demande les informations pour tous les écrans connectés.

Paramètres

  • flags

    GetInfoFlags facultatif

    Chrome 59 et versions ultérieures

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

  • callback

    function facultatif

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

    (displayInfo: DisplayUnitInfo[]) => void

Renvoie

  • Promise<DisplayUnitInfo[]>

    Chrome 91 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

overscanCalibrationAdjust()

Chrome 53 et versions ultérieures 
chrome.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
): void

Ajuste les marges de surbalayage actuelles pour un écran. En règle générale, cela devrait déplacer l'affichage le long d'un axe (par exemple, gauche+droite ont la même valeur) ou le mettre à l'échelle le long d'un axe (par exemple, haut+bas ont des valeurs opposées). Chaque appel Adjust est cumulatif avec les appels précédents depuis le début.

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

  • delta

    Encarts

    Montant permettant de modifier les encarts de surbalayage.

overscanCalibrationComplete()

Chrome 53 et versions ultérieures 
chrome.system.display.overscanCalibrationComplete(
  id: string,
): void

Ajustez l'overscan 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 
chrome.system.display.overscanCalibrationReset(
  id: string,
): void

Rétablit les encarts de surbalayage d'un écran sur 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 
chrome.system.display.overscanCalibrationStart(
  id: string,
): void

Démarre la calibration de l'overscan pour un écran. Une superposition s'affiche à l'écran pour indiquer les marges de surbalayage actuelles. Si l'étalonnage du surbalayage pour l'écran id est en cours, il sera réinitialisé.

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

setDisplayLayout()

Promise Chrome 53 et versions ultérieures 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
): Promise<void>

Définissez la mise en page pour tous les écrans. Toute diffusion non incluse utilisera 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é. REMARQUE : Cette fonctionnalité n'est disponible que pour les applications kiosque ChromeOS et l'interface utilisateur Web.

Paramètres

  • mises en page

    DisplayLayout[]

    Informations de mise en page, obligatoires pour tous les écrans, sauf l'écran principal.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 91 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setDisplayProperties()

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

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

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

  • 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 pour elle dans info.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 91 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setMirrorMode()

Promise Chrome 65 et versions ultérieures 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
  callback?: function,
): Promise<void>

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. REMARQUE : Cette fonctionnalité n'est disponible que pour les applications kiosque ChromeOS et l'interface utilisateur Web.

Paramètres

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

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 91 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

showNativeTouchCalibration()

Promise Chrome 57 et versions ultérieures 
chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
): Promise<boolean>

Affiche l'expérience utilisateur native d'étalonnage de l'écran avec id comme ID d'écran. Une superposition s'affiche à l'écran et contient les instructions nécessaires pour continuer. Le rappel ne sera invoqué qu'en cas de calibrage réussi. Si la calibration échoue, une erreur est générée.

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

  • callback

    function facultatif

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

    (success: boolean) => void

    • success

      booléen

Renvoie

  • Promise<boolean>

    Chrome 91 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

startCustomTouchCalibration()

Chrome 57 et versions ultérieures 
chrome.system.display.startCustomTouchCalibration(
  id: string,
): void

Démarre l'étalonnage tactile personnalisé pour un écran. Cette méthode doit être appelée lorsque vous utilisez une UX personnalisée pour collecter des données de calibration. Si une autre calibration 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

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

Déclenché lorsque la configuration de l'affichage est modifiée.

Paramètres

  • callback

    fonction

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

    () => void