To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

MenuTO

StdWin. MenuTO

MenuTO

Constructor

A Menu object

Members

displayName

Returns the object display name defined in the Application Model.

Methods

$(description) → {*}

Creates a child test object of this test object. This operation does not cause LeanFT to search for the object in the AUT. LeanFT interacts with the application only when a step runs that performs an operation on the AUT object.
Parameters:
Name Type Description
description The description of the test object. Can be a full test object description or a string. If a string is provided, it is interpreted as a CSS selector with a default test object type of WebElement.
Returns:
the new child test object with the provided description.
Type
*

$$(description, dontFilterByTypeopt) → {Promise.<Array.<TestObject>>}

Returns all child objects of this object that match the supplied test object description.
Parameters:
Name Type Attributes Default Description
description A description object that defines the test object type and the set of properties and values that should be common to all objects that are returned.
dontFilterByType bool <optional>
false Set this parameter to true to avoid limiting the returned objects to a specific test object type.
Returns:
an array of test objects that match the supplied description.
Type
Promise.<Array.<TestObject>>

buildMenuPath(…menuPathParts) → {string}

Creates the path of the specified menu item.
Parameters:
Name Type Attributes Description
menuPathParts Number | string <repeatable>
The menu path can comprise: logical name(string), full path(string), or numeric 1-based index(int).
Returns:
the path of the specified menu item.
Type
string

description() → {*}

Returns the description for this test object.
Returns:
the description for this test object.
Type
*

exists(timeoutopt) → {Promise.<bool>}

Checks whether this object exists in the AUT.
Parameters:
Name Type Attributes Description
timeout Number <optional>
The time (in seconds) to wait for this object before returning a result of true or false.
By default, uses the object synchronization timeout defined in the runtime engine settings.
Returns:
an indication of whether the object exists.
Type
Promise.<bool>

getItem(path) → {MenuItem}

Creates a menu item from its given path.
Parameters:
Name Type Description
path string The path of the menu item.
Returns:
the MenuItem object. See StdWin.MenuItem
Type
MenuItem

highlightMatches(description, dontFilterByTypeopt) → {Promise.<Number>}

Highlights all children that match the supplied test object description.
Parameters:
Name Type Attributes Default Description
description A description object that defines the test object type and the set of properties and values that should be common to all objects that are highlighted.
dontFilterByType bool <optional>
false Set this parameter to true to avoid limiting the highlighted objects to a specific test object type.
Returns:
the number of matches that are found and highlighted.
Type
Promise.<Number>

parent() → {*}

Returns the parent test object of this test object.
Returns:
the parent test object of this test object.
Type
*

select(menuItem) → {Promise.<void>}

Selects a menu item.
Parameters:
Name Type Description
menuItem MenuItem | string The item to be selected. The input can be the menu item, or the menu path. Use the getItem method to get MenuItem to be used as the argument for this method. Use the buildMenuPath method to build the item path string to be used as the argument for this method.
Returns:
a promise that is fulfilled when the select operation ends.
Type
Promise.<void>

type() → {Promise.<StdWin.MenuType>}

Gets the type of menu.
Returns:
the type of the menu.
Type
Promise.<StdWin.MenuType>

verifyImageExists(imageToFind, similarityopt) → {Promise.<object>}

Checks whether a snapshot of this object contains the supplied image.
Parameters:
Name Type Attributes Description
imageToFind String A Base64 string representation of the image to look for within the test object's snapshot.
similarity Number <optional>
The minimum similarity between the two images (as a percentage), above which the find is considered a match. Default = 100.
Returns:
a promise that is fulfilled with an object representing the point where the image was located, or null if it was not found.
Type
Promise.<object>

verifyImageMatch(expectedImage, maskAreaImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<Boolean>}

Checks whether a snapshot of this object and the supplied image are a match.
Parameters:
Name Type Attributes Description
expectedImage String A Base64 string representation of the image to compare to the test object snapshot.
maskAreaImage String A Base64 string representation of the image mask area to use in the image comparison.
pixelTolerance Number <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerance Number <optional>
The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.
Returns:
a Boolean representing the comparison result.
Type
Promise.<Boolean>