chrome.system.display

Descrição

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

Permissões

system.display

Tipos

ActiveState

Chrome 117 ou versões mais recentes

Uma enumeração para informar se a tela será detectada e usada pelo sistema. O visor é considerado "inativo" se não for detectado pelo sistema (talvez desconectado ou considerado desconectado devido ao modo de espera, etc). Esse estado é usado, por exemplo, para manter a tela atual quando todas estiverem desconectadas.

Enumeração

"ativo"

"inativo"

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 superior

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 superior ou mais esquerdo estão alinhados.

  • parentId

    string

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

  • posição

    LayoutPosition

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

DisplayMode

Chrome 52 ou superior

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

  • heightInNativePixels

    number

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

  • isInterlaced

    booleano opcional

    Chrome 74 ou superior

    Verdadeiro se esse 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

    number

    Chrome 67 ou superior

    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 com boundsOriginY. O padrão será o valor atual se nenhum valor for definido e boundsOriginY estiver definido. Ao atualizar a origem da exibição, 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. 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 superior

    Se definido, atualiza o modo de exibição para o modo que corresponde 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 superior

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

  • isPrimary

    booleano opcional

    Se definida como verdadeira, a tela será a principal. Ambiente autônomo se definido como falso. Observação: se definida, a tela vai ser considerada principal para todas as outras propriedades. Ou seja, isUnified pode ser definida, e a origem dos limites não.

  • isUnified

    booleano opcional

    Chrome 59 ou superior

    Somente no Chrome OS. Se ela for definida como verdadeira, o modo de exibição será alterado para área de trabalho unificada. Consulte enableUnifiedDesktop para mais detalhes. Se ela for definida como falsa, o modo de área de trabalho unificada será desativado. Isso só é válido para a tela principal. Se fornecido, o 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

    Suspenso desde o Chrome 68

    Use setMirrorMode.

    Somente no Chrome OS. Se definido e não estiver vazio, o espelhamento será ativado apenas para esta tela. Caso contrário, o espelhamento será desativado em todas as telas. Esse valor precisa indicar 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, define os encartes de overscan da tela como os valores fornecidos. Os valores de overscan não podem ser negativos ou maiores 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 versões mais recentes

    Ativo se a tela for detectada e usada pelo sistema.

  • availableDisplayZoomFactors

    número[]

    Chrome 67 ou superior

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

  • limites

    Limites

    Limites lógicos da exibição.

  • displayZoomFactor

    number

    Chrome 65 ou superior

    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 ou superior

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

  • hasTouchSupport

    booleano

    Chrome 57 ou superior

    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 esta for a tela principal.

  • isUnified

    booleano

    Chrome 59 ou superior

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

  • mirroringDestinationIds

    string[]

    Chrome 64 ou superior

    Somente no Chrome OS. Identificadores das telas em que a exibição de origem está sendo espelhada. Vai ser vazio se nenhuma tela estiver sendo espelhada. Ele será definido com o mesmo valor para todas as telas. Não pode incluir mirroringSourceId.

  • mirroringSourceId

    string

    Somente no Chrome OS. Identificador da tela que será 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 ou superior

    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

    Encartes da tela dentro dos limites da tela. No momento, exposta apenas no ChromeOS. Será definido como encartes vazios em outras plataformas.

  • rotação

    number

    A rotação da tela no sentido horário em graus em relação à posição vertical. No momento, exposta 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 acesso rápido.

Edid

Chrome 67 ou superior

Propriedades

  • manufacturerId

    string

    Código do fabricante de 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, segundo 3.4.2 página 21. Obrigatório na v1.4.

  • yearOfManufacture

    number

    Ano do fabricante, s. 3.4.4 página 22. Obrigatório na v1.4.

GetInfoFlags

Chrome 59 ou superior

Propriedades

  • singleUnified

    booleano opcional

    Se ela for definida como verdadeira, apenas uma única DisplayUnitInfo será retornada por getInfo quando estiver no modo de área de trabalho unificada (consulte enableUnifiedDesktop). O padrão é "false".

Insets

Propriedades

  • inferior

    number

    A distância do eixo y 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 superior

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

Enumeração

"top"

"direita"

"inferior"

"esquerda"

MirrorMode

Chrome 65 ou superior

Modo de espelho, ou seja, formas diferentes de como uma tela é espelhada em outras.

Enumeração

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

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

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

MirrorModeInfo

Chrome 65 ou superior

Propriedades

  • mirroringDestinationIds

    string[] opcional

    Os IDs do destino do espelhamento são exibidos. Isso só é válido para "misto".

  • mirroringSourceId

    string opcional

    O ID da tela de origem do espelhamento. Isso só é válido para "misto".

  • modo

    MirrorMode

    O modo espelhado que precisa ser definido.

Point

Chrome 57 ou superior

Propriedades

  • x

    number

    A coordenada x do ponto.

  • y

    number

    A coordenada y do ponto.

TouchCalibrationPair

Chrome 57 ou superior

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 superior

Propriedades

  • Primeiro par de toque e ponto de exibição necessários para a calibração de toque.

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

  • Terceiro par de toque e ponto de exibição necessários para a calibragem de toque.

  • O quarto par de toque e ponto de exibição é necessário para a calibragem do toque.

Métodos

clearTouchCalibration()

Chrome 57 ou superior 
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 calibragem de toque associados à tela.

Parâmetros

  • id

    string

    O identificador exclusivo da tela.

completeCustomTouchCalibration()

Chrome 57 ou superior 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
)

Define os pares de calibração de toque para uma tela. Esses pairs vão ser usados para calibrar a tela touchscreen 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

  • Os pares de pontos usados para calibrar a tela.

  • limites

    Limites

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

enableUnifiedDesktop()

Chrome 46 ou superior 
chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
)

Ativa/desativa o recurso da á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 aplicativos de quiosque do Chrome OS e para a interface da Web.

Parâmetros

  • ativado

    booleano

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

getDisplayLayout()

Promessa Chrome 53 ou versão 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 aplicativos de quiosque do Chrome OS e para a interface da Web.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (layouts: DisplayLayout[]) => void

Retorna

  • Promise<DisplayLayout[]>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto 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 tela conectados.

Parâmetros

  • flags

    GetInfoFlags opcional

    Chrome 59 ou superior

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

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (displayInfo: DisplayUnitInfo[]) => void

Retorna

  • Promise<DisplayUnitInfo[]>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

overscanCalibrationAdjust()

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

Ajusta os encartes 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, superior + inferior têm valores opostos). Cada chamada "Adjust" é cumulativa com as chamadas anteriores desde o início.

Parâmetros

  • id

    string

    O identificador exclusivo da tela.

  • dado

    Encartes

    O valor para alterar os encartes de overscan.

overscanCalibrationComplete()

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

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

Redefine os encartes de overscan de uma tela para o último valor salvo (ou seja, antes de o Start ser chamado).

Parâmetros

  • id

    string

    O identificador exclusivo da tela.

overscanCalibrationStart()

Chrome 53 ou superior 
chrome.system.display.overscanCalibrationStart(
  id: string,
)

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

Parâmetros

  • id

    string

    O identificador exclusivo da tela.

setDisplayLayout()

Promessa Chrome 53 ou versão mais recente 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

Definir o layout de todas as telas. Qualquer tela não incluída usará o layout padrão. Caso um layout se sobreponha ou seja 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 aplicativos de quiosque do Chrome OS 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 opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto 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 só está disponível para aplicativos de quiosque do Chrome OS 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 esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

setMirrorMode()

Promessa Chrome 65 ou mais recente 
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. A chamada de setDisplayProperties() falhará para as telas de destino do espelhamento. OBSERVAÇÃO: esse recurso só está disponível para aplicativos de quiosque do Chrome OS e para a interface da Web.

Parâmetros

  • informações

    MirrorModeInfo

    Informações do modo espelhado que precisa ser aplicado ao modo de exibição.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

showNativeTouchCalibration()

Promessa Chrome 57 ou versão mais recente 
chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

Mostra a UX de calibração de toque nativo para a tela com id como ID de tela. Uma sobreposição será exibida na tela com as instruções necessárias sobre como proceder. O callback será invocado apenas no caso de uma calibragem bem-sucedida. Se a calibração falhar, isso vai gerar um erro.

Parâmetros

  • id

    string

    O identificador exclusivo da tela.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (success: boolean) => void

    • sucesso

      booleano

Retorna

  • Promise&lt;boolean&gt;

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

startCustomTouchCalibration()

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

Inicia a calibragem de toque personalizada de uma tela. Deve 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