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

Es una enumeración que indica si el sistema detecta y usa la pantalla. La pantalla se considera "inactiva" si el sistema no la detecta (quizás 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

    Es la coordenada X de la esquina superior izquierda.

  • superior

    número

    Es 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

    string

    Es el identificador único de la pantalla.

  • offset

    número

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

  • parentId

    string

    Es el identificador único de la pantalla principal. Estará vacío si es la raíz.

  • position

    LayoutPosition

    Posición del diseño de esta pantalla en relación con el elemento principal. Se ignorará para la raíz.

DisplayMode

Chrome 52 y versiones posteriores

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

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

  • 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

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

  • uiScale

    número opcional

    Obsoleto desde Chrome 70

    Usa 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

    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 aplica junto con boundsOriginY. Si no se configura y se establece boundsOriginY, se establece de forma predeterminada en el valor actual. Ten en cuenta que, cuando actualices el origen de la pantalla, se aplicarán algunas restricciones, por lo que el origen de los límites final puede ser diferente del que se configuró. 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 del 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 aplicarán otras propiedades.

  • displayZoomFactor

    número opcional

    Chrome 65 y versiones posteriores

    Si se configura, 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 un estiramiento píxel por píxel.

  • isPrimary

    booleano opcional

    Si se establece como verdadero, la pantalla se convierte en principal. No se realiza ninguna operación si se establece como falso. Nota: Si se configura, la pantalla se considera principal para todas las demás propiedades (es decir, se puede configurar isUnified y es posible que no se configure el origen de los límites).

  • isUnified

    booleano opcional

    Chrome 59 y versiones posteriores

    Solo para ChromeOS. Si se establece como verdadero, cambia el modo de visualización al escritorio unificado (consulta enableUnifiedDesktop para obtener más detalles). Si se establece como falso, 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

    cadena opcional

    Obsoleto desde Chrome 68

    Usa setMirrorMode.

    Solo para ChromeOS. Si se configura y no está vacío, habilita la duplicación solo para esta pantalla. De lo contrario, 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 pasó a setDisplayProperties. Si se establece, no se puede establecer ninguna otra propiedad.

  • Sobrebarrido

    Inserciones opcional

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

  • rotación

    número opcional

    Si se configura, 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

    Está activo si el sistema detecta y usa la pantalla.

  • availableDisplayZoomFactors

    number[]

    Chrome 67 y versiones posteriores

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

  • límites

    Límites

    Son 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 las apps de kiosco de ChromeOS y la IU web.

  • hasTouchSupport

    booleano

    Chrome 57 y versiones posteriores

    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 esta es la pantalla principal.

  • isUnified

    booleano

    Chrome 59 y versiones posteriores

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

  • mirroringDestinationIds

    string[]

    Chrome 64 y versiones posteriores

    Solo para ChromeOS. Son los identificadores de las pantallas en las que se duplica la pantalla de origen. Estará 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. Identificador de la pantalla que se duplica si la duplicación está habilitada; de lo contrario, está vacío. Este parámetro se establecerá para todas las pantallas (incluida la pantalla duplicada).

  • modos

    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. Se establecerá como un array vacío en otras plataformas.

  • nombre

    string

    Es el nombre descriptivo (p.ej., "Monitor LCD HP").

  • Sobrebarrido

    Inserciones

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

  • rotación

    número

    Rotación de la pantalla en sentido de las manecillas del reloj 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 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, por ejemplo, la barra de tareas y el selector.

Edid

Chrome 67 y versiones posteriores

Propiedades

  • manufacturerId

    string

    Es el código del fabricante de 3 caracteres. Consulta la sección 3.4.1, página 21. Se requiere 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. Se requiere en la versión 1.4.

  • yearOfManufacture

    número

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

GetInfoFlags

Chrome 59 y versiones posteriores

Propiedades

  • singleUnified

    booleano opcional

    Si se establece en verdadero, getInfo solo devolverá un solo DisplayUnitInfo cuando esté en 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

Posición del diseño, es decir, el borde del elemento principal al que se une la pantalla.

Enum

"top"

"right"

"bottom"

"left"

MirrorMode

Chrome 65 y versiones posteriores

Modo de duplicación, es decir, diferentes formas en que una pantalla se duplica en otras pantallas.

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

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

  • mirroringSourceId

    cadena opcional

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

  • Standard

    MirrorMode

    Es el modo de duplicación que se debe establecer.

Point

Chrome 57 y versiones posteriores

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

Propiedades

  • displayPoint

    Point

    Son las coordenadas del punto de visualización.

  • touchPoint

    Point

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

TouchCalibrationPairQuad

Chrome 57 y versiones posteriores

Propiedades

  • Primer par de puntos de contacto y visualización necesarios para la calibración táctil.

  • Segundo par de puntos de contacto y visualización necesarios para la calibración táctil.

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

  • Cuarto par de puntos de contacto y visualización necesarios para la calibración táctil.

Métodos

clearTouchCalibration()

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

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

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

completeCustomTouchCalibration()

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

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 arrojará un error.

Parámetros

  • Son 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 de bounds.left y bounds.top.

enableUnifiedDesktop()

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

Habilita o inhabilita la función de escritorio unificado. Si está habilitado 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 las apps de kiosco de ChromeOS y la IU web.

Parámetros

  • habilitado

    booleano

    Es verdadero si se debe habilitar el escritorio unificado.

getDisplayLayout()

Chrome 53 y versiones posteriores 
chrome.system.display.getDisplayLayout(): Promise<DisplayLayout[]>

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

Muestra

getInfo()

chrome.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

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

Muestra

overscanCalibrationAdjust()

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

Ajusta las inserciones de sobreescaneo actuales para 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., la parte superior y la inferior tienen valores opuestos). Cada llamada de Adjust es acumulativa con las llamadas anteriores desde el inicio.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

  • delta

    Inserciones

    Es la cantidad en la que se deben cambiar las inserciones de sobreescaneo.

overscanCalibrationComplete()

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

Completa los ajustes de sobreescaneo 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 
chrome.system.display.overscanCalibrationReset(
  id: string,
): void

Restablece las inserciones de sobreescaneo 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 
chrome.system.display.overscanCalibrationStart(
  id: string,
): void

Inicia la calibración de sobreescaneo para una pantalla. Se mostrará una capa superpuesta en la pantalla que indica las inserciones de sobreescaneo actuales. Si la calibración de sobreescaneo para la pantalla id está en curso, se restablecerá la calibración.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

setDisplayLayout()

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

Establece el diseño para todas las pantallas. Las pantallas que no se incluyan usarán el diseño predeterminado. Si un diseño se superpone o no es válido de alguna otra manera, se ajustará a un diseño válido. Después de que se resuelva el diseño, se activará un evento onDisplayChanged. NOTA: Esta opción solo está disponible para las apps de kiosco de ChromeOS y la IU web.

Parámetros

  • Diseños

    DisplayLayout[]

    Es la información de diseño, que se requiere para todas las pantallas, excepto la principal.

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

setDisplayProperties()

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

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

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

setMirrorMode()

Chrome 65 y versiones posteriores 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
): Promise<void>

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

Parámetros

  • información

    MirrorModeInfo

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

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

showNativeTouchCalibration()

Chrome 57 y versiones posteriores 
chrome.system.display.showNativeTouchCalibration(
  id: string,
): Promise<boolean>

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 falla la calibración, se mostrará un error.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

Muestra

  • Promise<boolean>

    Chrome 91 y versiones posteriores

startCustomTouchCalibration()

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

Inicia la calibración táctil personalizada para 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 arrojará un error.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

Eventos

onDisplayChanged

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

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

Parámetros

  • callback

    función

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

    () => void