Note: You are looking at a static snapshot of documentation related to Robot Framework automations. The most recent documentation is at https://robocorp.com/docs
RPA.Images
Crop an existing image.
Arguments
| Argument | Type | Default value |
|---|---|---|
| image | null | |
| region | null | |
| filename | None |
| param image: | Image to crop |
|---|---|
| param region: | Region to crop image to |
| param filename: | Save cropped image to filename |
Attempt to find the template from the given image.
Arguments
| Argument | Type | Default value |
|---|---|---|
| image | null | |
| template | null | |
| region | None | |
| limit | None | |
| tolerance | None |
| param image: | Path to image or Image instance, used to search from |
|---|---|
| param template: | Path to image or Image instance, used to search with |
| param limit: | Limit returned results to maximum of limit. |
| param region: | Area to search from. Can speed up search significantly. |
| param tolerance: | Tolerance for matching, value between 0.1 and 1.0 |
| return: | List of matching regions |
| raises ImageNotFoundError: | No match was found |
| raises ValueError: | Template is larger than search region |
Get the RGB value of a pixel in the image.
Arguments
| Argument | Type | Default value |
|---|---|---|
| image | null | |
| point | null |
| param image: | image to get pixel from |
|---|---|
| param point: | coordinates for pixel or Point object |
| return: | RGB value of pixel in image |
Draw a rectangle onto the image around the given region.
Arguments
| Argument | Type | Default value |
|---|---|---|
| image | null | |
| region | null | |
| color | red | |
| width | 5 |
| param image: | image to draw onto |
|---|---|
| param region: | coordinates for region or Region object |
| param color: | color of rectangle |
| param width: | line width of rectangle |
| return: | Image of the selected region |