CKTIS / JavaScript
MouseEvent: código do botão e coordenadas da área de visualização
Usa `button` para identificar o botão premido ou libertado e `clientX` e `clientY` para ler a posição do evento do rato na área de visualização.
Versão: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxe
event.button
event.clientX
event.clientY
new MouseEvent(type, { button, buttons, clientX, clientY })button, clientX e clientY são propriedades só de leitura das instâncias de MouseEvent. Num manipulador de eventos, lê event.button, não MouseEvent.button. MouseEvent é uma API da Web, não faz parte do ECMAScript 2024. Se o ambiente não disponibilizar o construtor e o nome não estiver definido, new MouseEvent(...) lança um ReferenceError.
Em eventos como mousedown e mouseup, button identifica o botão premido ou libertado: 0 principal (normalmente o esquerdo), 1 auxiliar (normalmente o do meio), 2 secundário (normalmente o direito), 3 quarto (normalmente Recuar) e 4 quinto (normalmente Avançar). São papéis lógicos, não posições físicas fixas. Em mousemove, button === 0 não prova que o botão principal esteja premido. Usa a máscara de bits buttons: 0 significa que nenhum botão está premido e (event.buttons & 1) !== 0 testa o botão principal.
clientX e clientY são as coordenadas horizontal e vertical do evento, respetivamente, em píxeis CSS. O canto superior esquerdo da área de visualização (viewport) é (0, 0); X aumenta para a direita e Y para baixo. O deslocamento da página não altera essa origem, mas pode mudar as coordenadas de cliente do mesmo ponto do documento num evento posterior. pageX e pageY referem-se ao documento e screenX e screenY ao ecrã. As coordenadas de cliente não são relativas ao elemento alvo.
Usa new MouseEvent(type, options) para definir os valores iniciais de um evento sintético. Criar o objeto não despacha o evento nem move o ponteiro. O evento tem isTrusted === false e não concede ativação do utilizador.
Exemplos
<!doctype html>
<meta charset="utf-8">
<title>MouseEvent example</title>
<pre id="output"></pre>
<script>
{
const event = new MouseEvent("mouseup", {
button: 2,
buttons: 0,
clientX: 120,
clientY: 45,
});
document.getElementById("output").textContent =
`button=${event.button}, buttons=${event.buttons}, clientX=${event.clientX}, clientY=${event.clientY}`;
}
</script>Resultado
button=2, buttons=0, clientX=120, clientY=45
Guarda o exemplo num ficheiro HTML e abre-o num navegador. O `mouseup` sintético descreve a libertação do botão secundário em `(120, 45)`; `buttons=0` significa que não fica nenhum botão premido. Não é preciso clicar.
Lições relacionadas
- JavaScript · Lição 35 · Intermédio · Versão: 3