chrome.system.display

Descrição

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

Permissões

system.display

Tipos

ActiveState

Chrome 117 e versões mais recentes

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

Enumeração

"ativo"

"inactive"

Bounds

Propriedades

• altura

  number

  A altura da tela em pixels.

• esquerda

  number

  A coordenada x do canto superior esquerdo.

• superior

  number

  A coordenada y do canto superior esquerdo.

• largura

  number

  A largura da tela em pixels.

DisplayLayout

Chrome 53 ou mais recente

Propriedades

• id

  string

  O identificador exclusivo da tela.

• offset

  number

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

• parentId

  string

  O identificador exclusivo da tela pai. Deixe em branco 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 e versões mais recentes

Propriedades

• deviceScaleFactor

  number

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

• altura

  number

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

• heightInNativePixels

  number

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

• isInterlaced

  booleano opcional

  Chrome 74 e versões mais recentes

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

• isNative

  booleano

  Verdadeiro se o modo for nativo da tela.

• isSelected

  booleano

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

• refreshRate

  number

  Chrome 67 e versões mais recentes

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

• uiScale

  número opcional

  Suspensa desde o Chrome 70

  Usar displayZoomFactor

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

• largura

  number

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

• widthInNativePixels

  number

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

DisplayProperties

Propriedades

• boundsOriginX

  número opcional

  Se definido, atualiza a origem dos limites lógicos da tela ao longo do eixo x. Aplicado com boundsOriginY. O valor padrão será o valor atual se não for definido e boundsOriginY estiver definido. Ao atualizar a origem da tela, algumas restrições serão aplicadas, portanto, a origem dos limites finais pode ser diferente da definida. Os limites finais podem ser recuperados usando getInfo. A origem dos limites não pode ser alterada na tela principal.

• boundsOriginY

  número opcional

  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 e versões mais recentes

  Se definido, atualiza o modo de exibição para o modo correspondente a esse valor. Se outros parâmetros forem inválidos, eles não serão aplicados. 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 opcional

  Chrome 65 e versões mais recentes

  Se definido, atualiza o zoom associado à tela. Esse zoom realiza o redimensionamento e a repintura, resultando em um zoom de melhor qualidade do que apenas um aumento de alongamento de pixel por pixel.

• isPrimary

  booleano opcional

  Se definido como "true", torna a tela principal. Não faz nada se definido como falso. Observação: se definido, a tela será considerada primária para todas as outras propriedades. Ou seja, isUnified pode ser definido e a origem dos limites não.

• isUnified

  booleano opcional

  Chrome 59 e versões mais recentes

  Somente no ChromeOS. Se definida como "true", muda o modo de exibição para a área de trabalho unificada. Consulte enableUnifiedDesktop para saber mais. Se definido como falso, o modo de área de trabalho unificada será desativado. Isso é válido apenas para a tela principal. Se for fornecido, o mirroringSourceId não poderá ser fornecido, e as outras propriedades serão ignoradas. Isso não terá efeito se não for fornecido.

• mirroringSourceId

  string opcional

  Suspensa desde o Chrome 68

  Use setMirrorMode.

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

• overscan

  Encartes opcional

  Se definido, define os recortes de sobreposição da tela para os valores fornecidos. Os valores de overscan não podem ser negativos ou maiores que a metade do tamanho da tela. Não é possível mudar a sobreposição no monitor interno.

• rotação

  número opcional

  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 e versões mais recentes

  Ativo se a tela for detectada e usada pelo sistema.

• availableDisplayZoomFactors

  number[]

  Chrome 67 e versões mais recentes

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

• limites

  Limites

  Os limites lógicos da tela.

• displayZoomFactor

  number

  Chrome 65 e versões mais recentes

  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

  number

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

• dpiY

  number

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

• edid

  Edid opcional

  Chrome 67 e versões mais recentes

  OBSERVAÇÃO: esse recurso está disponível apenas para apps de quiosque do ChromeOS e para a interface da Web.

• hasTouchSupport

  booleano

  Chrome 57 ou mais recente

  Verdadeiro se a 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 essa for a tela principal.

• isUnified

  booleano

  Chrome 59 e versões mais recentes

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

• mirroringDestinationIds

  string[]

  Chrome 64+

  Somente no ChromeOS. Identificadores das telas em que a tela de origem está sendo espelhada. Vazia se nenhuma tela estiver sendo espelhada. Esse valor será definido como o mesmo para todas as telas. Ele 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, estará vazio. Isso será definido para todas as telas (incluindo a tela espelhada).

• modos

  DisplayMode[]

  Chrome 52 e versões mais recentes

  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 amigável (por exemplo, "Monitor LCD HP").

• overscan

  Encartes

  O recorte da tela dentro dos limites da tela. Atualmente exposto apenas no ChromeOS. Será definido como insetos vazios em outras plataformas.

• rotação

  number

  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 em um estado de tablet físico.

• workArea

  Limites

  A área de trabalho utilizável da tela dentro dos limites da tela. A área de trabalho exclui áreas da tela reservadas para o SO, como a barra de tarefas e o iniciador.

Edid

Chrome 67 e versões mais recentes

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

  number

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

GetInfoFlags

Chrome 59 e versões mais recentes

Propriedades

• singleUnified

  booleano opcional

  Se definido como "true", apenas uma DisplayUnitInfo será retornada por getInfo no modo de computador unificado (consulte enableUnifiedDesktop). O padrão é "false".

Insets

Propriedades

• inferior

  number

  A distância do eixo Y em relação ao limite inferior.

• esquerda

  number

  A distância do eixo X em relação ao limite à esquerda.

• direita

  number

  A distância do eixo x em relação ao limite direito.

• superior

  number

  A distância do eixo Y em relação ao limite superior.

LayoutPosition

Chrome 53 e versões mais recentes

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

Enumeração

"top"

"right"

"bottom"

"left"

MirrorMode

Chrome 65 e versões mais recentes

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

Enumeração

"off"
Especifica o modo padrão (computador estendido ou unificado).

"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 e versões mais recentes

Propriedades

• mirroringDestinationIds

  string[] opcional

  Os IDs do destino de espelhamento são exibidos. 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 precisa ser definido.

Point

Chrome 57 ou mais recente

Propriedades

• x

  number

  A coordenada x do ponto.

• y

  number

  A coordenada y do ponto.

TouchCalibrationPair

Chrome 57 ou mais recente

Propriedades

• displayPoint

  Ponto

  As coordenadas do ponto de exibição.

• touchPoint

  Ponto

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

TouchCalibrationPairQuad

Chrome 57 ou mais recente

Propriedades

• pair1

  TouchCalibrationPair

  Primeiro par de pontos de toque e tela necessários para a calibração do toque.

• pair2

  TouchCalibrationPair

  Segundo par de pontos de toque e tela necessários para a calibração do toque.

• pair3

  TouchCalibrationPair

  Terceiro par de pontos de toque e tela necessários para a calibração do toque.

• pair4

  TouchCalibrationPair

  O quarto par de pontos de toque e exibição é necessário para a calibração do toque.

Métodos

clearTouchCalibration()

Chrome 57 ou mais recente

chrome.system.display.clearTouchCalibration(
  id: string,
)

Redefine a calibração de toque da tela e a traz de volta 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 ou mais recente

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

Define os pares de calibração de toque para uma tela. Esses pairs seriam usados para calibrar a tela touchscreen 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, isso vai gerar um erro.

Parâmetros

• pairs

  TouchCalibrationPairQuad

  Os pares de pontos usados para calibrar a tela.

• limites

  Limites

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

enableUnifiedDesktop()

Chrome 46 ou mais recente

chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
)

Ativa/desativa o recurso de área de trabalho unificada. Se ativar o modo de computador enquanto o espelhamento estiver ativo, o modo de computador não vai mudar até que o espelhamento seja desativado. Caso contrário, o modo de computador vai mudar para o modo unificado imediatamente. OBSERVAÇÃO: esse recurso está disponível apenas para apps de quiosque do ChromeOS e para a interface da Web.

Parâmetros

• ativado

  booleano

  Verdadeiro se o computador unificado precisa ser ativado.

getDisplayLayout()

Promessa Chrome 53+

chrome.system.display.getDisplayLayout(
  callback?: function,
)

Solicita as informações de layout de todas as telas. OBSERVAÇÃO: esse recurso está disponível apenas para apps de quiosque do ChromeOS e para a interface da Web.

Parâmetros

• callback

  função opcional

  O parâmetro callback tem este formato:

  (layouts: DisplayLayout[]) => void

  • layouts

    DisplayLayout[]

Retorna

• Promise<DisplayLayout[]>

  Chrome 91 e versões mais recentes

  As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getInfo()

Promessa

chrome.system.display.getInfo(
  flags?: GetInfoFlags,
  callback?: function,
)

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

Parâmetros

• flags

  GetInfoFlags opcional

  Chrome 59 e versões mais recentes

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

• callback

  função opcional

  O parâmetro callback tem este formato:

  (displayInfo: DisplayUnitInfo[]) => void

  • displayInfo

    DisplayUnitInfo[]

Retorna

• Promise<DisplayUnitInfo[]>

  Chrome 91 e versões mais recentes

  As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

overscanCalibrationAdjust()

Chrome 53 e versões mais recentes

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

Ajusta os recortes de overscan atuais de uma tela. Normalmente, isso move a tela ao longo de um eixo (por exemplo, esquerda + direita têm o mesmo valor) ou a dimensiona ao longo de um eixo (por exemplo, cima + baixo têm valores opostos). Cada chamada do Adjust é cumulativa com as chamadas anteriores desde o início.

Parâmetros

• id

  string

  O identificador exclusivo da tela.

• dado

  Encartes

  A quantidade para mudar os insetos de overscan.

overscanCalibrationComplete()

Chrome 53 ou mais recente

chrome.system.display.overscanCalibrationComplete(
  id: string,
)

Faça ajustes de overscan para uma tela salvando os valores atuais e ocultando a sobreposição.

Parâmetros

• id

  string

  O identificador exclusivo da tela.

overscanCalibrationReset()

Chrome 53 e versões mais recentes

chrome.system.display.overscanCalibrationReset(
  id: string,
)

Redefine os insetos de overscan de uma tela para o último valor salvo (ou seja, antes de a chamada Start).

Parâmetros

• id

  string

  O identificador exclusivo da tela.

overscanCalibrationStart()

Chrome 53 ou mais recente

chrome.system.display.overscanCalibrationStart(
  id: string,
)

Inicia a calibração de overscan para uma tela. Isso vai mostrar uma sobreposição na tela indicando os insets de overscan atuais. Se a calibração de overscan para a tela id estiver em andamento, a calibração será redefinida.

Parâmetros

• id

  string

  O identificador exclusivo da tela.

setDisplayLayout()

Promessa Chrome 53+

chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

Defina o layout para todas as telas. Qualquer tela não incluída vai usar o layout padrão. Se um layout se sobrepor ou for inválido, ele será ajustado para um layout válido. Depois que o layout for resolvido, um evento onDisplayChanged será acionado. OBSERVAÇÃO: esse recurso está disponível apenas para apps de quiosque do ChromeOS e para a interface da Web.

Parâmetros

• layouts

  DisplayLayout[]

  As informações do layout, obrigatórias para todas as telas, exceto a principal.

• callback

  função opcional

  O parâmetro callback tem este formato:

  () => void

Retorna

• Promise<void>

  Chrome 91 e versões mais recentes

  As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

setDisplayProperties()

Promessa

chrome.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
  callback?: function,
)

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. OBSERVAÇÃO: esse recurso está disponível apenas para apps de quiosque do ChromeOS e para a interface da Web.

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.

• callback

  função opcional

  O parâmetro callback tem este formato:

  () => void

Retorna

• Promise<void>

  Chrome 91 e versões mais recentes

  As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

setMirrorMode()

Promessa Chrome 65+

chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
  callback?: function,
)

Define o modo de exibição como o modo de espelhamento especificado. Cada chamada redefine o estado de chamadas anteriores. A chamada de setDisplayProperties() vai falhar para as telas de destino de espelhamento. OBSERVAÇÃO: esse recurso está disponível apenas para apps de quiosque do ChromeOS e para a interface da Web.

Parâmetros

• informações

  MirrorModeInfo

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

• callback

  função opcional

  O parâmetro callback tem este formato:

  () => void

Retorna

• Promise<void>

  Chrome 91 e versões mais recentes

  As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

showNativeTouchCalibration()

Promessa Chrome 57+

chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

Mostra a UX de calibração de toque nativa para a tela com id como ID de tela. Uma sobreposição vai aparecer na tela com as instruções necessárias para continuar. O callback só será invocado em caso de calibração bem-sucedida. Se a calibração falhar, um erro será gerado.

Parâmetros

• id

  string

  O identificador exclusivo da tela.

• callback

  função opcional

  O parâmetro callback tem este formato:

  (success: boolean) => void

  • sucesso

    booleano

Retorna

• Promise<boolean>

  Chrome 91 e versões mais recentes

  As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

startCustomTouchCalibration()

Chrome 57 ou mais recente

chrome.system.display.startCustomTouchCalibration(
  id: string,
)

Inicia a calibragem de toque personalizada para uma tela. Ele precisa ser chamado ao usar uma UX personalizada para coletar dados de calibração. Se outra calibração de toque já estiver em andamento, isso vai gerar um erro.

Parâmetros

• id

  string

  O identificador exclusivo da tela.

Eventos

onDisplayChanged

chrome.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 tem este formato:

  () => void