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 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étera). Este estado se usa para mantener la pantalla existente cuando todas las pantallas están desconectadas, 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. 0 indica que las esquinas superior o izquierda 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 del 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

    Es el factor de escala del dispositivo del 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

    Dejaron de estar disponibles desde Chrome 70

    Usa displayZoomFactor

    Es el factor de escala de la IU del modo de pantalla.

  • ancho

    número

    Es el ancho del modo de pantalla 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 establece, 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 establece, se establece de forma predeterminada en el valor actual 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

    número 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

    Si se establece, actualiza el modo de visualización al 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 establece, actualiza el zoom asociado con la pantalla. Este zoom vuelve a aplicar el diseño y vuelve a pintar, lo que genera un zoom de mejor calidad que solo realizar un aumento de estiramiento píxel por píxel.

  • isPrimary

    booleano opcional

    Si se establece como verdadero, hace que la pantalla sea principal. No realizará ninguna acción si se establece como falso. Nota: Si se establece, la pantalla se considera principal para todas las demás propiedades (es decir, es posible que se establezca isUnified y que no se establezca 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 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 proporcionar mirroringSourceId y se ignorarán otras propiedades. Esto no tiene efecto si no se proporciona.

  • mirroringSourceId

    cadena opcional

    Se dejó de usar 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, 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 opcionales

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

  • rotación

    número opcional

    Si se establece, actualiza la rotación de la pantalla. Los valores válidos 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

    Es activo si el sistema detecta y usa la pantalla.

  • availableDisplayZoomFactors

    number[]

    Chrome 67 y versiones posteriores

    Es una lista de valores de factor de zoom que se pueden configurar 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 predeterminado de la pantalla. Por ejemplo, el valor 1 equivale al zoom del 100% y el valor 1.5 equivale al 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 funció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 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 a las que se duplica la pantalla de origen. Está vacío si no se duplican pantallas. Se establecerá el mismo valor para todas las pantallas. No debe incluir mirroringSourceId.

  • mirroringSourceId

    string

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

  • modos

    DisplayMode[]

    Chrome 52 y versiones posteriores

    Es la lista de los modos de visualización disponibles. El modo actual tendrá isSelected=true. Solo está 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 las inserciones de la pantalla dentro de los límites de la pantalla. Actualmente, solo se expone en ChromeOS. Se establecerá en inserciones vacías en otras plataformas.

  • rotación

    número

    Es la rotación de la pantalla en el 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 giro automático cuando el dispositivo esté en un estado de tablet físico.

  • 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, como la barra de tareas y el selector.

Edid

Chrome 67 y versiones posteriores

Propiedades

  • manufacturerId

    string

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

  • productId

    string

    Código asignado por el fabricante de 2 bytes, 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

Propiedades

  • singleUnified

    booleano opcional

    Si se establece como verdadero, getInfo solo mostrará un DisplayUnitInfo en el modo de escritorio unificado (consulta enableUnifiedDesktop). El valor predeterminado es "false".

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 superior al que se adjunta la pantalla.

Enum

"top"

"right"

"bottom"

"left"

MirrorMode

Chrome 65 y versiones posteriores

Modo espejo, es decir, las diferentes formas en que una pantalla se refleja 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 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 espejo 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

    Punto

    Las coordenadas del punto de visualización.

  • touchPoint

    Punto

    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 pantalla necesarios para la calibración táctil.

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

  • Tercer par de puntos táctiles y de pantalla necesarios para la calibración táctil.

  • Cuarto par de puntos de contacto y pantalla necesarios 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 vuelve a su estado predeterminado borrando 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 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
)

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 mostrará 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. Los valores bounds.left y bounds.top se ignoran.

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 apague la duplicación. De lo contrario, el modo de escritorio cambiará a unificado de inmediato. NOTA: Esta funció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()

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

Parámetros

  • callback

    función opcional

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

    (layouts: DisplayLayout[]) => void

Muestra

  • Promise<DisplayLayout[]>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la 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 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 muestra la información.

  • callback

    función opcional

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

    (displayInfo: DisplayUnitInfo[]) => void

Muestra

  • Promise<DisplayUnitInfo[]>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la 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 los recuadros de sobreescalado actuales de una pantalla. Por lo general, esto debe mover la pantalla a lo largo de un eje (p.ej., izquierda + derecha tienen el mismo valor) o escalarla a lo largo de un eje (p.ej., arriba + abajo tienen valores opuestos). Cada llamada a Adjust es acumulativa con las llamadas anteriores desde el inicio.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

  • delta

    Inserciones

    Es el importe para cambiar los recortes de sobreajuste.

overscanCalibrationComplete()

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

Para completar los ajustes de sobreescalado de una pantalla, guarda los valores actuales y oculta 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,
)

Restablece los recortes de sobreajuste 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,
)

Inicia la calibración de sobreescalado para una pantalla. Se mostrará una superposición en la pantalla que indicará los recortes de sobreescalado actuales. Si la calibración de sobreajuste de la pantalla id está en curso, se restablecerá la calibración.

Parámetros

  • id

    string

    Es el identificador único de la pantalla.

setDisplayLayout()

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

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

Parámetros

  • layouts

    DisplayLayout[]

    Es la información del 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

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la 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 que especifica id, según la información proporcionada en info. En caso de error, se establecerá runtime.lastError. NOTA: Esta funció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 cambiará 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

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la 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 espejo especificado. Cada llamada restablece el estado de las llamadas anteriores. La llamada a setDisplayProperties() fallará en las pantallas de destino del reflejo. NOTA: Esta funció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.

  • callback

    función opcional

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

    () => void

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la 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 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 solo se invocará en caso de que la calibración se realice correctamente. Si la calibración falla, se mostrará un error.

Parámetros

  • id

    string

    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

      booleano

Muestra

  • Promesa<booleano>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la 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 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 mostrará 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