chrome.system.display

Descripción

Usa la API de system.display para consultar metadatos de visualización.

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 (puede estar desconectada o desconectada debido al modo de suspensión, etcétera). Este estado se usa para mantener la pantalla existente cuando todas están desconectadas, por ejemplo.

Enum

“activo”

“inactivo”

Bounds

Propiedades

  • alto

    número

    Es la altura de la pantalla en píxeles.

  • izquierda

    número

    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

    string

    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 superiores o izquierdas están alineadas.

  • parentId

    string

    Es el identificador único de la pantalla superior. Estará 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

    Es el factor de escala del dispositivo en el modo de visualización.

  • alto

    número

    Indica 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. Es 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 actualmente.

  • refreshRate

    número

    Chrome 67 y versiones posteriores

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

  • uiScale

    número opcional

    Obsoleto desde Chrome 70

    Usa displayZoomFactor

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

  • ancho

    número

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

  • widthInNativePixels

    número

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

DisplayProperties

Propiedades

  • boundsOriginX

    número opcional

    Si está establecido, 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 y si boundsOriginY está configurado, el valor predeterminado es el 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 finales puede ser diferente del conjunto único. Los límites finales se pueden recuperar con getInfo. El origen de los límites no se puede cambiar en la pantalla principal.

  • boundsOriginY

    número opcional

    Si se establece, actualiza el origen de los límites lógicos de la pantalla junto al 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 modo que coincide con este valor. Si otros parámetros no son válidos, no se aplicarán. Si el modo de visualización no es válido, no se aplicará y se generará un error, pero se seguirán aplicando otras propiedades.

  • displayZoomFactor

    número opcional

    Chrome 65 y versiones posteriores

    Si se establece, actualiza el zoom asociado con la pantalla. Este zoom permite rediseñar el diseño y volver a pintar, lo que da como resultado un zoom de mejor calidad que el de un agrandamiento por estiramiento de píxel por píxel.

  • esPrincipal

    booleano opcional

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

  • isUnified

    booleano opcional

    Chrome 59 y versiones posteriores

    Solo para el Sistema operativo Chrome. Si se establece como verdadera, cambia el modo de visualización a escritorio unificado (consulta enableUnifiedDesktop para obtener más información). Si la estableces 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 BigtableSourceId, y se ignorarán otras propiedades. Esto no tiene efecto si no se proporciona.

  • mirroringSourceId

    string opcional

    Obsoleto desde Chrome 68

    Usa setMirrorMode.

    Solo para el Sistema operativo Chrome. Si la estableces y no la estableces, se habilitará 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 pasó a setDisplayProperties. Si se establece, no se puede establecer ninguna otra propiedad.

  • desajuste de dimensiones

    Inserciones opcionales

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

  • rotación

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

    Se activa si el sistema detecta y usa la pantalla.

  • availableDisplayZoomFactors

    número

    Chrome 67 y versiones posteriores

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

  • límites

    Límites

    Los límites lógicos de la pantalla.

  • displayZoomFactor

    número

    Chrome 65 y versiones posteriores

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

  • dpiX

    número

    Número de píxeles por pulgada a lo largo del eje x.

  • dpiY

    número

    Número de píxeles por pulgada en el 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

    boolean

    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

    boolean

    Es verdadero si esta pantalla está habilitada.

  • esPrincipal

    boolean

    Es verdadero si esta es la pantalla principal.

  • isUnified

    boolean

    Chrome 59 y versiones posteriores

    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 el Sistema operativo Chrome. Identificadores de las pantallas en las que se duplica la pantalla de origen. Estará vacío si no se duplican pantallas. Se establecerá con el mismo valor para todas las pantallas. No debe incluir mirroringSourceId.

  • mirroringSourceId

    string

    Solo para el Sistema operativo Chrome. 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 está duplicando).

  • modos

    DisplayMode[]

    Chrome 52 y versiones posteriores

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

  • nombre

    string

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

  • desajuste de dimensiones

    Inserciones

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

  • rotación

    número

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

Edid

Chrome 67 y versiones posteriores

Propiedades

  • manufacturerId

    string

    Es un código del fabricante de 3 caracteres. Consulta el artículo 3.4.1 (página 21). Obligatorio en la versión 1.4.

  • productId

    string

    2 bytes de código 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, sec. 3.4.4 (página 22). Obligatorio en la versión 1.4.

GetInfoFlags

Chrome 59 y versiones posteriores

Propiedades

  • singleUnified

    booleano opcional

    Si la estableces como verdadera, getInfo mostrará un único elemento DisplayUnitInfo en el modo de escritorio unificado (consulta enableUnifiedDesktop). La configuración predeterminada es "false".

Insets

Propiedades

  • inferior

    número

    La distancia del eje Y desde el límite inferior.

  • izquierda

    número

    La distancia del eje X desde el límite izquierdo.

  • derecha

    número

    La distancia del eje X desde el límite derecho.

  • superior

    número

    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 adjuntó la pantalla

Enum

“superior”

“derecha”

“parte inferior”

“izquierda”

MirrorMode

Chrome 65 y versiones posteriores

El modo de espejo, es decir, diferentes formas de cómo se duplica una pantalla en otras pantallas.

Enum

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

"normal"
Especifica que la pantalla fuente 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 'mixtos'.

  • mirroringSourceId

    string opcional

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

  • Standard

    MirrorMode

    El modo de duplicación que debe establecerse.

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

    Las coordenadas del punto táctil correspondiente al punto de visualización.

TouchCalibrationPairQuad

Chrome 57 y versiones posteriores

Propiedades

  • Se requiere el primer par de puntos táctiles y de pantalla 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 punto táctil y de pantalla 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 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 de una pantalla. Estos pairs se usarían para calibrar la pantalla táctil de la pantalla con id llamado 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

  • 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 esta función mientras la función de duplicación está activa, el modo de escritorio no cambiará hasta que se desactive la funció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

    boolean

    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 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 Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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

    Opciones que afectan la manera 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 Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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. 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 + abajo tiene 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

    Cantidad a cambiar las inserciones de sobrebarrido.

overscanCalibrationComplete()

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

Completa los ajustes de sobrebarrido 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,
)

Restablece las inserciones de sobrebarrido 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 sobrebarrido de una pantalla. Esto mostrará una superposición en la pantalla con las inserciones de sobrebarrido actuales. Si la calibración de sobrebarrido 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 de 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. Una vez 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[]

    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

Muestra

  • Promesa<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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. Si se produce un error, se configurará 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

    Información sobre las propiedades de visualización que se debe cambiar. Una propiedad solo se modificará 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

  • Promesa<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 duplicación especificado. Cada llamada restablece el estado de las llamadas anteriores. Las llamadas a setDisplayProperties() fallarán 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

    La información del modo de duplicación que debe aplicarse al modo de visualización.

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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. 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 calibración correcta. Si la calibración falla, se arrojará un mensaje de 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

      boolean

Muestra

  • Promise&lt;boolean&gt;

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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

    string

    Es el identificador único de la pantalla.

Eventos

onDisplayChanged

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

Se activa cuando se modifica la configuración de la pantalla.

Parámetros

  • callback

    función

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

    () => void