Skip to content
Sahi Pro Flowcharts is retired. These pages document the last release (v12) and are no longer updated. Go to the current documentation.Flowcharts is retired. Current docs
Get Free Trial
Sahi Pro Flowcharts is retired. These pages document the last release (v12) and are no longer updated. Go to the current documentation.

Visual Assist APIs

Visual Assist automation is supported since Sahi Pro Visual Assist Engine.

Modes BrowserWindowsAndroidiOSVisual Assist

This action will get the string array of visible text present in the element using Optical Character Recognition Technology of Visual Assist.

Parameters

NameTypeDescription
$elementHTML DOM elementElement whose text we need using Visual Assist
$levelstringoptionalSpecifies the iterator level for identifying a text. can be 'word', 'line' or 'para'. Default, value is set as 'word' in "sahi.visual_assist.text.iterator.level" property.
$zoomLevelintegeroptionalIf a text appears too small on the screen, an internal zoom would be necessary to identify such a text. This argument specifies the internal zoom percentage. Default value is 300.

Returns

array of stringsArray of visible text content in the element using Visual Assist
Raw script
$message = _getVisualText(_group("message-pane-layout"));
_assertEqual("Success", $message[0]);
// using the 2nd argument as line. This gets string array where each element of the array is a line
$message = _getVisualText(_group("message-pane-layout"), "line");
// using the 3rd argument zoomlevel when the text on the screen is too small
$message = _getVisualText(_group("message-pane-layout"), "word", 400);

Sahi Pro Classic API _getVisualText