Skip to main content
Version: 7.5.5

Image

It is possible to find an image element by following attributes:

NameParameter(s)TypeDescription
imagedataTestIdstringSearches for an image by value of a Pega data-test-id attribute, same as imageByTestId
imageByTestIddataTestIdstringSearches for an image by value of a Pega data-test-id attribute, same as image
imageByIdidstringSearches for an image by value of an id attribute
imageByattributeNamestringSearches for an image by an attribute name and value
attributeValuestring
imageBySourcesrcstringSearches for an image by value of src attribute

Assertions

Assertions include many methods for filtering by index because quite often readonly text fields have the same data-test-ids and it`s difficult to differentiate them.

NameParameter(s)TypeDescription
shouldBeVisibleoptions?{ timeout?: number, interval?: number, retries?: number }Checks if the element exists and visible
shouldBeVisibleByIndexindexnumberChecks if the element exists and visible by a given index
options?{ timeout?: number, interval?: number, retries?: number }
shouldExistoptions?{ timeout?: number, interval?: number, retries?: number }Checks if the element exists
shouldNotBeVisibleoptions?{ timeout?: number, interval?: number, retries?: number }Checks if the element exists but is not visible
shouldNotBeVisibleByIndexindexnumberChecks if the element exists but is not visible by a given index
options?{ timeout?: number, interval?: number, retries?: number }
shouldNotExistoptions?{ timeout?: number, interval?: number, retries?: number }Checks if the element does not exist

Wait for functions

Simple wait for visibility functions

NameParameter(s)TypeDescription
waitUntilVisibilityoptions?{ timeout?: number, interval?: number, retries?: number }Waits for the element to be visible
waitUntilInvisibilityoptions?{ timeout?: number, interval?: number, retries?: number }Waits for the element to be invisible
waitUntilElementExistsoptions?{ timeout?: number, interval?: number, retries?: number }Waits for the element to exist
waitUntilElementNotExistoptions?{ timeout?: number, interval?: number, retries?: number }Waits for the element not to exist

Complex wait for visibility functions

Allow filtering of available elements by index, text, attribute:

NameParameter(s)TypeDescription
waitUntilVisibilityByAttributeattributeNamestringFilters collection of elements by attribute and waits for the element to be visible
attributeValuestring
options?{ timeout?: number, interval?: number, retries?: number }
waitUntilVisibilityByIndexindexnumberFilters collection of elements by index and waits for the element to be visible
options?{ timeout?: number, interval?: number, retries?: number }
waitUntilInvisibilityByIndexindexnumberFilters collection of elements by index and waits for the element not to be visible
options?{ timeout?: number, interval?: number, retries?: number }

Actionability check

ActionabilityCheckTypes == attached | stable | visible | enabled | editable

NameParameter(s)TypeDescription
waitForSelectActionabilityCheckcheck types[]Waits for the element to pass all the selected actionability check types
isFilterByVisibilityboolean (true by default)

e.g.

await pega.image('Image').waitForSelectActionabilityCheck(['attached', 'visible', 'stable']);

IsVisible and IsExists functions

NameParameter(s)TypeDescription
isVisibleoptions?{ timeout?: number, interval?: number, retries?: number }Returns true if the element exists and is visible
isExistsoptions?{ timeout?: number, interval?: number, retries?: number }Returns true if the element exists
info

For the logo image, there is a specific logo control. However, it is still possible to use an image one instead.