chrome.system.display

Descripción

Usa la API de system.display para consultar los metadatos de la pantalla.

Permisos

system.display

Tipos

ActiveState

Chrome 117 y versiones posteriores

Una enumeración para saber si el sistema detecta y usa la pantalla. La pantalla se considera "inactiva" si el sistema no la detecta (quizá está desconectada o se considera desconectada debido al modo de suspensión, etc.). Por ejemplo, se usa para conservar la pantalla existente cuando todas están desconectadas.

Enum

Bounds

Propiedades

  • alto

    número

    Es la altura de la pantalla en píxeles.

  • izquierda

    número

    La coordenada X de la esquina superior izquierda.

  • superior

    número

    La coordenada Y de la esquina superior izquierda.

  • ancho

    número

    Es el ancho de la pantalla en píxeles.

DisplayLayout

Chrome 53 y versiones posteriores

Propiedades

  • id

    cadena

    Es el identificador único de la pantalla.

  • offset

    número

    El desplazamiento de la pantalla a lo largo del borde conectado. 0 indica que las esquinas superior o izquierda están alineadas.

  • parentId

    cadena

    Es el identificador único de la pantalla superior. Está vacío si esta es la raíz.

  • position

    LayoutPosition

    Es la posición de diseño de esta pantalla en relación con el elemento superior. Esto se ignorará para la raíz.

DisplayMode

Chrome 52 y versiones posteriores

Propiedades

  • deviceScaleFactor

    número

    Factor de escala del dispositivo de modo de visualización.

  • alto

    número

    Es la altura del modo de visualización en píxeles independientes del dispositivo (visibles para el usuario).

  • heightInNativePixels

    número

    Es la altura del modo de visualización en píxeles nativos.

  • isInterlaced

    booleano opcional

    Chrome 74 y versiones posteriores

    Es verdadero si este modo está entrelazado y falso si no se proporciona.

  • isNative

    boolean

    Es verdadero si el modo es el modo nativo de la pantalla.

  • isSelected

    boolean

    Es verdadero si el modo de visualización está seleccionado.

  • refreshRate

    número

    Chrome 67 y versiones posteriores

    La frecuencia de actualización del modo de visualización en hercios.

  • uiScale

    número opcional

    Obsoleta a partir de Chrome 70

    Usa displayZoomFactor

    El factor de escala de la IU del modo de visualización.

  • ancho

    número

    Es el ancho del modo de visualización en píxeles independientes del dispositivo (visibles para el usuario).

  • widthInNativePixels

    número

    Es el ancho del modo de visualización en píxeles nativos.

DisplayProperties

Propiedades

  • boundsOriginX

    número opcional

    Si se configura, actualiza el origen de los límites lógicos de la pantalla a lo largo del eje x. Se aplican junto con boundsOriginY. El valor predeterminado es el actual si no está configurado y boundsOriginY está configurado. Ten en cuenta que, cuando actualices el origen de visualización, se aplicarán algunas restricciones, por lo que el origen de los límites final puede ser diferente del que se estableció. Los límites finales se pueden recuperar con getInfo. No se puede cambiar el origen de los límites en la pantalla principal.

  • boundsOriginY

    número opcional

    Si se configura, actualiza el origen de los límites lógicos de la pantalla a lo largo del eje Y. Consulta la documentación sobre el parámetro boundsOriginX.

  • displayMode

    DisplayMode opcional

    Chrome 52 y versiones posteriores

    Si se configura, actualiza el modo de visualización al modo que coincide con este valor. Si otros parámetros no son válidos, no se aplicará. Si el modo de visualización no es válido, no se aplicará y se establecerá un error, pero se seguirán aplicando otras propiedades.

  • displayZoomFactor

    número opcional

    Chrome 65 y versiones posteriores

    Si está configurado, actualiza el zoom asociado con la pantalla. Este zoom permite rediseñar y volver a pintar, lo que da como resultado un zoom de mejor calidad que solo una ampliación de píxeles por estiramiento de píxeles.

  • isPrimary

    booleano opcional

    Si se establece como verdadera, la pantalla será la principal. No-op si se establece como falsa. Nota: Si se configura, la pantalla se considera principal para todas las demás propiedades (es decir, es posible que se configure isUnified y que no lo haga el origen de los límites).

  • isUnified

    booleano opcional

    Chrome 59 y versiones posteriores

    Solo en ChromeOS. Si la estableces como verdadera, cambia el modo de visualización a escritorio unificado (consulta enableUnifiedDesktop para obtener más información). Si se establece como falsa, se inhabilitará el modo de escritorio unificado. Esto solo es válido para la pantalla principal. Si se proporciona, no se debe proporcionarMirrorSourceId y se ignorarán otras propiedades. Esto no tiene efecto si no se proporciona.

  • mirroringSourceId

    cadena opcional

    Obsoleta a partir de Chrome 68

    Usa setMirrorMode.

    Solo en ChromeOS. Si está configurado y no está vacío, habilita la duplicación solo para esta pantalla. De lo contrario, inhabilita la duplicación en todas las pantallas. Este valor debe indicar el ID de la pantalla de origen que se duplicará, que no debe ser igual al ID que se pasó a setDisplayProperties. Si se configura, no se puede establecer ninguna otra propiedad.

  • sobrebarrido

    Inserciones opcionales

    Si está configurado, establece las inserciones de sobrebarrido de la pantalla en los valores proporcionados. Ten en cuenta que es posible que los valores de sobrebarrido no sean negativos ni superen la mitad del tamaño de la pantalla. No se puede cambiar el sobrebarrido en el monitor interno.

  • rotación

    número opcional

    Si está configurada, actualiza la rotación de la pantalla. Los valores legales son [0, 90, 180, 270]. La rotación se establece en el sentido de las manecillas del reloj, en relación con la posición vertical de la pantalla.

DisplayUnitInfo

Propiedades

  • activeState

    ActiveState

    Chrome 117 y versiones posteriores

    Se activa si el sistema detecta y usa la pantalla.

  • availableDisplayZoomFactors

    número

    Chrome 67 y versiones posteriores

    Una lista de los valores del factor de zoom que se pueden establecer para la pantalla.

  • límites

    Límites

    Los límites lógicos de la pantalla

  • displayZoomFactor

    número

    Chrome 65 y versiones posteriores

    Es la proporción entre el zoom actual y el predeterminado de la pantalla. Por ejemplo, el valor 1 equivale a un zoom del 100% y el valor 1.5 equivale a un zoom del 150%.

  • dpiX

    número

    Es la cantidad de píxeles por pulgada a lo largo del eje x.

  • dpiY

    número

    Es la cantidad de píxeles por pulgada a lo largo del eje Y.

  • edid

    Edid opcional

    Chrome 67 y versiones posteriores

    NOTA: Esta opción solo está disponible para la IU web y las aplicaciones de kiosco de ChromeOS.

  • hasTouchSupport

    boolean

    Chrome 57 y versiones posteriores

    Es verdadero si esta pantalla tiene un dispositivo de entrada táctil asociado.

  • id

    cadena

    Es el identificador único de la pantalla.

  • isEnabled

    boolean

    Es verdadero si esta pantalla está habilitada.

  • isPrimary

    boolean

    Es verdadero si esta es la pantalla principal.

  • isUnified

    boolean

    Chrome 59 y versiones posteriores

    Verdadero para todas las pantallas cuando se usa el modo de escritorio unificado. Consulta la documentación de enableUnifiedDesktop.

  • mirroringDestinationIds

    string[]

    Chrome 64 y versiones posteriores

    Solo en ChromeOS. Identificadores de las pantallas en las que se duplica la pantalla de origen Está vacío si no se está duplicando ninguna pantalla. Se establecerá con el mismo valor para todas las pantallas. No debe incluir mirroringSourceId.

  • mirroringSourceId

    cadena

    Solo en ChromeOS. Identificador de la pantalla que se duplica si la duplicación está habilitada; de lo contrario, está vacía. Esto se establecerá para todas las pantallas (incluida la que se está duplicando).

  • modes

    DisplayMode

    Chrome 52 y versiones posteriores

    Es la lista de modos de visualización disponibles. El modo actual tendrá isSelected=true. Solo disponible en ChromeOS. En otras plataformas, se establecerá como un array vacío.

  • name

    cadena

    Es un nombre fácil de usar (p.ej., "monitor LCD de HP").

  • sobrebarrido

    Inserciones

    Las inserciones de la pantalla dentro de los límites de su pantalla. Actualmente, solo se expone en ChromeOS. Se establecerá como inserciones vacías en otras plataformas.

  • rotación

    número

    Es la rotación en el sentido de las manecillas del reloj de la pantalla en grados con relación a la posición vertical. Actualmente, solo se expone en ChromeOS. Se establecerá en 0 en otras plataformas. Un valor de -1 se interpretará como una rotación automática cuando el dispositivo se encuentre en un estado físico de tablet.

  • workArea

    Límites

    El área de trabajo utilizable de la pantalla dentro de los límites de la pantalla. El área de trabajo excluye las áreas de la pantalla reservadas para el SO, como la barra de tareas y el selector.

Edid

Chrome 67 y versiones posteriores

Propiedades

  • manufacturerId

    cadena

    Código fabricante de 3 caracteres Consulta el Artículo 3.4.1, página 21. Obligatorio en la versión 1.4.

  • productId

    cadena

    Código de 2 bytes asignado por el fabricante, Sec. 3.4.2, página 21. Obligatorio en la versión 1.4.

  • yearOfManufacture

    número

    Año del fabricante, sección 3.4.4, página 22. Obligatorio en la versión 1.4.

GetInfoFlags

Chrome 59 y versiones posteriores

Propiedades

  • singleUnified

    booleano opcional

    Si se establece como verdadera, getInfo mostrará un solo elemento DisplayUnitInfo cuando esté en el modo de escritorio unificado (consulta enableUnifiedDesktop). El valor predeterminado es falso.

Insets

Propiedades

  • inferior

    número

    Distancia del eje Y desde el límite inferior.

  • izquierda

    número

    Distancia del eje X respecto del límite izquierdo.

  • derecha

    número

    Distancia del eje X respecto del límite derecho.

  • superior

    número

    Distancia del eje Y desde el límite superior.

LayoutPosition

Chrome 53 y versiones posteriores

Posición del diseño, es decir, borde del elemento superior al que se adjunta la pantalla

Enum

"left"

MirrorMode

Chrome 65 y versiones posteriores

Modo de espejo, es decir, diferentes formas en que una pantalla se duplica en otras

Enum

"off"
Especifica el modo predeterminado (escritorio extendido o unificado).

"normal"
Especifica que la pantalla de origen predeterminada se duplicará en todas las demás pantallas.

"mixed"
Especifica que la pantalla de origen especificada se duplicará en las pantallas de destino proporcionadas. Se extenderán todas las demás pantallas conectadas.

MirrorModeInfo

Chrome 65 y versiones posteriores

Propiedades

  • mirroringDestinationIds

    string[] opcional

    Se muestran los IDs del destino de la duplicación. Solo es válido para "mixtos".

  • mirroringSourceId

    cadena opcional

    Es el ID de la pantalla de origen de la duplicación. Solo es válido para "mixtos".

  • Standard

    MirrorMode

    El modo de espejo que se debe establecer.

Point

Chrome 57 y versiones posteriores

Propiedades

  • x

    número

    La coordenada X del punto.

  • y

    número

    La coordenada Y del punto.

TouchCalibrationPair

Chrome 57 y versiones posteriores

Propiedades

  • displayPoint

    Punto

    Las coordenadas del punto de visualización.

  • touchPoint

    Punto

    Son las coordenadas del punto táctil que corresponde al punto de visualización.

TouchCalibrationPairQuad

Chrome 57 y versiones posteriores

Propiedades

  • Se requiere el primer par de puntos táctiles y de visualización para la calibración táctil.

  • Se requiere un segundo par de puntos táctiles y de pantalla para la calibración táctil.

  • Se requiere un tercer par de puntos táctiles y de visualización para la calibración táctil.

  • Se requiere un cuarto par de puntos táctiles y de pantalla para la calibración táctil.

Métodos

clearTouchCalibration()

Chrome 57 y versiones posteriores 
chrome.system.display.clearTouchCalibration(
  id: string,
)

Restablece la calibración táctil de la pantalla y la restablece a su estado predeterminado borrando los datos de calibración táctil asociados con la pantalla.

Parámetros

  • id

    cadena

    Es el identificador único de la pantalla.

completeCustomTouchCalibration()

Chrome 57 y versiones posteriores 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
)

Establece los pares de calibración táctil de una pantalla. Estos pairs se usarían para calibrar la pantalla táctil de la pantalla con el elemento id llamado en startCustomTouchCalibration(). Siempre debes llamar a startCustomTouchCalibration antes de llamar a este método. Si ya hay otra calibración táctil en curso, se producirá un error.

Parámetros

  • Los pares de puntos que se usan para calibrar la pantalla

  • límites

    Límites

    Límites de la pantalla cuando se realizó la calibración táctil Se ignoran los valores bounds.left y bounds.top.

enableUnifiedDesktop()

Chrome 46 y versiones posteriores 
chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
)

Habilita o inhabilita la función de escritorio unificado. Si se habilita mientras la duplicación está activa, el modo de escritorio no cambiará hasta que se desactive la duplicación. De lo contrario, el modo de escritorio cambiará a unificado de inmediato. NOTA: Esta opción solo está disponible para la IU web y las aplicaciones de kiosco de ChromeOS.

Parámetros

  • habilitado

    boolean

    Es verdadero si se debe habilitar el escritorio unificado.

getDisplayLayout()

Promesa Chrome 53 y versiones posteriores 
chrome.system.display.getDisplayLayout(
  callback?: function,
)

Solicita la información de diseño para todas las pantallas. NOTA: Esta opción solo está disponible para la IU web y las aplicaciones de kiosco de ChromeOS.

Parámetros

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    (layouts: DisplayLayout[])=>void

Devuelve

  • Promise<DisplayLayout[]>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getInfo()

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

Solicita la información para todos los dispositivos de visualización conectados.

Parámetros

  • flags

    GetInfoFlags opcionales

    Chrome 59 y versiones posteriores

    Opciones que afectan cómo se muestra la información.

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    (displayInfo: DisplayUnitInfo[])=>void

Devuelve

  • Promise<DisplayUnitInfo[]>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

overscanCalibrationAdjust()

Chrome 53 y versiones posteriores 
chrome.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
)

Ajusta las inserciones de sobrebarrido actuales para una pantalla. Normalmente, esto debería mover la pantalla a lo largo de un eje (p.ej., izquierda + derecha tienen el mismo valor) o escalarlo a lo largo de un eje (p.ej., arriba + abajo tienen valores opuestos). Cada llamada de Adjust es acumulativa con las llamadas anteriores desde el inicio.

Parámetros

  • id

    cadena

    Es el identificador único de la pantalla.

  • delta

    Inserciones

    El importe para el que se modificarán las inserciones de sobrebarrido.

overscanCalibrationComplete()

Chrome 53 y versiones posteriores 
chrome.system.display.overscanCalibrationComplete(
  id: string,
)

Para completar los ajustes de sobrebarrido de una pantalla, guarda los valores actuales y oculta la superposición.

Parámetros

  • id

    cadena

    Es el identificador único de la pantalla.

overscanCalibrationReset()

Chrome 53 y versiones posteriores 
chrome.system.display.overscanCalibrationReset(
  id: string,
)

Restablece las inserciones de sobrebarrido de una pantalla al último valor guardado (es decir, antes de que se llamara a Start).

Parámetros

  • id

    cadena

    Es el identificador único de la pantalla.

overscanCalibrationStart()

Chrome 53 y versiones posteriores 
chrome.system.display.overscanCalibrationStart(
  id: string,
)

Inicia la calibración de sobrebarrido en una pantalla. Esto mostrará una superposición en la pantalla que indicará las inserciones de sobrebarrido actuales. Si se está realizando la calibración de sobrebarrido en la pantalla id, se restablecerá la calibración.

Parámetros

  • id

    cadena

    Es el identificador único de la pantalla.

setDisplayLayout()

Promesa Chrome 53 y versiones posteriores 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

Establecer el diseño para todas las pantallas. Las pantallas no incluidas usarán el diseño predeterminado. Si un diseño se superpone o no es válido por algún otro motivo, se ajustará a un diseño válido. Una vez que se resuelva el diseño, se activará un evento onDisplayChanged. NOTA: Esta opción solo está disponible para la IU web y las aplicaciones de kiosco de ChromeOS.

Parámetros

  • diseños

    DisplayLayout

    La información de diseño, obligatoria para todas las pantallas, excepto la principal.

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setDisplayProperties()

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

Actualiza las propiedades de la pantalla especificada por id, según la información proporcionada en info. Si se produce un error, se configurará runtime.lastError. NOTA: Esta opción solo está disponible para la IU web y las aplicaciones de kiosco de ChromeOS.

Parámetros

  • id

    cadena

    Es el identificador único de la pantalla.

  • La información sobre las propiedades de visualización que deben cambiarse. Solo se cambiará una propiedad si se especifica un valor nuevo para ella en info.

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setMirrorMode()

Promesa Chrome 65 y versiones posteriores 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
  callback?: function,
)

Establece el modo de visualización en el modo de espejo especificado. Cada llamada restablece el estado de las llamadas anteriores. La llamada a setDisplayProperties() fallará en las pantallas de destino de duplicación. NOTA: Esta opción solo está disponible para la IU web y las aplicaciones de kiosco de ChromeOS.

Parámetros

  • La información del modo de espejo que se debe aplicar al modo de visualización.

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

showNativeTouchCalibration()

Promesa Chrome 57 y versiones posteriores 
chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

Muestra la UX de calibración táctil nativa de la pantalla con id como ID de pantalla. Esto mostrará una superposición en la pantalla con las instrucciones requeridas sobre cómo continuar. Se invocará la devolución de llamada solo en caso de calibración exitosa. Si la calibración falla, se producirá un error.

Parámetros

  • id

    cadena

    Es el identificador único de la pantalla.

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    (success: boolean)=>void

    • correcto

      boolean

Devuelve

  • Promise<boolean>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

startCustomTouchCalibration()

Chrome 57 y versiones posteriores 
chrome.system.display.startCustomTouchCalibration(
  id: string,
)

Inicia la calibración táctil personalizada de una pantalla. Se debe llamar a este método cuando se usa una UX personalizada para recopilar datos de calibración. Si ya hay otra calibración táctil en curso, se producirá un error.

Parámetros

  • id

    cadena

    Es el identificador único de la pantalla.

Eventos

onDisplayChanged

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

Se activa cuando algo cambia en la configuración de la pantalla.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    ()=>void