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.

Page

Web. Page

new Page(propsopt) → {Page}

The description of a Web Page test object.
Parameters:
Name Type Attributes Description
props Object <optional>
Initializes the description using the supplied property bag.
Returns:
the description object that was initialized.
Type
Page

Methods

absoluteLocation(locationopt) → {Point|Description}

The object's absolute coordinates relative to the screen (in pixels). 0,0 is always the top-left corner of the (primary) monitor.
Parameters:
Name Type Attributes Description
location Point <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

index(valueopt) → {Number|Description}

The 0-based index of this object, relative to all other objects with an otherwise identical description.
Parameters:
Name Type Attributes Description
value Number <optional>
When provided, this method acts as a setter and sets the index to the specified value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored index; otherwise it returns 'this' for use with the builder pattern.
Type
Number | Description

size(sizeopt) → {Size|Description}

The object's size (in pixels).
Parameters:
Name Type Attributes Description
size Size <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

text(textopt) → {string|Description}

The inner text of the body element.
Parameters:
Name Type Attributes Description
text string <optional>
When provided, this method acts as a setter and sets the text value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

title(titleopt) → {string|Description}

The browser's title.
Parameters:
Name Type Attributes Description
title string <optional>
When provided, this method acts as a setter and sets the title to the specified value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored title value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

url(urlopt) → {string|Description}

The URL of the HTML page.
Parameters:
Name Type Attributes Description
url string <optional>
When provided, this method acts as a setter and sets the URL value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored URL value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

vri(valueopt, valueopt)

Sets a VisualRelation definition.
The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
Parameters:
Name Type Attributes Description
value Object <optional>
The object containing the VRI definition for this object.
Properties
Name Type Attributes Default Description
anchor Object The related test object.
horizontal Horizontal <optional>
The horizontal relation definition.
hInline bool <optional>
false The horizontal inline definition.
vertical Vertical <optional>
The vertical relation definition.
vInline string <optional>
false The vertical inline definition.
proximity Proximity <optional>
The proximity relation definition.
value Array <optional>
Array that contains multiple VRI definition for this object.