new Area(propsopt) → {Area}
Parameters:
Name | Type | Attributes | Description |
---|
props | Object |
<optional>
| Initialization of the description object using the given property bag. |
Returns:
the description object that was initialized.
-
Type
- Area
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
accessibilityName(valueopt) → {string|Description}
The label of the object (where no text label is available).
Parameters:
Name | Type | Attributes | Description |
---|
value | string |
<optional>
| When provided, this method acts as a setter and sets the accessibilityName value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored accessibilityName value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
alt(altopt) → {string|Description}
The image's tooltip text.
Parameters:
Name | Type | Attributes | Description |
---|
alt | string |
<optional>
| When provided, this method acts as a setter and sets the alt value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored alt value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
attributes(attributesopt) → {Object|Description}
The object's DOM attributes.
Parameters:
Name | Type | Attributes | Description |
---|
attributes | Object |
<optional>
| When provided, this method acts as a setter and sets the attributes value.
Specify the attribute names as object keys and set their values to the desired attribute values. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored attrs object;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- Object
|
Description
className(nameopt) → {string|Description}
The object's CSS class (className property).
Parameters:
Name | Type | Attributes | Description |
---|
name | string |
<optional>
| When provided, this method acts as a setter and sets the className value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored className value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
coords(coordsArropt) → {Array.<number>|Description}
The coordinates of the Area's vertices (points). in an image map.
The coordinate format is determined by the shape of the area, for example:
shape="rect" - x1,y1,x2,y2
shape="circle" - x,y,radius
shape="poly" - x1,y1,x2,y2,..,xn,yn
Parameters:
Name | Type | Attributes | Description |
---|
coordsArr | Array.<number> |
<optional>
| When provided, the coordinates of the Area's vertices (points) in an image map. |
Returns:
If no parameter is provided, the method acts as a getter and returns the coordinates of the Area's vertices (points) in an image map;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- Array.<number>
|
Description
css(selectoropt) → {string|Description}
The path to this object in CSS format. For example: tr.BPTRow input.
Parameters:
Name | Type | Attributes | Description |
---|
selector | string |
<optional>
| When provided, this method acts as a setter and sets the css value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored css value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
href(hrefopt) → {string|Description}
The location to which the browser navigates when the image is clicked.
Parameters:
Name | Type | Attributes | Description |
---|
href | string |
<optional>
| When provided, this method acts as a setter and sets the href value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored href value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
id(idopt) → {string|Description}
The object's HTML identifier.
Parameters:
Name | Type | Attributes | Description |
---|
id | string |
<optional>
| When provided, this method acts as a setter and sets the HTML id value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored HTML id value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
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
innerHTML(innerHTMLopt) → {string|Description}
The HTML code contained between the object's start and end tags.
Parameters:
Name | Type | Attributes | Description |
---|
innerHTML | string |
<optional>
| When provided, this method acts as a setter and sets the innerHTML value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored innerHTML value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
innerText(innerTextopt) → {string|Description}
The text contained between the object's start and end tags.
Parameters:
Name | Type | Attributes | Description |
---|
innerText | string |
<optional>
| When provided, this method acts as a setter and sets the innerText value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored innerText value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
isVisible(visibleopt) → {boolean|Description}
Indicates whether the object is visible.
Parameters:
Name | Type | Attributes | Description |
---|
visible | boolean |
<optional>
| When provided, this method acts as a setter and sets the isVisible value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isVisible value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- boolean
|
Description
location(locationopt) → {Point|Description}
The object's coordinates relative to the parent window (in pixels).
Parameters:
Name | Type | Attributes | Description |
---|
location | Point |
<optional>
| When provided, this method acts as a setter and sets the location value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- Point
|
Description
mapName(mapNameopt) → {string|Description}
The name of the map element that this image uses to define the area inside the image.
Parameters:
Name | Type | Attributes | Description |
---|
mapName | string |
<optional>
| When provided, the name of the map element that this image uses to define the area inside the image. |
Returns:
If no parameter is provided, the method acts as a getter and returns the name of the map element that this image uses to define the area inside the image;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
name(nameopt) → {string|Description}
The object's name property.
Parameters:
Name | Type | Attributes | Description |
---|
name | string |
<optional>
| When provided, this method acts as a setter and sets the name value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored name value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
outerHTML(outerHTMLopt) → {string|Description}
The object's HTML code and its content.
Parameters:
Name | Type | Attributes | Description |
---|
outerHTML | string |
<optional>
| When provided, this method acts as a setter and sets the outerHTML value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored outerHTML value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
outerText(outerTextopt) → {string|Description}
The object's text (supported in Internet Explorer only).
Parameters:
Name | Type | Attributes | Description |
---|
outerText | string |
<optional>
| When provided, this method acts as a setter and sets the outerText value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored outerText value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
role(roleValueopt) → {string|Description}
The defined role of this object. For example, if the role property is listbox, the object functions as a list box.
Parameters:
Name | Type | Attributes | Description |
---|
roleValue | string |
<optional>
| When provided, this method acts as a setter and sets the role value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored role value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
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
src(srcopt) → {string|Description}
The image source in URL format.
Parameters:
Name | Type | Attributes | Description |
---|
src | string |
<optional>
| When provided, this method acts as a setter and sets the src value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored src value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
styles(stylesopt) → {Object|Description}
The object's computed style.
Parameters:
Name | Type | Attributes | Description |
---|
styles | Object |
<optional>
| When provided, this method acts as a setter and sets the object by its computed style value.
* Specify the style names as object keys and set their values to the desired style values. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored styles object;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- Object
|
Description
tagName(tagopt) → {string|Description}
The object's HTML tag.
Parameters:
Name | Type | Attributes | Description |
---|
tag | string |
<optional>
| When provided, this method acts as a setter and sets the HTML tagName value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored HTML tagName value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
target(targetopt) → {string|Description}
The target frame of the navigation.
Parameters:
Name | Type | Attributes | Description |
---|
target | string |
<optional>
| When provided, this method acts as a setter and sets the target value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored target value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description
title(titleopt) → {string|Description}
The object's title.
Parameters:
Name | Type | Attributes | Description |
---|
title | string |
<optional>
| When provided, this method acts as a setter and sets the title 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
type(imageTypeopt) → {Web.ImageTypes|Description}
The image type.
Possible values: 'Normal', 'Button', 'ClientImageMap', 'ClientAndServerImageMap', 'ServerImageMap', 'Link'
Parameters:
Name | Type | Attributes | Description |
---|
imageType | Web.ImageTypes |
<optional>
| When provided, this method acts as a setter and sets the image type value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored image type value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- Web.ImageTypes
|
Description
vri(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 | Array.<Object> |
<optional>
| Array that contains multiple VRI definitions for this test object.
PropertiesName | Type | Attributes | Default | Description |
---|
anchor | Object | | | The related test object. | horizontal | Horizontal |
<optional>
| | The horizontal relation definition. | hInline | boolean |
<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. |
|
xpath(selectoropt) → {string|Description}
The path to this object in XPath format. For example: //TR[@id='LeanFT']/*\/INPUT
Parameters:
Name | Type | Attributes | Description |
---|
selector | string |
<optional>
| When provided, this method acts as a setter and sets the xpath value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored xpath value;
otherwise it returns 'this' for use with the builder pattern.
-
Type
- string
|
Description