Pular para o conteúdo principal
Acessar Studio
Desktop

Mouse

Mouse

O módulo Mouse é responsável por realizar todas as ações de mouse no computador do usuário.

js
await Mouse.click["v2_0_0"]({})
Informação adicional

O módulo mouse utiliza o conceito de coordenadas para realizar as ações. Veja como utilizar as coordenadas.

Métodos​

click​

Método responsável por realizar um clique com o mouse em uma posição determinada ou na posição atual do ponteiro.

js
await Mouse.click["v2_0_0"]({})

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Informação

Se nenhum parâmetro for passado, o método irá clicar na posição atual do ponteiro.

Parâmetros opcionais​

  • button: String - botão do mouse a ser utilizado. Valor padrão: left. Valores: left | right.
  • x: Integer - posição x do mouse na tela.
  • y: Integer - posição y do mouse na tela.

Retorno​

Este método não possui retorno.

doubleClick​

Método responsável por realizar um duplo clique com o mouse na posição atual do ponteiro.

js
await Mouse.doubleClick["v1_0_0"]({
  button: 'left'
})

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • button: String - botão do mouse a ser utilizado. Valor padrão: left. Valores: left | right.

Retorno​

Este método não possui retorno.

dragAndDrop​

Método responsável por realizar uma ação de arrastar e soltar com o mouse.

js
await Mouse.dragAndDrop["v2_0_0"]({
  initialX: 0,
  initialY: 0,
  finalX: 1920,
  finalY: 1080,
})

Parâmetros obrigatórios​

  • initialX: Integer - posição x inicial do arrastar.
  • initialY: Integer - posição y inicial do arrastar.
  • finalX: Integer - posição x final do soltar.
  • finalY: Integer - posição y final do soltar.

Parâmetros opcionais​

  • button: String - botão do mouse a ser utilizado. Valor padrão: left. Valores: left | right.

Retorno​

Este método não possui retorno.

move​

Método responsável por mover o ponteiro do mouse para uma posição absoluta na tela.

js
await Mouse.move["v2_0_0"]({
  x: 500,
  y: 400,
})

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • x: Integer - posição x para onde o ponteiro será movido. Valor padrão: 0.
  • y: Integer - posição y para onde o ponteiro será movido. Valor padrão: 0.

Retorno​

Este método não possui retorno.

moveRelative​

Método responsável por mover o ponteiro do mouse a partir de sua posição atual, utilizando deslocamento relativo.

js
await Mouse.moveRelative["v2_0_0"]({
  x: 100,
  y: 50,
  directionX: "right",
  directionY: "down"
})

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • x: Integer - quantidade de pixels a deslocar na horizontal. Valor padrão: 0.
  • y: Integer - quantidade de pixels a deslocar na vertical. Valor padrão: 0.
  • directionX: String - direção horizontal. Valor padrão: right. Valores: left | right.
  • directionY: String - direção vertical. Valor padrão: down. Valores: up | down.

Retorno​

Este método não possui retorno.

scroll​

Método responsável por realizar o movimento do scroll vertical do mouse.

js
await Mouse.scroll["v2_0_0"]({
  vertical: 300,
  directionV: "down"
})

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • vertical: Integer - quantidade de pixels a rolar. Valor padrão: 0.
  • directionV: String - direção da rolagem. Valor padrão: down. Valores: up | down.

Retorno​

Este método não possui retorno.