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 permettant de savoir 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 permet de conserver l'écran existant lorsque tous les écrans sont déconnectés, par exemple.

Énumération

"active"

"inactive"

Bounds

Propriétés

  • hauteur

    number

    Hauteur de l'écran en pixels.

  • gauche

    number

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

  • top

    number

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

  • largeur

    number

    Largeur de l'écran en pixels.

DisplayLayout

Chrome 53 ou version ultérieure

Propriétés

  • id

    chaîne

    Identifiant unique de l'écran.

  • offset

    number

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

DisplayMode

Chrome 52 et versions ultérieures

Propriétés

  • deviceScaleFactor

    number

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

  • hauteur

    number

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

  • heightInNativePixels

    number

    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" si ce n'est pas le cas.

  • 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

    number

    Chrome 67 ou version ultérieure

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

  • uiScale

    number facultatif

    Obsolète depuis Chrome 70

    Utiliser displayZoomFactor

    Facteur d'échelle de l'UI du mode d'affichage.

  • largeur

    number

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

  • widthInNativePixels

    number

    Largeur du mode d'affichage en pixels natifs.

DisplayProperties

Propriétés

  • boundsOriginX

    number facultatif

    Si défini, met à jour l'origine des limites logiques de l'affichage 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 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 défini, met à jour l'origine des limites logiques de l'écran le long de l'axe Y. Consultez la documentation du paramètre boundsOriginX.

  • displayMode

    DisplayMode facultatif

    Chrome 52 et versions ultérieures

    Si défini, définit le mode d'affichage sur celui correspondant à cette valeur. Si d'autres paramètres ne sont pas valides, cette règle ne s'applique pas. Si le mode d'affichage n'est pas valide, il n'est pas appliqué et une erreur est définie, mais les autres propriétés sont toujours appliquées.

  • displayZoomFactor

    number facultatif

    Chrome 65 et versions ultérieures

    Si défini, met à jour le zoom associé à l'écran. Ce zoom effectue une nouvelle mise en page et un nouveau repiquage, ce qui offre un zoom de meilleure qualité qu'un simple agrandissement par étirement pixel par pixel.

  • isPrimary

    booléen facultatif

    Si cette valeur est définie sur "True", l'écran devient l'écran principal. Aucune action n'est effectuée si cette valeur est définie sur "false". Remarque: Si défini, l'affichage est considéré comme principal pour toutes les autres propriétés (c'est-à-dire que isUnified peut être défini et que l'origine des limites ne peut pas l'être).

  • isUnified

    booléen facultatif

    Chrome 59 et versions ultérieures

    ChromeOS uniquement. Si cette valeur est définie sur "True", le mode d'affichage est défini sur "Bureau unifié" (pour en savoir plus, consultez enableUnifiedDesktop). Si cette valeur est définie sur "False", le mode Bureau unifié est désactivé. Cette valeur n'est valide que pour l'écran principal. Si mirroringSourceId est fourni, il ne doit pas être fourni et les autres propriétés seront ignorées. Cette valeur n'a aucun effet si elle n'est pas fournie.

  • mirroringSourceId

    chaîne facultatif

    Obsolète depuis Chrome 68

    Utilisez setMirrorMode.

    ChromeOS uniquement. Si ce paramètre est défini et non vide, la duplication est activée pour cet écran uniquement. 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 valeur est définie, aucune autre propriété ne peut être définie.

  • surbalayage

    Encarts facultatifs

    Si défini, définit les marges de l'affichage en mode surbalayage sur les valeurs fournies. Notez que les valeurs de surdépassement ne doivent pas être négatives ni supérieures à la moitié de la taille de l'écran. Le surbalayage ne peut pas être modifié sur le moniteur interne.

  • rotation

    number facultatif

    Si défini, met à jour la rotation de l'écran. Les valeurs valides 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

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

  • availableDisplayZoomFactors

    number[]

    Chrome 67 ou version ultérieure

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

  • limites

    Limites

    Limites logiques de l'écran.

  • displayZoomFactor

    number

    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

    number

    Nombre de pixels par pouce sur l'axe X.

  • dpiY

    number

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

  • edid

    Edid facultatif

    Chrome 67 ou version ultérieure

    REMARQUE: Cette fonctionnalité n'est disponible que pour les applications ChromeOS en mode Kiosque et l'UI Web.

  • hasTouchSupport

    booléen

    Chrome 57 et versions ultérieures

    "True" si cet écran est associé à un dispositif d'entrée tactile.

  • id

    chaîne

    Identifiant unique de l'écran.

  • isEnabled

    booléen

    "True" si cet écran est activé.

  • isPrimary

    booléen

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

  • isUnified

    booléen

    Chrome 59 et versions ultérieures

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

  • mirroringDestinationIds

    chaîne[]

    Chrome 64 ou version ultérieure

    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 définie sur la même valeur pour tous les écrans. Il ne doit pas inclure mirroringSourceId.

  • mirroringSourceId

    chaîne

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

  • modes

    DisplayMode[]

    Chrome 52 et versions ultérieures

    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 d'autres plates-formes.

  • nom

    chaîne

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

  • surbalayage

    Encarts

    Encastrements de l'écran dans les limites de son écran. Actuellement exposé uniquement sur ChromeOS. Sur les autres plates-formes, il sera défini sur des insets vides.

  • rotation

    number

    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. 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. L'espace de travail exclut les zones de l'écran réservées à l'OS, comme la barre des tâches et le lanceur d'applications.

Edid

Chrome 67 ou version ultérieure

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 attribué par le fabricant de 2 octets, section 3.4.2, page 21. Obligatoire dans la version 1.4.

  • yearOfManufacture

    number

    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 cette valeur est définie sur "true", un seul DisplayUnitInfo est renvoyé par getInfo en mode bureau unifié (voir enableUnifiedDesktop). La valeur par défaut est "false".

Insets

Propriétés

  • en bas

    number

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

  • gauche

    number

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

  • droite

    number

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

  • top

    number

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

LayoutPosition

Chrome 53 ou version ultérieure

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

Énumération

"top"

"right"

"bottom"

"left"

MirrorMode

Chrome 65 et versions ultérieures

Mode miroir, c'est-à-dire différentes façons de dupliquer un écran sur d'autres écrans.

Énumération

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

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

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

MirrorModeInfo

Chrome 65 et versions ultérieures

Propriétés

  • mirroringDestinationIds

    string[] facultatif

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

  • mirroringSourceId

    chaîne facultatif

    ID de l'écran source du miroir. 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

    number

    Coordonnée X du point.

  • y

    number

    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 tactile correspondant au point d'affichage.

TouchCalibrationPairQuad

Chrome 57 et versions ultérieures

Propriétés

  • Première paire de points tactiles et d'affichage requis pour l'étalonnage tactile.

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

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

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

Méthodes

clearTouchCalibration()

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

Réinitialise l'étalonnage tactile de l'écran et le rétablit à son état par défaut en effaçant toutes les données d'étalonnage tactile 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,
)

Définit les paires d'étalonnage tactile pour un écran. Ces pairs permettent de calibrer l'écran tactile pour l'affichage avec id appelé dans startCustomTouchCalibration(). Appelez toujours startCustomTouchCalibration avant d'appeler cette méthode. Si un autre calibrage tactile est déjà en cours, une erreur s'affiche.

Paramètres

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

  • limites

    Limites

    Limites de l'écran au moment de l'étalonnage tactile. Les valeurs bounds.left et bounds.top sont ignorées.

enableUnifiedDesktop()

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

Active/désactive la fonctionnalité de bureau unifié. Si elle est activée lorsque la duplication est active, le mode Bureau ne change pas tant que la duplication n'est pas désactivée. Sinon, le mode Bureau passe immédiatement au mode unifié. REMARQUE: Cette fonctionnalité n'est disponible que pour les applications ChromeOS en mode Kiosque et l'UI 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,
)

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

Paramètres

  • rappel

    fonction facultatif

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

    (layouts: DisplayLayout[]) => void

Renvoie

  • Promise<DisplayLayout[]>

    Chrome 91 ou version ultérieure

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

getInfo()

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

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

  • rappel

    fonction facultatif

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

    (displayInfo: DisplayUnitInfo[]) => void

Renvoie

  • Promise<DisplayUnitInfo[]>

    Chrome 91 ou version ultérieure

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

overscanCalibrationAdjust()

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

Ajuste les marges de surdépassement actuelles pour un écran. En règle générale, cela doit déplacer l'affichage le long d'une axe (par exemple, gauche+droite ont la même valeur) ou le mettre à l'échelle le long d'une 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

    Valeur à modifier pour les marges de surdépassement.

overscanCalibrationComplete()

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

Terminez les ajustements du 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 53 ou version ultérieure 
chrome.system.display.overscanCalibrationReset(
  id: string,
)

Réinitialise les marges 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 ou version ultérieure 
chrome.system.display.overscanCalibrationStart(
  id: string,
)

Démarre l'étalonnage du surbalayage pour un écran. Une superposition s'affiche à l'écran, indiquant les marges de surdépassement actuelles. Si l'étalonnage du surbalayage de l'écran id est en cours, l'étalonnage 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,
)

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 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 ChromeOS en mode Kiosque et l'UI Web.

Paramètres

  • layouts

    DisplayLayout[]

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

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 91 ou version ultérieure

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

setDisplayProperties()

Promesse 
chrome.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
  callback?: function,
)

Met à jour les propriétés de l'affichage spécifié par id, conformément aux informations fournies dans info. En cas d'échec, runtime.lastError est défini. REMARQUE: Cette fonctionnalité n'est disponible que pour les applications ChromeOS en mode Kiosque et l'UI 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 dans info.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 91 ou version ultérieure

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

setMirrorMode()

Promesse Chrome 65 et versions ultérieures 
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() échouera pour les écrans de destination du miroir. REMARQUE: Cette fonctionnalité n'est disponible que pour les applications Kiosque ChromeOS et l'UI Web.

Paramètres

  • Informations du mode miroir à appliquer au mode d'affichage.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 91 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et 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,
)

Affiche l'expérience utilisateur d'étalonnage tactile native pour l'écran avec id comme ID d'écran. Une superposition s'affiche à l'écran avec les instructions requises pour continuer. Le rappel ne sera appelé 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.

  • rappel

    fonction facultatif

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

    (success: boolean) => void

    • success

      booléen

Renvoie

  • Promise<boolean>

    Chrome 91 ou version ultérieure

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

startCustomTouchCalibration()

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

Démarre l'étalonnage 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 calibrage. Si un autre calibrage tactile est déjà en cours, une erreur s'affiche.

Paramètres

  • id

    chaîne

    Identifiant unique de l'écran.

Événements

onDisplayChanged

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

Se déclenche lorsque la configuration de l'écran est modifiée.

Paramètres

  • rappel

    fonction

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

    () => void