Mouse

O módulo Mouse é responsável por realizar todas as ações de mouse no computador do usuário. Seus métodos podem ser acessados conforme o exemplo abaixo:

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

Informação adicional

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

Métodos

click

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

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 - espera uma string que referenciará o botão do mouse que será utilizado para realizar o clique, caso não seja passado, o valor padrão é left. Os valores possíveis são:
  • left: clique com o botão esquerdo do mouse.
  • right: clique com o botão direito do mouse.
• x: Integer - espera um inteiro que representa a posição x do mouse na tela. Se não for passado, o valor padrão é a posição atual do ponteiro.
• y: Integer - espera um inteiro que representa a posição y do mouse na tela. Se não for passado, o valor padrão é a posição atual do ponteiro.

Retorno

Este método não retorna valores.

dragAndDrop

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

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

Parâmetros obrigatórios

• initialX: Integer - espera um valor inteiro que representa a posição x que o mouse deve ser posicionado para iniciar o arrastar e soltar.
• initialY: Integer - espera um valor inteiro que representa a posição y que o mouse deve ser posicionado para iniciar o arrastar e soltar.
• finalX: Integer - espera um valor inteiro que representa a posição x que o mouse deve ser posicionado para finalizar o arrastar e soltar.
• finalY: Integer - espera um valor inteiro que representa a posição y que o mouse deve ser posicionado para finalizar o arrastar e soltar.

Parâmetros opcionais

• button: String - espera uma string que referenciará o botão do mouse que será utilizado para realizar a ação, caso não seja passado, o valor padrão é left. Os valores possíveis são:
  • left: clique com o botão esquerdo do mouse.
  • right: clique com o botão direito do mouse.
• velocity: Integer - espera um valor inteiro que representa a velocidade da ação em pixels por segundo.

Retorno

Este método não retorna valores.

move

Método responsável por realizar um movimentar o ponteiro do mouse em uma determinada posição.

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

Parâmetros obrigatórios

• x: Integer - espera um valor inteiro que representa a posição x que o ponteiro do mouse deve ser posicionado.
• y: Integer - espera um valor inteiro que representa a posição y que o ponteiro do mouse deve ser posicionado.

Parâmetros opcionais

Este método não possui parâmetros opcionais.

Retorno

Este método não retorna valores.

moveRelative

Método responsável por realizar o movimento do ponteiro a partir de sua posição atual. A posição atual do ponteiro será considerada como x = 0 e y = 0.

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

Parâmetros obrigatórios

• x: Integer - espera um valor inteiro que representa a posição x que o ponteiro do mouse deve ser posicionado.
• y: Integer - espera um valor inteiro que representa a posição y que o ponteiro do mouse deve ser posicionado.

Parâmetros opcionais

Este método não possui parâmetros opcionais.

Retorno

Este método não retorna valores.

scroll

Método responsável por realizar o movimento do scroll (rolagem) do mouse.

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

Parâmetros obrigatórios

• x: Integer - espera um valor inteiro que representa a quantidade de pixels que o scroll deve ser movido na direção x.
• y: Integer - espera um valor inteiro que representa a quantidade de pixels que o scroll deve ser movido na direção y.

Parâmetros opcionais

Este método não possui parâmetros opcionais.

Retorno

Este método não retorna valores.