browser.system.display

Descrição

Use a API system.display para consultar os metadados de exibição.

Permissões

system.display

Tipos

ActiveState

Chrome 117+ browser.* desde o Chrome 148

Um tipo enumerado para informar se a tela foi detectada e usada pelo sistema. A tela é considerada "inativa" se não for detectada pelo sistema (por exemplo, se estiver desconectada ou considerada desconectada devido ao modo de espera etc.). Esse estado é usado para manter a tela atual quando todas as telas são desconectadas, por exemplo.

Enumeração

"active"

"inactive"

Bounds

Propriedades

• altura

  número

  A altura da tela em pixels.

• esquerda

  número

  A coordenada x do canto superior esquerdo.

• superior

  número

  A coordenada y do canto superior esquerdo.

• largura

  número

  A largura da tela em pixels.

DisplayLayout

Chrome 53+ browser.* desde o Chrome 148

Propriedades

• ID

  string

  O identificador exclusivo da tela.

• offset

  número

  O deslocamento da tela ao longo da borda conectada. 0 indica que os cantos superiores ou esquerdos estão alinhados.

• parentId

  string

  O identificador exclusivo da tela mãe. Fica vazio se for a raiz.

• posição

  LayoutPosition

  A posição do layout dessa tela em relação ao pai. Isso será ignorado para a raiz.

DisplayMode

Chrome 52+ browser.* desde o Chrome 148

Propriedades

• deviceScaleFactor

  número

  O fator de escalonamento do dispositivo no modo de exibição.

• altura

  número

  A altura do modo de exibição em pixels independentes do dispositivo (visíveis para o usuário).

• heightInNativePixels

  número

  A altura do modo de exibição em pixels nativos.

• isInterlaced

  booleano opcional

  Chrome 74+ browser.* desde o Chrome 148

  Verdadeiro se o modo for entrelaçado, falso se não for fornecido.

• isNative

  booleano

  Verdadeiro se o modo for o modo nativo da tela.

• isSelected

  booleano

  Verdadeiro se o modo de exibição estiver selecionado.

• refreshRate

  número

  Chrome 67+ browser.* desde o Chrome 148

  A taxa de atualização do modo de exibição em hertz.

• uiScale

  número optional

  Descontinuado desde o Chrome 70

  Usar displayZoomFactor

  O fator de escalonamento da interface do modo de exibição.

• largura

  número

  A largura do modo de exibição em pixels independentes do dispositivo (visíveis para o usuário).

• widthInNativePixels

  número

  A largura do modo de exibição em pixels nativos.

DisplayProperties

Propriedades

• boundsOriginX

  número optional

  Se definido, atualiza a origem dos limites lógicos da tela ao longo do eixo x. Aplicado junto com boundsOriginY. O padrão será o valor atual se não estiver definido e boundsOriginY estiver definido. Ao atualizar a origem da tela, algumas restrições serão aplicadas. Por isso, a origem final dos limites pode ser diferente da definida. Os limites finais podem ser recuperados usando getInfo. Não é possível mudar a origem dos limites na tela principal.

• boundsOriginY

  número optional

  Se definido, atualiza a origem dos limites lógicos da tela ao longo do eixo y. Consulte a documentação do parâmetro boundsOriginX.

• displayMode

  DisplayMode opcional

  Chrome 52+ browser.* desde o Chrome 148

  Se definido, atualiza o modo de exibição para o modo correspondente a esse valor. Se outros parâmetros forem inválidos, isso não será aplicado. Se o modo de exibição for inválido, ele não será aplicado e um erro será definido, mas outras propriedades ainda serão aplicadas.

• displayZoomFactor

  número optional

  Chrome 65+ browser.* desde o Chrome 148

  Se definido, atualiza o zoom associado à tela. Esse zoom realiza um novo layout e uma nova pintura, resultando em um zoom de melhor qualidade do que apenas um aumento de pixel por pixel.

• isPrimary

  booleano opcional

  Se definida como verdadeira, torna a tela principal. Não operacional se definido como falso. Observação: se definida, a tela será considerada principal para todas as outras propriedades (por exemplo, isUnified pode ser definida, mas a origem dos limites não).

• isUnified

  booleano opcional

  Chrome 59+ browser.* desde o Chrome 148

  Somente no ChromeOS. Se definida como verdadeira, muda o modo de exibição para área de trabalho unificada (consulte enableUnifiedDesktop para mais detalhes). Se for definida como falsa, o modo área de trabalho unificada será desativado. Isso é válido apenas para a tela principal. Se fornecido, mirroringSourceId não pode ser fornecido, e outras propriedades serão ignoradas. Isso não terá efeito se não for fornecido.

• mirroringSourceId

  string opcional

  Descontinuado desde o Chrome 68

  Use setMirrorMode.

  Somente no ChromeOS. Se definido e não estiver vazio, ativa o espelhamento apenas para essa tela. Caso contrário, desativa o espelhamento em todas as telas. Esse valor deve indicar o ID da tela de origem a ser espelhada, que não pode ser o mesmo transmitido para setDisplayProperties. Se definida, nenhuma outra propriedade poderá ser definida.

• overscan

  Insets opcional

  Se definido, define as inserções de overscan da tela para os valores fornecidos. Os valores de overscan não podem ser negativos nem maiores que metade do tamanho da tela. Não é possível mudar o overscan no monitor interno.

• rotação

  número optional

  Se definido, atualiza a rotação da tela. Os valores válidos são [0, 90, 180, 270]. A rotação é definida no sentido horário, em relação à posição vertical da tela.

DisplayUnitInfo

Propriedades

• activeState

  ActiveState

  Chrome 117+ browser.* desde o Chrome 148

  Ativo se a tela for detectada e usada pelo sistema.

• availableDisplayZoomFactors

  number[]

  Chrome 67+ browser.* desde o Chrome 148

  Uma lista de valores de fator de zoom que podem ser definidos para a tela.

• bounds

  Limites

  Os limites lógicos da tela.

• displayZoomFactor

  número

  Chrome 65+ browser.* desde o Chrome 148

  A proporção entre o zoom atual e o padrão da tela. Por exemplo, o valor 1 equivale a 100% de zoom, e o valor 1,5 equivale a 150% de zoom.

• dpiX

  número

  O número de pixels por polegada ao longo do eixo x.

• dpiY

  número

  O número de pixels por polegada ao longo do eixo y.

• edid

  Edid opcional

  Chrome 67+ browser.* desde o Chrome 148

  OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS.

• hasTouchSupport

  booleano

  Chrome 57+ browser.* desde o Chrome 148

  Verdadeiro se essa tela tiver um dispositivo de entrada por toque associado a ela.

• ID

  string

  O identificador exclusivo da tela.

• isEnabled

  booleano

  Verdadeiro se a tela estiver ativada.

• isPrimary

  booleano

  Verdadeiro se esta for a tela principal.

• isUnified

  booleano

  Chrome 59+ browser.* desde o Chrome 148

  Verdadeiro para todas as telas no modo área de trabalho unificada. Consulte a documentação de enableUnifiedDesktop.

• mirroringDestinationIds

  string[]

  Chrome 64+ browser.* desde o Chrome 148

  Somente no ChromeOS. Identificadores das telas em que a tela de origem está sendo espelhada. Vazio se nenhuma tela estiver sendo espelhada. O valor será o mesmo para todas as telas. Isso não pode incluir mirroringSourceId.

• mirroringSourceId

  string

  Somente no ChromeOS. Identificador da tela que está sendo espelhada se o espelhamento estiver ativado. Caso contrário, vazio. Isso será definido para todas as telas (incluindo a que está sendo espelhada).

• modos

  DisplayMode[]

  Chrome 52+ browser.* desde o Chrome 148

  A lista de modos de exibição disponíveis. O modo atual terá isSelected=true. Disponível apenas no ChromeOS. Será definido como uma matriz vazia em outras plataformas.

• nome

  string

  O nome fácil de usar (por exemplo, "Monitor LCD HP").

• overscan

  Encartes

  As inserções da tela dentro dos limites dela. Atualmente, exposto apenas no ChromeOS. Será definido como inserções vazias em outras plataformas.

• rotação

  número

  A rotação no sentido horário da tela em graus em relação à posição vertical. Atualmente, exposto apenas no ChromeOS. Será definido como 0 em outras plataformas. Um valor de -1 será interpretado como rotação automática quando o dispositivo estiver no estado físico de tablet.

• workArea

  Limites

  A área de trabalho utilizável da tela dentro dos limites de exibição. A área de trabalho exclui áreas da tela reservadas para o SO, por exemplo, a barra de tarefas e o inicializador.

Edid

Chrome 67+ browser.* desde o Chrome 148

Propriedades

• manufacturerId

  string

  Código do fabricante com três caracteres. Consulte a seção 3.4.1, página 21. Obrigatório na v1.4.

• productId

  string

  Código de 2 bytes atribuído pelo fabricante, Seção 3.4.2, página 21. Obrigatório na v1.4.

• yearOfManufacture

  número

  Ano de fabricação, seção 3.4.4, página 22. Obrigatório na v1.4.

GetInfoFlags

Chrome 59+ browser.* desde o Chrome 148

Propriedades

• singleUnified

  booleano opcional

  Se definida como verdadeira, apenas um DisplayUnitInfo será retornado por getInfo no modo área de trabalho unificada (consulte enableUnifiedDesktop). O padrão é falso.

Insets

Propriedades

• inferior

  número

  A distância do eixo y do limite inferior.

• esquerda

  número

  A distância do eixo x do limite esquerdo.

• direita

  número

  A distância do eixo x do limite direito.

• superior

  número

  A distância do eixo y do limite superior.

LayoutPosition

Chrome 53+ browser.* desde o Chrome 148

Posição do layout, ou seja, a borda do pai à qual a tela está anexada.

Enumeração

"top"

"right"

"bottom"

"left"

MirrorMode

Chrome 65+ browser.* desde o Chrome 148

Modo espelho, ou seja, diferentes maneiras de espelhar uma tela em outras.

Enumeração

"off"
Especifica o modo padrão (área de trabalho estendida ou unificada).

"normal"
Especifica que a tela de origem padrão será espelhada em todas as outras telas.

"mixed"
Especifica que a tela de origem especificada será espelhada nas telas de destino fornecidas. Todas as outras telas conectadas serão estendidas.

MirrorModeInfo

Chrome 65+ browser.* desde o Chrome 148

Propriedades

• mirroringDestinationIds

  string[] opcional

  Os IDs das telas de destino do espelhamento. Isso é válido apenas para "mixed".

• mirroringSourceId

  string opcional

  O ID da tela de origem do espelhamento. Isso é válido apenas para "mixed".

• modo

  MirrorMode

  O modo espelho que deve ser definido.

Point

Chrome 57+ browser.* desde o Chrome 148

Propriedades

• x

  número

  A coordenada x do ponto.

• y

  número

  A coordenada y do ponto.

TouchCalibrationPair

Chrome 57+ browser.* desde o Chrome 148

Propriedades

• displayPoint

  Point

  As coordenadas do ponto de exibição.

• touchPoint

  Point

  As coordenadas do ponto de toque correspondentes ao ponto de exibição.

TouchCalibrationPairQuad

Chrome 57+ browser.* desde o Chrome 148

Propriedades

• pair1

  TouchCalibrationPair

  Primeiro par de pontos de toque e exibição necessário para a calibração de toque.

• pair2

  TouchCalibrationPair

  Segundo par de pontos de toque e exibição necessário para a calibração de toque.

• pair3

  TouchCalibrationPair

  Terceiro par de pontos de toque e exibição necessário para a calibração de toque.

• pair4

  TouchCalibrationPair

  Quarto par de pontos de toque e exibição necessários para a calibração de toque.

Métodos

clearTouchCalibration()

Chrome 57+ browser.* desde o Chrome 148

browser.system.display.clearTouchCalibration(
  id: string,
): void

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Redefine a calibração de toque da tela e a retorna ao estado padrão, limpando todos os dados de calibração de toque associados à tela.

Parâmetros

• ID

  string

  O identificador exclusivo da tela.

completeCustomTouchCalibration()

Chrome 57+ browser.* desde o Chrome 148

browser.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
): void

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Define os pares de calibragem de toque para uma tela. Esses pairs seriam usados para calibrar a touch screen para exibição com id chamado em startCustomTouchCalibration(). Sempre chame startCustomTouchCalibration antes de chamar esse método. Se outra calibração de toque já estiver em andamento, um erro será gerado.

Parâmetros

• pairs

  TouchCalibrationPairQuad

  Os pares de pontos usados para calibrar a tela.

• bounds

  Limites

  Limites da tela quando a calibração de toque foi realizada. Os valores bounds.left e bounds.top são ignorados.

enableUnifiedDesktop()

Chrome 46+ browser.* desde o Chrome 148

browser.system.display.enableUnifiedDesktop(
  enabled: boolean,
): void

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Ativa/desativa o recurso de área de trabalho unificada. Se essa configuração for ativada enquanto o espelhamento estiver ativo, o modo área de trabalho não vai mudar até que o espelhamento seja desativado. Caso contrário, o modo área de trabalho vai mudar para unificado imediatamente.

Parâmetros

• ativado

  booleano

  Verdadeiro se a área de trabalho unificada precisar ser ativada.

getDisplayLayout()

Chrome 53+ browser.* desde o Chrome 148

browser.system.display.getDisplayLayout(): Promise<DisplayLayout[]>

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Solicita as informações de layout de todas as telas.

Retorna

• Promise<DisplayLayout[]>

  Chrome 91+ browser.* desde o Chrome 148

  Promessa que é resolvida com os resultados.

getInfo()

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

Solicita as informações de todos os dispositivos de exibição conectados.

Parâmetros

• flags

  GetInfoFlags opcional

  Chrome 59+ browser.* desde o Chrome 148

  Opções que afetam como as informações são retornadas.

Retorna

• Promise<DisplayUnitInfo[]>

  Chrome 91+ browser.* desde o Chrome 148

  Promessa que é resolvida com os resultados.

overscanCalibrationAdjust()

Chrome 53+ browser.* desde o Chrome 148

browser.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
): void

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Ajusta as inserções de overscan atuais de uma tela. Normalmente, isso deve mover a tela ao longo de um eixo (por exemplo, esquerda+direita têm o mesmo valor) ou dimensioná-la ao longo de um eixo (por exemplo, cima+baixo têm valores opostos). Cada chamada de ajuste é cumulativa com as chamadas anteriores desde o início.

Parâmetros

• ID

  string

  O identificador exclusivo da tela.

• dado

  Encartes

  O valor para mudar as inserções de overscan.

overscanCalibrationComplete()

Chrome 53+ browser.* desde o Chrome 148

browser.system.display.overscanCalibrationComplete(
  id: string,
): void

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Conclua os ajustes de overscan de uma tela salvando os valores atuais e ocultando a sobreposição.

Parâmetros

• ID

  string

  O identificador exclusivo da tela.

overscanCalibrationReset()

Chrome 53+ browser.* desde o Chrome 148

browser.system.display.overscanCalibrationReset(
  id: string,
): void

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Redefine as inserções de overscan de uma tela para o último valor salvo (ou seja, antes de Start ser chamado).

Parâmetros

• ID

  string

  O identificador exclusivo da tela.

overscanCalibrationStart()

Chrome 53+ browser.* desde o Chrome 148

browser.system.display.overscanCalibrationStart(
  id: string,
): void

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Inicia a calibração de overscan para uma tela. Isso vai mostrar uma sobreposição na tela indicando as inserções de overscan atuais. Se a calibração de overscan para a tela id estiver em andamento, ela será redefinida.

Parâmetros

• ID

  string

  O identificador exclusivo da tela.

setDisplayLayout()

Chrome 53+ browser.* desde o Chrome 148

browser.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
): Promise<void>

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Defina o layout para todas as telas. As telas não incluídas vão usar o layout padrão. Se um layout se sobrepuser ou for inválido, ele será ajustado para um layout válido. Depois que o layout for resolvido, um evento onDisplayChanged será acionado.

Parâmetros

• layouts

  DisplayLayout[]

  As informações de layout, necessárias para todas as telas, exceto a principal.

Retorna

• Promessa<void>

  Chrome 91+ browser.* desde o Chrome 148

  Promessa que é resolvida quando a função é concluída.

setDisplayProperties()

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

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Atualiza as propriedades da tela especificada por id, de acordo com as informações fornecidas em info. Em caso de falha, runtime.lastError será definido.

Parâmetros

• ID

  string

  O identificador exclusivo da tela.

• informações

  DisplayProperties

  As informações sobre as propriedades de exibição que precisam ser alteradas. Uma propriedade só será alterada se um novo valor for especificado em info.

Retorna

• Promessa<void>

  Chrome 91+ browser.* desde o Chrome 148

  Promessa que é resolvida quando a função é concluída.

setMirrorMode()

Chrome 65+ browser.* desde o Chrome 148

browser.system.display.setMirrorMode(
  info: MirrorModeInfo,
): Promise<void>

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Define o modo de exibição como o modo espelho especificado. Cada chamada redefine o estado das chamadas anteriores. A chamada de setDisplayProperties() vai falhar para as telas de destino do espelhamento.

Parâmetros

• informações

  MirrorModeInfo

  As informações do modo espelho que devem ser aplicadas ao modo de exibição.

Retorna

• Promessa<void>

  Chrome 91+ browser.* desde o Chrome 148

  Promessa que é resolvida quando a função é concluída.

showNativeTouchCalibration()

Chrome 57+ browser.* desde o Chrome 148

browser.system.display.showNativeTouchCalibration(
  id: string,
): Promise<boolean>

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Mostra a UX de calibração de toque nativa para a tela com id como ID. Uma sobreposição vai aparecer na tela com as instruções necessárias sobre como proceder. O callback será invocado apenas em caso de calibração bem-sucedida. Se a calibragem falhar, um erro será gerado.

Parâmetros

• ID

  string

  O identificador exclusivo da tela.

Retorna

• Promise<boolean>

  Chrome 91+ browser.* desde o Chrome 148

  Promessa que é resolvida para informar ao autor da chamada que a calibragem por toque terminou. O valor booleano informa se a calibragem foi bem-sucedida ou não.

startCustomTouchCalibration()

Chrome 57+ browser.* desde o Chrome 148

browser.system.display.startCustomTouchCalibration(
  id: string,
): void

OBSERVAÇÃO: essa opção só está disponível para apps de quiosque do ChromeOS. Inicia a calibração de toque personalizada para uma tela. Isso precisa ser chamado ao usar uma UX personalizada para coletar dados de calibragem. Se outra calibração de toque já estiver em andamento, um erro será gerado.

Parâmetros

• ID

  string

  O identificador exclusivo da tela.

Eventos

onDisplayChanged

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

Disparado quando algo muda na configuração de exibição.

Parâmetros

• callback

  função

  O parâmetro callback é semelhante a:

  () => void