Quick Reference: Eggplant Functional Functions
Function |
Returns |
The color of the pixel at a given location (Default: RGB value) |
|
A connection property list |
|
The version number of your copy of Eggplant Functional |
|
The hot spot location of every occurrence of the given image or images |
|
Rectangle coordinates of every occurrence of the given image or images |
|
An image property list for the last image found |
|
The location of the last image found |
|
(Deprecated. See foundImageInfo().) Name of the last image found. |
|
The position of the last image found, within a series of given images |
|
The value of a given global property |
|
The values of all Run Option global properties or given global properties |
|
The color of the pixel at a given location within an image (Default: RGB value) |
|
Whether a given image is found; True or false |
|
The location of the hot spot in the given image |
|
An image property list for the given image |
|
The hot spot location of the first occurrence of the given image or images |
|
The rectangle coordinates of the first occurrence of the given image or images |
|
An image width and height in pixels |
|
A list of connection property lists for every SUT in the Connection List |
|
Coordinates of the current mouse cursor location |
|
A list of all suites available to the current script |
|
ReadCharacters | Returns a character from a character collection as a string or multiline string |
The table data found within a given rectangle on the SUT |
|
Uses OCR to read the text content found within a given rectangle on the SUT |
|
Contents of the SUT clipboard |
|
RemoteMonitorCount Function | Returns the number of monitors associated with the current RDP connection |
RemoteMonitorRectangle Function | Returns the size of the specified monitor |
RemoteMonitorSize Function | Returns the rectangle of the specified monitor |
The coordinates of a rectangle the size of the entire Viewer window |
|
The width and height of the Viewer window in pixels |
|
Whether or not the current script run was called in a command line |
|
A results property list for every run of the given (or current) script |
|
A property list of information about the given suite (or current suite) |
Deprecated Functions
Functions in the following table are deprecated and no longer supported; if an updated command or method is available, it is noted in the description.
Function |
Behavior and Alternatives |
ADBCall | Executes ADB calls to available Android devices and returns any output. Instead, use the equivalent ADBCallRemote function. |
FoundImageName | Returns the name of the last image found. Instead, use the FoundImageInfo function, which returns the imageName or imagePath as a parameter. |