Saltar al contenido principal
Ir al Studio
Escritorio

Mouse

Mouse

El módulo Mouse es responsable de realizar todas las acciones de mouse en la computadora del usuario.

js
await Mouse.click["v2_0_0"]({})
Información adicional

El módulo mouse utiliza el concepto de coordenadas para realizar las acciones. Mira cómo utilizar las coordenadas.

Métodos​

click​

Método responsable de realizar un clic con el mouse en una posición determinada o en la posición actual del puntero.

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

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Información

Si no se pasa ningún parámetro, el método hará clic en la posición actual del puntero.

Parámetros opcionales​

  • button: String - botón del mouse que será utilizado. Valor predeterminado: left. Valores: left | right.
  • x: Integer - posición x del mouse en la pantalla.
  • y: Integer - posición y del mouse en la pantalla.

Retorno​

Este método no tiene retorno.

doubleClick​

Método responsable de realizar un doble clic con el mouse en la posición actual del puntero.

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

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • button: String - botón del mouse que será utilizado. Valor predeterminado: left. Valores: left | right.

Retorno​

Este método no tiene retorno.

dragAndDrop​

Método responsable de realizar una acción de arrastrar y soltar con el mouse.

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

Parámetros obligatorios​

  • initialX: Integer - posición x inicial del arrastre.
  • initialY: Integer - posición y inicial del arrastre.
  • finalX: Integer - posición x final al soltar.
  • finalY: Integer - posición y final al soltar.

Parámetros opcionales​

  • button: String - botón del mouse que será utilizado. Valor predeterminado: left. Valores: left | right.

Retorno​

Este método no tiene retorno.

move​

Método responsable de mover el puntero del mouse a una posición absoluta en la pantalla.

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

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • x: Integer - posición x hacia donde será movido el puntero. Valor predeterminado: 0.
  • y: Integer - posición y hacia donde será movido el puntero. Valor predeterminado: 0.

Retorno​

Este método no tiene retorno.

moveRelative​

Método responsable de mover el puntero del mouse a partir de su posición actual, utilizando desplazamiento relativo.

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

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • x: Integer - cantidad de píxeles a desplazar en horizontal. Valor predeterminado: 0.
  • y: Integer - cantidad de píxeles a desplazar en vertical. Valor predeterminado: 0.
  • directionX: String - dirección horizontal. Valor predeterminado: right. Valores: left | right.
  • directionY: String - dirección vertical. Valor predeterminado: down. Valores: up | down.

Retorno​

Este método no tiene retorno.

scroll​

Método responsable de realizar el movimiento del desplazamiento vertical del mouse.

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

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • vertical: Integer - cantidad de píxeles a desplazar. Valor predeterminado: 0.
  • directionV: String - dirección del desplazamiento. Valor predeterminado: down. Valores: up | down.

Retorno​

Este método no tiene retorno.