Skip to main content
Docs
Go to the Studio
Roberty Studio
RPAImage Recognition

Find Image

Find Image

Looks for a specific image on the screen and returns its coordinates and dimensions if it is found. It allows you to check whether the element exists and to get its exact location for use in other actions.


Options​

Image path to be identified​

Enter the full path of the image file (reference screenshot) that the robot will look for on the screen.

Percentage of similarity​

Enter the minimum percentage of similarity for the recognition to be considered successful.

Waiting time​

Enter the maximum time in seconds that the robot will wait to locate the image on the screen.

Returns​

Javascript code​

js
actions["action-id"].exists // returns yes if the element is found (Boolean)
actions["action-id"].x // X coordinate of the found element (Number)
actions["action-id"].y // Y coordinate of the found element (Number)
actions["action-id"].width // width of the found element (Number)
actions["action-id"].height // height of the found element (Number)
actions["action-id"].centerX // X coordinate of the center of the found element (Number)
actions["action-id"].centerY // Y coordinate of the center of the found element (Number)

Field selection​

  • exists — returns yes if the element is found (Boolean)
  • x — X coordinate of the found element (Number)
  • y — Y coordinate of the found element (Number)
  • width — width of the found element (Number)
  • height — height of the found element (Number)
  • centerX — X coordinate of the center of the found element (Number)
  • centerY — Y coordinate of the center of the found element (Number)

Rules and Conditions​

  • The Image path to be identified field is required.
  • The reference image must be a screenshot of the element to be found.
  • The screen resolution and scale in the execution environment must be the same as the one used when the image was captured.
  • If the image is not found within the waiting time, the action raises an error and interrupts the flow.
  • The coordinates returned can be used in mouse actions to interact with the element found.