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.). Par exemple, cet état permet de conserver l'écran existant lorsque tous les écrans sont déconnectés.

Enum

"active"

Bounds

Propriétés

• taille

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

Propriétés

• id

  chaîne

  Identifiant unique de l'écran.

• offset

  number

  Décalage de l'écran le long des bords connectés. 0 indique que les angles les plus en haut ou les plus à gauche sont alignés.

• parentId

  chaîne

  Identifiant unique de l'écran parent. Ce champ est 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 ou version ultérieure

Propriétés

• deviceScaleFactor

  number

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

• taille

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

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

• isNative

  boolean

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

• isSelected

  boolean

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

• refreshRate

  number

  Chrome 67 et versions ultérieures

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

• uiScale

  numéro facultatif

  Obsolète depuis Chrome 70

  Utiliser "displayZoomFactor"

  Facteur de scaling de l'interface utilisateur 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

  numéro 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. 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. Par conséquent, l'origine des limites finales peut être différente de celle définie. Les limites finales peuvent être récupérées à l'aide de getInfo. Vous ne pouvez pas modifier l'origine des limites sur l'écran principal.

• boundsOriginY

  numéro facultatif

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

• displayMode

  DisplayMode facultatif

  Chrome 52 ou version ultérieure

  Si cette valeur est définie, le mode d'affichage est mis à jour vers le mode correspondant à 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 quand même appliquées.

• displayZoomFactor

  numéro facultatif

  Chrome 65 ou version ultérieure

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

• isPrimary

  Booléen facultatif

  Si cette règle est définie sur "True", l'écran est l'écran principal. No-op si défini sur "false". Remarque: S'il est défini, 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 59 ou version ultérieure

  Chrome OS uniquement. Si cette règle est définie sur "True", le mode d'affichage est défini sur "Bureau unifié" (voir enableUnifiedDesktop pour en savoir plus). Si cette règle est définie sur "False", le mode Bureau unifié est désactivé. Ceci n'est valide que pour l'affichage principal. Si ce champ est fourni, miroirSourceId ne doit pas être spécifié, et les autres propriétés seront ignorées. Cette méthode n'a aucun effet si elle n'est pas fournie.

• mirroringSourceId

  string facultatif

  Obsolète depuis Chrome 68

  Utilisez setMirrorMode.

  Chrome OS uniquement. Si cette valeur est définie et n'est pas vide, la mise en miroir est activée uniquement pour cet écran. Sinon, la mise en miroir 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. S'il est défini, aucune autre propriété ne peut être définie.

• surbalayage

  Encarts facultatifs

  Si cette option 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. Impossible de modifier le surbalayage sur l'écran interne.

• rotation

  numéro facultatif

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

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

• availableDisplayZoomFactors

  nombre[]

  Chrome 67 et versions ultérieures

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

• limites

  Limites

  Limites logiques de l'écran.

• displayZoomFactor

  number

  Chrome 65 ou version ultérieure

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

• dpiX

  number

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

• dpiY

  number

  Nombre de pixels par pouce le long de l'axe des y.

• edid

  Edid facultatif

  Chrome 67 et versions ultérieures

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

• hasTouchSupport

  boolean

  Chrome 57 et versions ultérieures

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

• id

  chaîne

  Identifiant unique de l'écran.

• isEnabled

  boolean

  "True" si cet écran est activé.

• isPrimary

  boolean

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

• isUnified

  boolean

  Chrome 59 ou version ultérieure

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

• mirroringDestinationIds

  chaîne[]

  Chrome 64 ou version ultérieure

  Chrome OS uniquement. Identifiants des écrans sur lesquels l'écran source est mis en miroir. Vide si aucun écran n'est mis en miroir. Il sera défini sur la même valeur 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 mise en miroir est activée (sinon, ce champ est vide). Ce paramètre s'applique à tous les écrans (y compris celui en cours de duplication).

• modes

  DisplayMode

  Chrome 52 ou version ultérieure

  Liste des modes d'affichage disponibles. Le mode actuel indiquera isSelected=true. Disponible uniquement sur Chrome OS. Ce champ sera défini sur un tableau vide sur les autres plates-formes.

• name

  chaîne

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

• surbalayage

  Encarts

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

• 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. Il est défini sur 0 sur les autres plates-formes. La valeur -1 sera interprétée comme une rotation automatique lorsque l'appareil est sous forme de 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 au système d'exploitation, comme la barre des tâches et le lanceur d'applications.

Edid

Chrome 67 et versions ultérieures

Propriétés

• manufacturerId

  chaîne

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

• productId

  chaîne

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

• yearOfManufacture

  number

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

GetInfoFlags

Chrome 59 ou version ultérieure

Propriétés

• singleUnified

  Booléen facultatif

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

Insets

Propriétés

• bas

  number

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

• gauche

  number

  Distance de l'axe X par rapport à la limite 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 et versions ultérieures

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

Enum

"top"

"right"

"bottom"

MirrorMode

Chrome 65 ou version ultérieure

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

Enum

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

"normal"
Indique que l'écran 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 ou version ultérieure

Propriétés

• mirroringDestinationIds

  string[] facultatif

  Les identifiants de la destination de mise en miroir s'affichent. Ceci n'est valide que pour "mixte".

• mirroringSourceId

  string facultatif

  ID de l'écran source mis en miroir. Ceci n'est valide que pour "mixte".

• Standard

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

Propriétés

• pair1

  TouchCalibrationPair

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

• pair2

  TouchCalibrationPair

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

• pair3

  TouchCalibrationPair

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

• pair4

  TouchCalibrationPair

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

Méthodes

clearTouchCalibration()

Chrome 57 et versions ultérieures

chrome.system.display.clearTouchCalibration(
  id: string,
)

Réinitialise le calibrage de l'écran tactile et rétablit les valeurs par défaut en supprimant 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

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

Définit les paires d'étalonnage pour l'écran tactile. Ces pairs permettent de calibrer l'écran tactile pour l'affichage avec une id appelée 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 générée.

Paramètres

• pairs

  TouchCalibrationPairQuad

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

• limites

  Limites

  Limites de l'écran lors de l'étalonnage de l'écran 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 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. Dans le cas contraire, il passe immédiatement en mode unifié. REMARQUE: Cette fonctionnalité n'est disponible que pour les applications kiosque et l'interface utilisateur Web de Chrome OS.

Paramètres

• activé

  boolean

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

getDisplayLayout()

Promesse 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 kiosque et l'interface utilisateur Web de Chrome OS.

Paramètres

• rappel

  fonction facultative

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

  (layouts: DisplayLayout[])=>void

  • mises en page

    DisplayLayout[]

Renvoie

• Promise<DisplayLayout[]>

  Chrome 91 et versions ultérieures

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

getInfo()

Promesse

chrome.system.display.getInfo(
  flags?: GetInfoFlags,
  callback?: function,
)

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

Paramètres

• indicateurs

  GetInfoFlags facultatif

  Chrome 59 ou version ultérieure

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

• rappel

  fonction facultative

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

  (displayInfo: DisplayUnitInfo[])=>void

  • displayInfo

    DisplayUnitInfo[]

Renvoie

• Promise<DisplayUnitInfo[]>

  Chrome 91 et versions ultérieures

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

overscanCalibrationAdjust()

Chrome 53 et versions ultérieures

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

Permet de régler les encarts de surbalayage actuels d'un écran. En règle générale, cela doit déplacer l'écran le long d'un axe (par exemple, gauche+droite ont la même valeur) ou l'ajuster 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

  Valeur utilisée pour modifier les encarts de surbalayage.

overscanCalibrationComplete()

Chrome 53 et versions ultérieures

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

chrome.system.display.overscanCalibrationReset(
  id: string,
)

Réinitialise les encarts de surbalayage d'un écran sur la dernière valeur enregistrée (c'est-à-dire avant l'appel de l'option "Démarrer").

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

overscanCalibrationStart()

Chrome 53 et versions ultérieures

chrome.system.display.overscanCalibrationStart(
  id: string,
)

Démarre le calibrage du surbalayage pour un écran. Une superposition s'affiche alors à l'écran pour vous indiquer les encarts présents en surbalayage. Si le calibrage du surbalayage est en cours pour l'écran id, le calibrage sera réinitialisé.

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

setDisplayLayout()

Promesse Chrome 53 et versions ultérieures

chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

Définissez la mise en page de tous les écrans. Tout écran non inclus utilisera la mise en page par défaut. Si une mise en page se chevauche ou est incorrecte, elle est ajustée pour 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 sur la mise en page, obligatoires pour tous les écrans, à l'exception de l'écran principal.

• rappel

  fonction facultative

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

  ()=>void

Renvoie

• Promise<void>

  Chrome 91 et versions ultérieures

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

setDisplayProperties()

Promesse

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

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

Paramètres

• id

  chaîne

  Identifiant unique de l'écran.

• infos

  DisplayProperties

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

• rappel

  fonction facultative

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

  ()=>void

Renvoie

• Promise<void>

  Chrome 91 et versions ultérieures

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

setMirrorMode()

Promettre 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() pour les affichages de destination de duplication échouera. REMARQUE: Cette fonctionnalité n'est disponible que pour les applications kiosque et l'interface utilisateur Web de Chrome OS.

Paramètres

• infos

  MirrorModeInfo

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

• rappel

  fonction facultative

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

  ()=>void

Renvoie

• Promise<void>

  Chrome 91 et versions ultérieures

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

showNativeTouchCalibration()

Promesse Chrome 57 et versions ultérieures

chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

Affiche l'expérience utilisateur de calibrage pour l'écran tactile natif dont l'ID d'affichage est id. Une superposition s'affichera alors à l'écran, accompagnée des instructions à suivre. 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

  fonction facultative

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

  (success: boolean)=>void

  • success

    boolean

Renvoie

• Promise<boolean>

  Chrome 91 et versions ultérieures

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

startCustomTouchCalibration()

Chrome 57 et versions ultérieures

chrome.system.display.startCustomTouchCalibration(
  id: string,
)

Démarre le calibrage 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 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

• rappel

  function

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

  ()=>void