Methods

• Keyboard
  • Keys
  • setKeyboardDelay
  • keyTap
  • keyToggle
  • typeString
  • typeStringDelayed
• Mouse
  • setMouseDelay
  • moveMouse
  • moveMouseSmooth
  • mouseClick
  • mouseToggle
  • dragMouse
  • getMousePos
  • scrollMouse
• Screen
  • getPixelColor
  • getScreenSize
  • screen.capture
• Bitmap
  • Properties
  • colorAt

Keyboard

Keys

keyToggle and keyTap support for following keys.

Note: The names of the letter and number keys are the same as that single letter or digit. For example: b is the “b” key and 5 is the “5” key.

Up to date as of v0.4.4.

setKeyboardDelay(ms)

Sets the delay in milliseconds to sleep after a keyboard event. This is 10ms by default.

Arguments

keyTap(key, [modifier])

Press a single key.

Arguments

keyToggle(key, down, [modifier])

Hold down or release a key.

Arguments

typeString(string)

Arguments

typeStringDelayed(string, cpm)

Arguments

Mouse

setMouseDelay(ms)

Sets the delay in milliseconds to sleep after a mouse event. This is 10ms by default.

Arguments

moveMouse(x, y)

Moves mouse to x, y instantly, with the mouse button up.

Arguments

Examples

var robot = require("robotjs");

//Move the mouse to 100, 100 on the screen.
robot.moveMouse(100, 100);

moveMouseSmooth(x, y)

Moves mouse to x, y human like, with the mouse button up.

Arguments

mouseClick([button], [double])

Clicks the mouse.

Arguments

Examples

var robot = require("robotjs");

robot.mouseClick();

mouseToggle([down], [button])

Toggles mouse button.

Arguments

Examples

var robot = require("robotjs");

robot.mouseToggle("down");

setTimeout(function()
{
    robot.mouseToggle("up");

}, 2000);

dragMouse(x, y)

Moves mouse to x, y instantly, with the mouse button held down.

Arguments

Examples

var robot = require("robotjs");

//Mouse down at 0, 0 and then drag to 100, 100 and release.
robot.moveMouse(0, 0);
robot.mouseToggle("down");
robot.dragMouse(100, 100);
robot.mouseToggle("up");

getMousePos()

Gets the mouse coordinates.

Return

Returns an object with keys x and y.

Examples

var robot = require("robotjs");

var mouse = robot.getMousePos();
console.log("Mouse is at x:" + mouse.x + " y:" + mouse.y);

scrollMouse(x, y)

Scrolls the mouse in any direction.

Arguments

Examples

var robot = require("robotjs");

robot.scrollMouse(50, 0);

setTimeout(function()
{
    robot.scrollMouse(50, 0);
}, 2000);

Screen

getPixelColor(x, y)

Gets the pixel color at x, y. This function is perfect for getting a pixel or two, but if you’ll be reading large portions of the screen use screen.capture.

Arguments

Return

Returns the hex color code of the pixel at x, y.

getScreenSize()

Gets the screen width and height.

Return

Returns an object with .width and .height.

screen.capture([x], [y], [width], [height])

Gets part or all of the screen.

Arguments

If no arguments are provided, screen.capture will get the full screen.

Return

Returns a bitmap object.

Examples

For higher density screens (Macs) the resulting screen capture could be larger than the area requested. You can work around this by dividing the image size by the requested size. For example:

var size = 10;
var img = robot.screen.capture(0, 0, size, size);
// Support for higher density screens.
var multi = img.width / size;
// Get color at 2, 3.
var color = img.colorAt(2 * multi, 3 * multi);

Bitmap

This is an object returned by screen.capture.

Properties

colorAt

Gets the pixel color at x, y of a bitmap.

Arguments

Return

Returns the hex color code of the pixel at x, y.

Examples

var robot = require("robotjs");

//Get a 100x100 screen capture starting at 0, 0.
var img = robot.screen.capture(0, 0, 100, 100);

console.log(img.width)

//Get pixel color at 50, 50.
var hex = img.colorAt(50, 50);
console.log(hex);

• Getting Started
• Examples
• Syntax
• Building
• FAQ
• Electron