chrome.system.display

Descrição

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

Permissões

system.display

Tipos

ActiveState

Chrome 117 ou mais recente

Uma enumeração para saber se a tela é detectada e usada pelo sistema. A tela é considerada "inativa" quando não é detectada pelo sistema (pode estar desconectada ou considerada desconectada devido ao modo de sono etc). Esse estado é usado, por exemplo, para manter a tela atual quando todas as telas estão desconectadas.

Tipo enumerado

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. O valor 0 indica que os cantos mais superior ou mais à esquerda estão alinhados.

  • parentId

    string

    O identificador exclusivo da tela principal. Vai ser vazio se for a raiz.

  • posição

    LayoutPosition

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

DisplayMode

Chrome 52 ou mais recente

Propriedades

  • deviceScaleFactor

    number

    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 ao usuário).

  • heightInNativePixels

    number

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

  • isInterlaced

    booleano opcional

    Chrome 74 ou mais recente

    "True", se esse modo é entrelaçado; "false", se não é fornecido.

  • isNative

    boolean

    Verdadeiro se o modo for o modo nativo da tela.

  • isSelected

    boolean

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

  • refreshRate

    number

    Chrome 67 ou mais recente

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

  • uiScale

    número opcional

    Descontinuado 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 ao 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 em conjunto com boundsOriginY. Se não for definido e boundsOriginY estiver definido, o padrão será o valor atual. Observe que, ao atualizar a origem de exibição, algumas restrições serão aplicadas, portanto, a origem dos limites finais pode ser diferente do conjunto. Os limites finais podem ser recuperados usando getInfo. Não é possível mudar a origem dos limites 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 ou mais recente

    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 opcional

    Chrome 65 ou mais recente

    Se definido, atualiza o zoom associado à tela. Esse zoom executa um novo layout e repintura, resultando em uma qualidade de zoom melhor do que apenas realizar um aumento de alongamento pixel por pixel.

  • isPrimary

    booleano opcional

    Se definido como verdadeiro, torna a tela principal. Ambiente autônomo se for definido como falso. Observação: se definido, a exibição será considerada principal para todas as outras propriedades (ou seja, isUnified pode ser definido e a origem dos limites pode não).

  • isUnified

    booleano opcional

    Chrome 59 ou mais recente

    Somente no Chrome OS. Se definida como verdadeira, muda o modo de exibição para área de trabalho unificada. Consulte enableUnifiedDesktop para ver mais detalhes. Se for definido como falso, o modo de área de trabalho unificada será desativado. Válido somente para a tela principal. Se fornecido, espelhamentoSourceId não pode ser fornecido e outras propriedades serão ignoradas. Isso não terá efeito se não for informado.

  • mirroringSourceId

    string opcional

    Descontinuado desde o Chrome 68

    Use setMirrorMode.

    Somente no Chrome OS. Se definido e não estiver vazio, o espelhamento será ativado apenas para essa tela. Caso contrário, desativa o espelhamento para todas as telas. Esse valor indica o ID da tela de origem a ser espelhada, que não pode ser igual ao ID transmitido para setDisplayProperties. Se definido, nenhuma outra propriedade poderá ser definida.

  • overscan

    Encartes opcional

    Se definido, configura os encartes de overscan da tela como os valores fornecidos. Os valores de overscan não podem ser negativos nem maiores do que a metade do tamanho da tela. O overscan não pode ser alterado no monitor interno.

  • rotação

    número opcional

    Se definido, atualiza a rotação da tela. Os valores legais 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 ou mais recente

    Ativo se a tela for detectada e usada pelo sistema.

  • availableDisplayZoomFactors

    Número[]

    Chrome 67 ou mais recente

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

  • limites

    Limites

    Limites lógicos da tela.

  • displayZoomFactor

    number

    Chrome 65 ou mais recente

    A proporção entre o zoom atual da tela e o zoom padrão. 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 ou mais recente

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

  • hasTouchSupport

    boolean

    Chrome 57 ou mais recente

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

  • id

    string

    O identificador exclusivo da tela.

  • isEnabled

    boolean

    Verdadeiro se esta tela estiver ativada.

  • isPrimary

    boolean

    Verdadeiro se essa for a tela principal.

  • isUnified

    boolean

    Chrome 59 ou mais recente

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

  • mirroringDestinationIds

    string[]

    Chrome 64 ou mais recente

    Somente no Chrome OS. Identificadores das telas em que a tela de origem está sendo espelhada. Estará vazio se nenhuma tela estiver sendo espelhada. Ele será definido como o mesmo valor em todas as exibições. Isso não pode incluir mirroringSourceId.

  • mirroringSourceId

    string

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

  • modes

    DisplayMode[]

    Chrome 52 ou mais recente

    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.

  • name

    string

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

  • overscan

    Encartes

    Encartes da tela dentro dos limites da tela. Atualmente exposto apenas no ChromeOS. Será definido como encartes 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. Ele será definido como 0 em outras plataformas. O valor -1 será interpretado como giro automático quando o dispositivo estiver no estado de um tablet físico.

  • workArea

    Limites

    A área de trabalho utilizável da tela dentro dos limites dela. A área de trabalho exclui áreas da tela reservadas para o SO, por exemplo, a barra de tarefas e a tela de início.

Edid

Chrome 67 ou mais recente

Propriedades

  • manufacturerId

    string

    Código do fabricante com três caracteres. Consulte a seção 3.4.1 na 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 ou mais recente

Propriedades

  • singleUnified

    booleano opcional

    Se definido como verdadeiro, apenas uma única DisplayUnitInfo será retornada por getInfo quando estiver no modo de área de trabalho unificada (consulte enableUnifiedDesktop). O padrão é falso.

Insets

Propriedades

  • inferior

    number

    A distância do eixo y a partir do limite inferior.

  • à esquerda

    number

    A distância do eixo x do limite esquerdo.

  • à direita

    number

    A distância do eixo x do limite direito.

  • superior

    number

    A distância do eixo y do limite superior.

LayoutPosition

Chrome 53 ou mais recente

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

Tipo enumerado

"top"

MirrorMode

Chrome 65 ou mais recente

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

Tipo enumerado

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

"normal"
especifica que a tela de origem padrão será espelhada para 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 ou mais recente

Propriedades

  • mirroringDestinationIds

    string[] opcional

    Os IDs do destino do espelhamento são exibidos. Válido somente para "misto".

  • mirroringSourceId

    string opcional

    O código da exibição da origem do espelhamento. Válido somente para "misto".

  • modo

    MirrorMode

    O modo espelhado 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 contato correspondente ao ponto de exibição.

TouchCalibrationPairQuad

Chrome 57 ou mais recente

Propriedades

  • O primeiro par de ponto de contato e de exibição é necessário para a calibração do toque.

  • O segundo par de ponto de contato e de exibição é necessário para a calibração do toque.

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

  • 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 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 ou mais recente 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
)

Define os pares de calibração de toque para uma tela. Esses pairs serão usados para calibrar a tela touchscreen com o método id chamado em startCustomTouchCalibration(). Sempre chame startCustomTouchCalibration antes desse método. Se outra calibração de toque já estiver em andamento, isso vai gerar um erro.

Parâmetros

  • Os pares de pontos usados para calibrar a tela.

  • limites

    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 ou mais recente 
chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
)

Ativa/desativa o recurso de área de trabalho unificada. Se ativado enquanto o espelhamento estiver ativo, o modo de área de trabalho não será alterado até que o espelhamento seja desativado. Caso contrário, o modo de área de trabalho será alterado para "Unificado" imediatamente. OBSERVAÇÃO: esse recurso só está disponível para apps de quiosque do ChromeOS e para a interface da Web.

Parâmetros

  • ativado

    boolean

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

getDisplayLayout()

Promessa Chrome 53 ou mais recente 
chrome.system.display.getDisplayLayout(
  callback?: function,
)

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

Parâmetros

Retorna

  • Promise<DisplayLayout[]>

    Chrome 91 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

getInfo()

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

Solicita as informações de todos os dispositivos de tela conectados.

Parâmetros

  • flags

    GetInfoFlags opcional

    Chrome 59 ou mais recente

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (displayInfo: DisplayUnitInfo[])=>void

Retorna

  • Promise<DisplayUnitInfo[]>

    Chrome 91 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

overscanCalibrationAdjust()

Chrome 53 ou mais recente 
chrome.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
)

Ajusta os encartes atuais de overscan de uma tela. Normalmente, isso deve mover a exibição ao longo de um eixo (por exemplo, esquerda+direita têm o mesmo valor) ou dimensioná-la ao longo de um eixo (por exemplo, superior+inferior têm valores opostos). Cada chamada Adjust é cumulativa com chamadas anteriores desde o início.

Parâmetros

  • id

    string

    O identificador exclusivo da tela.

  • dado

    Encartes

    A quantidade para alterar os encartes de overscan.

overscanCalibrationComplete()

Chrome 53 ou mais recente 
chrome.system.display.overscanCalibrationComplete(
  id: string,
)

Conclua os 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 ou mais recente 
chrome.system.display.overscanCalibrationReset(
  id: string,
)

Redefine os encartes de overscan de uma tela com o último valor salvo (ou seja, antes da chamada de 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. Uma sobreposição será exibida na tela, indicando os encartes atuais de overscan. 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 ou mais recente 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

Define o layout de todas as telas. Qualquer tela não incluída 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. OBSERVAÇÃO: esse recurso só está disponível para apps de quiosque do ChromeOS e para a interface da Web.

Parâmetros

  • layouts

    DisplayLayout[]

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 91 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

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 só está disponível para apps de quiosque do ChromeOS e para a interface da Web.

Parâmetros

  • id

    string

    O identificador exclusivo da tela.

  • informações

    DisplayProperties

    Informações sobre as propriedades de exibição que precisam ser alteradas. Uma propriedade será modificada somente se um novo valor para ela for especificado em info.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 91 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

setMirrorMode()

Promessa Chrome 65+ 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
  callback?: function,
)

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

Parâmetros

  • informações

    MirrorModeInfo

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 91 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

showNativeTouchCalibration()

Promessa Chrome 57+ 
chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

Mostra a UX de calibração do toque nativo da tela com id como ID de exibição. Uma sobreposição será exibida na tela com as instruções necessárias sobre como proceder. O callback será invocado somente em caso de calibração. Se a calibração falhar, um erro será gerado.

Parâmetros

  • id

    string

    O identificador exclusivo da tela.

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (success: boolean)=>void

    • sucesso

      boolean

Retorna

  • Promise<boolean>

    Chrome 91 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

startCustomTouchCalibration()

Chrome 57 ou mais recente 
chrome.system.display.startCustomTouchCalibration(
  id: string,
)

Inicia a calibração de toque personalizada para uma tela. Ele precisa ser chamado ao usar uma UX personalizada para coletar dados de calibragem. 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 da tela.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    ()=>void