Skip to main content

Click image

Sophie avatar
Written by Sophie
Updated over 2 weeks ago

Definition and Usage

Locate the image in the selected area and perform a click. This command searches for a specific image on the screen or within a designated window and executes a mouse click action when the image is found.


Parameter Values

Input parameters

Parameter

Description

Possible Values

Required

Options / Notes

Search scope

Specify the scope to search for the target image

Entire screen, Specific window, Currently active window

Yes

Defines where the system will look for the image

Window

Select a window object that was obtained earlier

-

Only if "Specific window" is selected

This parameter appears only when "Specific window" is selected as the search scope

Select image

The image to locate on the screen or within the selected window

-

Yes

Use the Capture button to take a screenshot of the target image

Mouse button

Please select the mouse button to click

Left, Right

Yes

-

Click type

Choose whether to perform a single or double click

Click, Double click

Yes

-

Advanced settings

Parameter

Description

Possible Values

Required

Options / Notes

Cursor position

Select where the mouse cursor should point on the image

-

No

Default is center of the image

Horizontal offset (px)

Horizontal pixel offset from the selected cursor position

-

No

Use to fine-tune the click position

Vertical offset (px)

Vertical pixel offset from the selected cursor position

-

No

Use to fine-tune the click position

Match mode

Color matching uses full color comparison; grayscale matching compares grayscale images

Color matching, Grayscale matching

Yes

Grayscale matching is faster but less precise

Similarity (%)

Sets the similarity threshold for image matching

-

Yes

Recommended: 80%

Wait after execution

Wait time after executing command before running next command

-

No

Value in seconds

Timeout (s)

Set the maximum time to wait for the image to appear

-

Yes

Value in seconds

Error handling

Parameter Name

Description

Throw error & stop

When an error occurs, the action will trigger an error and stop the execution of the entire app.

Retry command

If an error occurs, the action will retry the command in an attempt to resolve the issue and continue the process.

Ignore error & continue

When an error occurs, the action will be ignored, and the workflow will continue without interruption.

Variables produced

This action doesn't produce any variables.


Using Variables in Conditions

Fields marked with {x} icon support variable insertion. You can use variables created in previous steps to dynamically set parameter values. For example, you can use variables to set custom timeout values or similarity thresholds based on different scenarios in your workflow.


Notes

  • The image matching is sensitive to screen resolution, color, and other visual elements. If the command fails to find the image, try adjusting the similarity percentage.

  • For more reliable image detection, capture images with distinctive features that are unlikely to change between executions.

  • Ensure the target image is visible on screen before execution; the command will wait until timeout if the image is not found.

  • The grayscale matching option is useful for images that might have slight color variations but maintain the same shape and pattern.

Did this answer your question?