browser.system.display

Descripción

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

Permisos

system.display

Tipos

ActiveState

Chrome 117 y versiones posteriores browser.* desde Chrome 148

Es una enumeración para indicar si el sistema detecta y usa la pantalla. La pantalla se considera "inactiva" si el sistema no la detecta (tal vez esté desconectada o se considere desconectada debido al modo de suspensión, etc.). Este estado se usa para mantener la pantalla existente cuando se desconectan todas las pantallas, por ejemplo.

Enum

"active"

"inactive"

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 browser.* desde Chrome 148

Propiedades

  • id

    string

    Es el identificador único de la pantalla.

  • offset

    número

    Es el desplazamiento de la pantalla a lo largo del borde conectado. El valor 0 indica que las esquinas superiores o izquierdas están alineadas.

  • parentId

    string

    Es el identificador único de la pantalla superior. Está vacío si 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 browser.* desde Chrome 148

Propiedades

  • deviceScaleFactor

    número

    Es el factor de escala del dispositivo en el 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 browser.* desde Chrome 148

    Es verdadero si este modo está entrelazado; de lo contrario, es falso.

  • isNative

    booleano

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

  • isSelected

    booleano

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

  • refreshRate

    número

    Chrome 67 y versiones posteriores browser.* desde Chrome 148

    Es la frecuencia de actualización del modo de visualización en hercios.

  • uiScale

    number opcional

    Obsoleto desde Chrome 70

    Usar displayZoomFactor

    Es 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

    number opcional

    Si se establece, actualiza el origen de los límites lógicos de la pantalla a lo largo del eje X. Se aplica junto con boundsOriginY. Se establece de forma predeterminada en el valor actual si no se configura y se establece boundsOriginY. Ten en cuenta que, cuando se actualice el origen de la visualización, se aplicarán algunas restricciones, por lo que el origen de los límites finales puede ser diferente del establecido. Los límites finales se pueden recuperar con getInfo. No se puede cambiar el origen de los límites en la pantalla principal.

  • boundsOriginY

    number opcional

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

  • displayMode

    DisplayMode opcional

    Chrome 52 y versiones posteriores browser.* desde Chrome 148

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

  • displayZoomFactor

    number opcional

    Chrome 65 y versiones posteriores browser.* desde Chrome 148

    Si se establece, actualiza el zoom asociado con la pantalla. Este zoom vuelve a diseñar y pintar, lo que genera un zoom de mejor calidad que si solo se realizara una ampliación de estiramiento píxel por píxel.

  • isPrimary

    booleano opcional

    Si se establece como verdadero, la pantalla se convierte en la principal. No-op si se establece como falso. Nota: Si se establece, la pantalla se considera principal para todas las demás propiedades (es decir, se puede establecer isUnified y es posible que no se establezca el origen de los límites).

  • isUnified

    booleano opcional

    Chrome 59 y versiones posteriores browser.* desde Chrome 148

    Solo para ChromeOS. Si se establece como verdadera, cambia el modo de visualización a escritorio unificado (consulta enableUnifiedDesktop para obtener más detalles). 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 proporcionar mirroringSourceId y se ignorarán otras propiedades. No tiene efecto si no se proporciona.

  • mirroringSourceId

    string opcional

    Obsoleto desde Chrome 68

    Usa setMirrorMode.

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

  • sobrebarrido

    Inserciones opcional

    Si se establece, se configuran las inserciones de sobreexploración de la pantalla con los valores proporcionados. Ten en cuenta que los valores de sobreexploración no pueden ser negativos ni mayores que la mitad del tamaño de la pantalla. No se puede cambiar el sobrebarrido en el monitor interno.

  • rotación

    number opcional

    Si se establece, 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 browser.* desde Chrome 148

    Activa si el sistema detecta y usa la pantalla.

  • availableDisplayZoomFactors

    number[]

    Chrome 67 y versiones posteriores browser.* desde Chrome 148

    Es una lista de valores de factor de zoom que se pueden establecer para la pantalla.

  • bounds

    Límites

    Son los límites lógicos de la pantalla.

  • displayZoomFactor

    número

    Chrome 65 y versiones posteriores browser.* desde Chrome 148

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

  • dpiX

    número

    Es la cantidad de píxeles por pulgada en el eje X.

  • dpiY

    número

    Es la cantidad de píxeles por pulgada en el eje Y.

  • edid

    Edid opcional

    Chrome 67 y versiones posteriores browser.* desde Chrome 148

    NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS.

  • hasTouchSupport

    booleano

    Chrome 57 y versiones posteriores browser.* desde Chrome 148

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

  • id

    string

    Es el identificador único de la pantalla.

  • isEnabled

    booleano

    Es verdadero si esta pantalla está habilitada.

  • isPrimary

    booleano

    Es verdadero si se trata de la pantalla principal.

  • isUnified

    booleano

    Chrome 59 y versiones posteriores browser.* desde Chrome 148

    Es verdadero para todas las pantallas cuando están en el modo de escritorio unificado. Consulta la documentación de enableUnifiedDesktop.

  • mirroringDestinationIds

    string[]

    Chrome 64 y versiones posteriores browser.* desde Chrome 148

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

  • mirroringSourceId

    string

    Solo para ChromeOS. Es el identificador de la pantalla que se está duplicando si la duplicación está habilitada; de lo contrario, está vacío. Esto se establecerá para todas las pantallas (incluida la que se está duplicando).

  • modos

    DisplayMode[]

    Chrome 52 y versiones posteriores browser.* desde Chrome 148

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

  • nombre

    string

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

  • sobrebarrido

    Inserciones

    Son los márgenes de la pantalla dentro de sus límites. Actualmente, solo se expone en ChromeOS. Se establecerá en 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 en relación con la posición vertical. Actualmente, solo se expone en ChromeOS. Se establecerá en 0 en otras plataformas. Un valor de -1 se interpretará como rotación automática cuando el dispositivo esté en estado físico de tablet.

  • workArea

    Límites

    Es el área de trabajo útil 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, por ejemplo, la barra de tareas y el selector.

Edid

Chrome 67 y versiones posteriores browser.* desde Chrome 148

Propiedades

  • manufacturerId

    string

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

  • productId

    string

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

  • yearOfManufacture

    número

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

GetInfoFlags

Chrome 59 y versiones posteriores browser.* desde Chrome 148

Propiedades

  • singleUnified

    booleano opcional

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

Insets

Propiedades

  • inferior

    número

    Es la distancia del eje Y desde el límite inferior.

  • izquierda

    número

    Es la distancia del eje X desde el límite izquierdo.

  • derecha

    número

    Es la distancia del eje X desde el límite derecho.

  • superior

    número

    Es la distancia del eje Y desde el límite superior.

LayoutPosition

Chrome 53 y versiones posteriores browser.* desde Chrome 148

Es la posición del diseño, es decir, el borde del elemento superior al que se adjunta la pantalla.

Enum

"top"

"right"

"bottom"

"left"

MirrorMode

Chrome 65 y versiones posteriores browser.* desde Chrome 148

Modo de espejo, es decir, diferentes formas de duplicar una pantalla 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. Todas las demás pantallas conectadas se extenderán.

MirrorModeInfo

Chrome 65 y versiones posteriores browser.* desde Chrome 148

Propiedades

  • mirroringDestinationIds

    string[] opcional

    Son los IDs de las pantallas de destino de duplicación. Esto solo es válido para "mixed".

  • mirroringSourceId

    string opcional

    Es el ID de la pantalla de origen de duplicación. Esto solo es válido para "mixed".

  • Standard

    MirrorMode

    Es el modo de espejo que se debe establecer.

Point

Chrome 57 y versiones posteriores browser.* desde Chrome 148

Propiedades

  • x

    número

    Es la coordenada X del punto.

  • y

    número

    Es la coordenada Y del punto.

TouchCalibrationPair

Chrome 57 y versiones posteriores browser.* desde Chrome 148

Propiedades

  • displayPoint

    Punto

    Son las coordenadas del punto de visualización.

  • touchPoint

    Punto

    Son las coordenadas del punto de contacto correspondiente al punto de visualización.

TouchCalibrationPairQuad

Chrome 57 y versiones posteriores browser.* desde Chrome 148

Propiedades

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

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

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

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

Métodos

clearTouchCalibration()

Chrome 57 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.clearTouchCalibration(
  id: string,
): void

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Restablece la calibración táctil de la pantalla y la devuelve a su estado predeterminado borrando todos los datos de calibración táctil asociados con la pantalla.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

completeCustomTouchCalibration()

Chrome 57 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
): void

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Establece los pares de calibración táctil para una pantalla. Estos pairs se usarían para calibrar la pantalla táctil para la pantalla con id llamado en startCustomTouchCalibration(). Siempre llama 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

  • Son los pares de puntos que se usan para calibrar la pantalla.

  • bounds

    Límites

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

enableUnifiedDesktop()

Chrome 46 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.enableUnifiedDesktop(
  enabled: boolean,
): void

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. 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.

Parámetros

  • habilitado

    booleano

    Es verdadero si se debe habilitar el escritorio unificado.

getDisplayLayout()

Chrome 53 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.getDisplayLayout(): Promise<DisplayLayout[]>

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

Muestra

  • Promise<DisplayLayout[]>

    Chrome 91 y versiones posteriores browser.* desde Chrome 148

    Es una promesa que se resuelve con los resultados.

getInfo()

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

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

Parámetros

  • flags

    GetInfoFlags opcional

    Chrome 59 y versiones posteriores browser.* desde Chrome 148

    Son opciones que afectan la forma en que se devuelve la información.

Muestra

  • Promise<DisplayUnitInfo[]>

    Chrome 91 y versiones posteriores browser.* desde Chrome 148

    Es una promesa que se resuelve con los resultados.

overscanCalibrationAdjust()

Chrome 53 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
): void

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Ajusta los márgenes de sobreexploración actuales de una pantalla. Por lo general, esto debería mover la pantalla a lo largo de un eje (p.ej., izquierda y derecha tienen el mismo valor) o escalarla a lo largo de un eje (p.ej., arriba y abajo tienen valores opuestos). Cada llamada a Adjust es acumulativa con las llamadas anteriores desde Start.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

  • delta

    Inserciones

    Es la cantidad para cambiar las inserciones de sobreexploración.

overscanCalibrationComplete()

Chrome 53 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.overscanCalibrationComplete(
  id: string,
): void

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Completa los ajustes de sobreexploración de una pantalla guardando los valores actuales y ocultando la superposición.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

overscanCalibrationReset()

Chrome 53 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.overscanCalibrationReset(
  id: string,
): void

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Restablece los márgenes de sobreexploración de una pantalla al último valor guardado (es decir, antes de que se llamara a Start).

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

overscanCalibrationStart()

Chrome 53 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.overscanCalibrationStart(
  id: string,
): void

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Inicia la calibración de sobreexploración para una pantalla. Esto mostrará una superposición en la pantalla que indica las inserciones de sobreexploración actuales. Si la calibración de sobreexploración de la pantalla id está en curso, se restablecerá.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

setDisplayLayout()

Chrome 53 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
): Promise<void>

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Establece el diseño para todas las pantallas. Cualquier pantalla que no se incluya usará el diseño predeterminado. Si un diseño se superpone o no es válido, se ajustará a un diseño válido. Después de que se resuelva el diseño, se activará un evento onDisplayChanged.

Parámetros

  • diseños

    DisplayLayout[]

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

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores browser.* desde Chrome 148

    Es la promesa que se resuelve cuando finaliza la función.

setDisplayProperties()

browser.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
): Promise<void>

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

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

  • información

    DisplayProperties

    Es la información sobre las propiedades de visualización que se deben cambiar. Una propiedad solo se cambiará si se especifica un valor nuevo para ella en info.

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores browser.* desde Chrome 148

    Es la promesa que se resuelve cuando finaliza la función.

setMirrorMode()

Chrome 65 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.setMirrorMode(
  info: MirrorModeInfo,
): Promise<void>

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. 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á para las pantallas de destino de duplicación.

Parámetros

  • información

    MirrorModeInfo

    Es la información del modo de espejo que se debe aplicar al modo de visualización.

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores browser.* desde Chrome 148

    Es la promesa que se resuelve cuando finaliza la función.

showNativeTouchCalibration()

Chrome 57 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.showNativeTouchCalibration(
  id: string,
): Promise<boolean>

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Muestra la UX de calibración táctil nativa para la pantalla con id como ID de pantalla. Se mostrará una superposición en la pantalla con las instrucciones necesarias para continuar. La devolución de llamada se invocará solo en caso de que la calibración se realice correctamente. Si la calibración falla, se arrojará un error.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

Muestra

  • Promise<boolean>

    Chrome 91 y versiones posteriores browser.* desde Chrome 148

    Es una promesa que se resuelve para informar al emisor que finalizó la calibración táctil. El valor booleano informa si la calibración se realizó correctamente o no.

startCustomTouchCalibration()

Chrome 57 y versiones posteriores browser.* desde Chrome 148 
browser.system.display.startCustomTouchCalibration(
  id: string,
): void

NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS. Inicia la calibración táctil personalizada de una pantalla. Se debe llamar a esta función 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

    string

    Es el identificador único de la pantalla.

Eventos

onDisplayChanged

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

Se activa cuando cambia cualquier aspecto de la configuración de la pantalla.

Parámetros

  • callback

    función

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

    () => void