_takeScreenShot([$fileSysPath[, $noLog[, $props]]])

Sahi Pro Flowcharts Action :Take Screenshot

Details

Takes a screen shot and embeds the image in the playback log.
Since Sahi works without bringing the window into focus, we first need to call _focusWindow to bring the window into focus.

_focusWindow(); // bring window into focus
_takeScreenShot();
// captures screenshot in D:\dev\capture.jpg(compresses file size to 75% of the full size with jpg format)
// without embedding image in the playback log
_takeScreenShot("D:\\dev\\capture.jpg", true, {format:'jpg', resizePercentage:75});

_takeScreenShots($enable[, $directory[, $noLog]])

Sahi Pro Flowcharts Action :Take Screenshots

Details

Takes a screen shot after every step and embeds the image in the playback log.

_focusWindow(); // bring window into focus
// Enable screenshots
_takeScreenShots(true);
// perform actions
// screenshot will be taken after each step
// disable screenshots
_takeScreenShots(false);
// screenshots will not be taken now.

_takePageScreenShot([$element[, $fileSysPath[, $noLog[, $props]]]])

Sahi Pro Flowcharts Action :Take Page Screenshot

Details

info NOTE: API supports screenshot for elements with horizontal scrollbar also from Sahi Pro: 9.1.0..
info NOTE: Default value of trim is changed to false from Sahi Pro: 9.1.0. To make previous version scripts continue as it is, change sahi.screenshot.image.trim property to true in userdata.properties.
infoNOTE: Point number '6' in $props was added Since Sahi Pro: 6.2.1. For old document Refer here
info NOTE: For Desktop Applications, only format and resizePercentage properties($props) are supported, other properties($props) are not.

Takes a full page screenshot of a web page by scrolling to the end of the page and embeds the image in the playback log. If the element attribute is specified, a full page screenshot of the browser element is taken, instead of the web page. Since Sahi works without bringing the window into focus, we first need to call _focusWindow to bring the window into focus.

_focusWindow(); // Brings window into focus
_takePageScreenShot(); // Captures the full browser page screenshot
_takePageScreenShot(_table("t4")); // Captures the table screenshot

// Captures table screenshot with jpg format, compresses file size to 75% of the full size, saves it to D:\dev\capture.jpg
// without embedding image in the playback log
_takePageScreenShot(_table("t4"), "D:/dev/capture.jpg", true, {format:'jpg', resizePercentage:75});

// Captures full div screenshot by scrolling to the end of the div.
// Use it in cases where a div has its own scrollbar.
_call(_div("myDIV").scrollIntoView()); // scroll the div into view first
_takePageScreenShot(_div("myDIV"), null, null, {mode:2}); // the div itself will be scrolled and screen shots taken

_skipScreenShots($enable)

Sahi Pro Flowcharts Action :Skip Screenshots

Details

// Skip capturing screenshots
_skipScreenShots(true);

_focusWindow();
_takeScreenShot(); // This will be skipped

// Enable capturing screenshots
_skipScreenShots(false);
// Now, screenshot APIs will not be skipped.

_skipScreenShotsComparison($enable)

Sahi Pro Flowcharts Action :Skip Screenshots Comparison

Details

// Skip comparing screenshots
_skipScreenShotsComparison(true);

_focusWindow();
_takePageScreenShot(null, "D:/dev/images/login.png")

// Below line will be skipped
var $same = _compareImages("snapshot_login_page.png", "D:/dev/images/login.png");

// Enable comparing screenshots
_skipScreenShotsComparison(false);

_assertSnapShot($refPath[, $element[, $differenceThreshold[, $displayOnSuccess[, $props]]]])

Details

info NOTE: Default value of trim is changed to false from Sahi Pro: 9.1.0. To make previous version scripts continue as it is, change sahi.screenshot.image.trim property to true in userdata.properties.
infoNOTE: Point number '6' in $props was added Since Sahi Pro: 7.0.0. For old document Refer here

Takes the full page screen shot of the webpage or the browser element if specified, and compares with the reference image.
If the difference between the page screenshot and the reference image is lesser than or equal to the differenceThreshold, the images will be treated as same and the assertion is successful. Else the assertion is treated as a failure.
If the assertion is successful and displayOnSuccess is true, the page screenshot, reference image and the differential image will be embedded in the playback log.
If the assertion is a failure, _assertSnapShot will log failures to the playback log. The page screenshot, reference image and the differential image will be embedded in the playback log.

_navigateTo("http://sahi.co.in/demo/training");
_assertSnapShot("snapshot_login_page.png", _div(0), 20, true); // only _div(0) content would be compared with reference image.
// OR
_assertSnapShot("snapshot_login_page.png", null, 20, true); // passing null to compare with entire window screenshot
// OR
_assertSnapShot("snapshot_login_page.png",_div("myDIV"), 20, true, {mode:2}); // the div itself will be scrolled and screen shots taken

_compareImages($f1, $f2[, $differenceThreshold])

Sahi Pro Flowcharts Action :Compare Images

Details

Takes the path of the 2 images and checks if both images are same or not.

_navigateTo("http://sahi.co.in/demo/training");
_takePageScreenShot(null, "D:/dev/images/login.png")
var $same = _compareImages("snapshot_login_page.png", "D:/dev/images/login.png");
_assert($same);