chrome.system.display

Description

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

Autorisations

system.display

Types

ActiveState

Chrome 117 ou version ultérieure

É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 peut être déconnecté ou considéré comme déconnecté en raison du mode veille, etc.). Cet état permet de conserver l'écran existant lorsque tous les écrans sont déconnectés, par exemple.

Énumération

"actif"

"inactif"

Bounds

Propriétés

  • hauteur

    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.

  • largeur

    Nombre

    Largeur de l'écran en pixels.

DisplayLayout

Chrome (version 53 ou ultérieure)

Propriétés

  • id

    chaîne

    Identifiant unique de l'affichage.

  • offset

    Nombre

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

  • parentId

    chaîne

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

  • position

    LayoutPosition

    Position de la mise en page de cet écran par rapport au parent. Cette valeur sera ignorée pour la racine.

DisplayMode

Chrome (version 52 ou ultérieure)

Propriétés

  • deviceScaleFactor

    Nombre

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

  • hauteur

    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

    Booléen facultatif

    Chrome 74 ou version ultérieure

    "True" si ce mode est entrelacé, "false" dans le cas contraire.

  • 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 (version 67 ou ultérieure)

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

  • uiScale

    numéro facultatif

    <ph type="x-smartling-placeholder"></ph> Obsolète depuis Chrome 70

    Utiliser displayZoomFactor

    Facteur de scaling de l'interface utilisateur du mode d'affichage.

  • largeur

    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

    numéro facultatif

    Si cette valeur est définie, l'origine des limites logiques de l'écran est mise à jour le long de l'axe des abscisses. 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 lors de la mise à jour de l'origine d'affichage, certaines contraintes sont appliquées. L'origine des limites finale 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

    numéro facultatif

    Si cette valeur est définie, l'origine des limites logiques de l'écran est mise à jour le long de l'axe des ordonnées. Consultez la documentation sur le paramètre boundsOriginX.

  • displayMode

    DisplayMode facultatif

    Chrome (version 52 ou ultérieure)

    Si cette règle est définie, le mode d'affichage est remplacé par celui qui correspond à cette valeur. Si d'autres paramètres ne sont pas valides, il 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 tout de même appliquées.

  • displayZoomFactor

    numéro facultatif

    Chrome (version 65 ou ultérieure)

    Si cette règle est définie, le zoom associé à l'écran est mis à jour. Ce zoom effectue une remise en page et une nouvelle peinture, ce qui se traduit par un zoom de meilleure qualité que le simple agrandissement pixel par pixel.

  • isPrimary

    Booléen facultatif

    Si cette règle est définie sur "true", l'affichage est considéré comme principal. "no-op" si défini sur "false". Remarque: Si cette règle est définie, l'affichage 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

    Booléen facultatif

    Chrome (version 59 ou ultérieure)

    Chrome OS uniquement. Si cette règle est définie sur "True", le mode d'affichage est remplacé par "Bureau unifié" (pour en savoir plus, consultez enableUnifiedDesktop). Si cette règle est définie sur "False", le mode Bureau unifié est désactivé. Cette valeur n'est valide que pour l'écran principal. Si cet ID est fourni, la valeur de mise en miroirSourceId ne doit pas être indiquée, et les autres propriétés sont ignorées. Cette méthode n'a aucun effet si elle n'est pas fournie.

  • mirroringSourceId

    chaîne facultatif

    <ph type="x-smartling-placeholder"></ph> Obsolète depuis Chrome 68

    Utilisez setMirrorMode.

    Chrome OS uniquement. Si cette règle est définie et n'est pas vide, la mise en miroir n'est activée que pour cet affichage. Sinon, la duplication est désactivée pour tous les écrans. Cette valeur doit indiquer l'ID de l'écran source à mettre en miroir, qui ne doit pas être identique à l'ID transmis à setDisplayProperties. Si cette propriété est définie, aucune autre propriété ne peut être définie.

  • surbalayage

    Encarts facultatif

    Si cette règle est définie, les encarts de surbalayage de l'écran sont définis 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. Le surbalayage ne peut pas être modifié sur l'écran interne.

  • rotation

    numéro facultatif

    S'il est défini, il met à jour la rotation de l'écran. 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 ou version ultérieure

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

  • availableDisplayZoomFactors

    numéro[]

    Chrome (version 67 ou ultérieure)

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

  • limites

    Limites

    Limites logiques de l'écran.

  • displayZoomFactor

    Nombre

    Chrome (version 65 ou ultérieure)

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

  • 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 des y.

  • edid

    Edid facultatif

    Chrome (version 67 ou ultérieure)

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

  • hasTouchSupport

    booléen

    Chrome (version 57 ou ultérieure)

    "True" si un appareil de saisie tactile est associé à cet écran.

  • id

    chaîne

    Identifiant unique de l'affichage.

  • 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 (version 59 ou ultérieure)

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

  • mirroringDestinationIds

    chaîne[]

    Chrome (version 64 ou ultérieure)

    Chrome OS uniquement. Identifiants des écrans sur lesquels l'affichage source est mis en miroir. Ce champ est vide si aucun écran n'est dupliqué. La même valeur sera définie pour tous les écrans. Cela ne doit pas inclure mirroringSourceId.

  • mirroringSourceId

    chaîne

    Chrome OS uniquement. Identifiant de l'écran mis en miroir si la duplication est activée, sinon vide. Ce paramètre sera défini pour tous les écrans (y compris l'écran dupliqué).

  • modes

    DisplayMode[]

    Chrome (version 52 ou ultérieure)

    Liste des modes d'affichage disponibles. Le mode actuel indique 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

    Les encarts de l'écran dans les limites de son écran. Actuellement disponible 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 disponible uniquement sur ChromeOS. Sera défini sur 0 sur les autres plates-formes. La valeur -1 correspond à une rotation automatique lorsque l'appareil est dans un état de tablette physique.

  • workArea

    Limites

    Zone de travail utilisable de l'écran dans les limites de l'écran. La zone de travail n'inclut pas les zones de l'écran qui sont réservées au système d'exploitation, comme la barre des tâches et le lanceur d'applications.

Edid

Chrome (version 67 ou ultérieure)

Propriétés

  • manufacturerId

    chaîne

    Code fabricant à 3 caractères. Voir s. 3.4.1 page 21. Obligatoire dans la version 1.4.

  • productId

    chaîne

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

  • yearOfManufacture

    Nombre

    Année du fabricant, secondes 3.4.4 page 22. Obligatoire dans la version 1.4.

GetInfoFlags

Chrome (version 59 ou ultérieure)

Propriétés

  • singleUnified

    Booléen facultatif

    Si cette règle est définie sur "true", getInfo ne renvoie qu'un seul élément DisplayUnitInfo en mode bureau unifié (voir enableUnifiedDesktop). La valeur par défaut est "false".

Insets

Propriétés

  • en bas

    Nombre

    Distance sur l'axe Y à partir de la limite inférieure.

  • gauche

    Nombre

    Distance sur l'axe des abscisses à partir de la limite de gauche.

  • droite

    Nombre

    Distance sur l'axe des abscisses à partir de la limite de droite.

  • top

    Nombre

    Distance sur l'axe Y à partir de la limite supérieure.

LayoutPosition

Chrome (version 53 ou ultérieure)

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

Énumération

"top"

"droite"

"bas"

"gauche"

MirrorMode

Chrome (version 65 ou ultérieure)

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 (ordinateur étendu ou unifié).

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

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

MirrorModeInfo

Chrome (version 65 ou ultérieure)

Propriétés

  • mirroringDestinationIds

    string[] facultatif

    Les ID de la destination de mise en miroir s'affichent. Cet attribut n'est valide que pour la catégorie "mixte".

  • mirroringSourceId

    chaîne facultatif

    ID de l'affichage de la source de mise en miroir. Cet attribut n'est valide que pour la catégorie "mixte".

  • mode

    MirrorMode

    Mode miroir à définir.

Point

Chrome (version 57 ou ultérieure)

Propriétés

  • x

    Nombre

    Coordonnée X du point.

  • y

    Nombre

    Coordonnée Y du point.

TouchCalibrationPair

Chrome (version 57 ou ultérieure)

Propriétés

  • displayPoint

    Point d'accès

    Coordonnées du point d'affichage

  • touchPoint

    Point d'accès

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

TouchCalibrationPairQuad

Chrome (version 57 ou ultérieure)

Propriétés

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

  • Une deuxième paire de points tactiles et un point d'affichage sont requis pour l'étalonnage de l'écran tactile.

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

  • Une quatrième paire de points tactiles et d'affichage est requise pour l'étalonnage de l'écran tactile.

Méthodes

clearTouchCalibration()

Chrome (version 57 ou ultérieure) 
chrome.system.display.clearTouchCalibration(
  id: string,
)

Réinitialise le calibrage de l'écran tactile et revient à 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 (version 57 ou ultérieure) 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
)

Définit les paires d'étalonnage de l'écran tactile pour un écran. Ces pairs serviront à 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 de l'écran tactile est déjà en cours, une erreur est renvoyée.

Paramètres

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

  • limites

    Limites

    Les limites de l'écran lors de l'étalonnage de l'écran tactile. Les valeurs bounds.left et bounds.top sont ignorées.

enableUnifiedDesktop()

Chrome (version 46 ou ultérieure) 
chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
)

Active/Désactive la fonctionnalité de bureau unifié. Si cette option est activée alors que la duplication est active, le mode bureau ne change pas tant que la duplication n'est pas désactivée. Sinon, le mode Bureau passera immédiatement à "unifié". REMARQUE: Cette fonctionnalité n'est disponible que pour les applications kiosque et l'interface utilisateur Web de Chrome OS.

Paramètres

  • activé

    booléen

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

getDisplayLayout()

<ph type="x-smartling-placeholder"></ph> Promesse Chrome (version 53 ou ultérieure) 
chrome.system.display.getDisplayLayout(
  callback?: function,
)

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

Paramètres

  • rappel

    function facultatif

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

    (layouts: DisplayLayout[]) => void

Renvoie

  • Promise&lt;DisplayLayout[]&gt;

    Chrome 91 ou version ultérieure

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

getInfo()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.system.display.getInfo(
  flags?: GetInfoFlags,
  callback?: function,
)

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

Paramètres

  • flags

    GetInfoFlags facultatif

    Chrome (version 59 ou ultérieure)

    Options affectant la manière dont les informations sont renvoyées.

  • rappel

    function facultatif

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

    (displayInfo: DisplayUnitInfo[]) => void

Renvoie

  • Promise&lt;DisplayUnitInfo[]&gt;

    Chrome 91 ou version ultérieure

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

overscanCalibrationAdjust()

Chrome (version 53 ou ultérieure) 
chrome.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
)

Permet d'ajuster les encarts de surbalayage actuels pour un écran. Généralement, cela doit déplacer l'écran 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 + 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

    Quantité de modification des encarts de surbalayage.

overscanCalibrationComplete()

Chrome (version 53 ou ultérieure) 
chrome.system.display.overscanCalibrationComplete(
  id: string,
)

Effectuez les ajustements de surbalayage pour un écran en enregistrant les valeurs actuelles et en masquant la superposition.

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

overscanCalibrationReset()

Chrome (version 53 ou ultérieure) 
chrome.system.display.overscanCalibrationReset(
  id: string,
)

Réinitialise les encarts de surbalayage d'un affichage sur la dernière valeur enregistrée (c'est-à-dire avant l'appel de la fonction Start).

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

overscanCalibrationStart()

Chrome (version 53 ou ultérieure) 
chrome.system.display.overscanCalibrationStart(
  id: string,
)

Démarre le calibrage du surbalayage pour un écran. Une superposition s'affiche à l'écran, indiquant les encarts de surbalayage actuels. Si le calibrage du surbalayage pour l'écran id est en cours, le calibrage sera réinitialisé.

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

setDisplayLayout()

<ph type="x-smartling-placeholder"></ph> Promesse Chrome (version 53 ou ultérieure) 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

Définissez la mise en page pour tous les écrans. Tout écran non inclus utilisera la mise en page par défaut. Si une mise en page se chevauche ou n'est pas valide, elle est ajustée selon une mise en page 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 et l'interface utilisateur Web de Chrome OS.

Paramètres

  • mises en page

    DisplayLayout[]

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

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 91 ou version ultérieure

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

setDisplayProperties()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
  callback?: function,
)

Met à jour les propriétés de l'affichage spécifiés 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 et l'interface utilisateur Web de Chrome OS.

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 dans info.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 91 ou version ultérieure

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

setMirrorMode()

<ph type="x-smartling-placeholder"></ph> Promesse Chrome (version 65 ou ultérieure) 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
  callback?: function,
)

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() échoue pour les écrans de destination de mise en miroir. REMARQUE: Cette fonctionnalité n'est disponible que pour les applications kiosque et l'interface utilisateur Web de Chrome OS.

Paramètres

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

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 91 ou version ultérieure

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

showNativeTouchCalibration()

<ph type="x-smartling-placeholder"></ph> Promesse Chrome (version 57 ou ultérieure) 
chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

Affiche l'expérience utilisateur d'étalonnage de l'écran tactile natif avec id comme ID d'écran. Une superposition s'affiche avec les instructions requises sur la manière de procéder. Le rappel ne sera invoqué qu'en cas de calibrage réussi. Si le calibrage échoue, une erreur est générée.

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

  • rappel

    function facultatif

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

    (success: boolean) => void

    • success

      booléen

Renvoie

  • Promise&lt;boolean&gt;

    Chrome 91 ou version ultérieure

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

startCustomTouchCalibration()

Chrome (version 57 ou ultérieure) 
chrome.system.display.startCustomTouchCalibration(
  id: string,
)

Démarre l'étalonnage de l'écran tactile personnalisé pour un écran. Cette méthode doit être appelée lorsque vous utilisez une expérience utilisateur personnalisée pour collecter des données de calibration. Si un autre étalonnage de l'écran tactile est déjà en cours, une erreur est renvoyé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

  • rappel

    fonction

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

    () => void