Screenshot APIs
Sahi's Screenshot APIs takes the screen/browser screen-shot while running the sahi scripts.
Take Screenshot
Section titled “Take Screenshot”Modes BrowserWindowsJavaAndroidiOSSAP
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.
Parameters
| Name | Type | Description |
|---|---|---|
$fileSysPath | stringoptional | file path to copy screenshot in file system. Relative path resolves relative to files folder of the current project. |
$noLog | booleanoptional | true to prevent embedding the image in the playback log. Default is false. |
$props | objectoptional | properties for image format(format) and image compression in precentage(resizePercentage) 1. format, string, optional, can be GIf, JPG or PNG Default is "sahi.screenshot.image.format" property defined in config/sahi.properties, this can be overridden in userdata/config/userdata.properties 2. resizePercentage, integer, optional Default is "sahi.screenshot.image.resize_percentage" property defined in config/sahi.properties, this can be override in userdata/config/userdata.properties 100 means no compression |
Raw script
_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});Sahi Pro Classic API _takeScreenShot
Take Screenshots
Section titled “Take Screenshots”Modes BrowserWindowsJavaAndroidiOSSAP
Takes a screen shot after every step and embeds the image in the playback log.
Parameters
| Name | Type | Description |
|---|---|---|
$enable | boolean | true for enabling screenshots, false to disable |
$directory | stringoptional | file path directory to copy screenshot in file system |
$noLog | booleanoptional | true to prevent embedding the image in the playback log. |
Raw script
_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.Sahi Pro Classic API _takeScreenShots
Take Page Screenshot
Section titled “Take Page Screenshot”Modes BrowserWindowsJavaAndroidiOSSAP
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.
Parameters
| Name | Type | Description |
|---|---|---|
$element | HTML DOM elementoptional | If specified, a full page screenshot of the element would be taken |
$fileSysPath | stringoptional | File system path to save a copy of the screenshot, additionally to. Relative paths will be resolved relative to files folder of the current project. Default is null. |
$noLog | booleanoptional | Pass true to prevent embedding the image in the playback log. Default is false. |
$props | objectoptional | Properties to specify for image delay, scrollLimit, trim, format and image compression in percentage(resizePercentage). 1. delay, integer, optional, time delay between scroll and screenshot in milliseconds. For long pages, the page is scrolled, individual screenshots are taken and then stitched. Sometimes images on the page may load slowly on scroll and a wait may be needed between scroll and screenshot. Default is 100 ms. 2. scrollLimit, integer, optional, height in pixels. Maximum scroll size in pixels for a page/element. Default is 200000. 3. trim, boolean, optional, Trim the image for blank space. Default is false. 4. format, string, optional, can be GIF, JPG or PNG Default is "sahi.screenshot.image.format" property defined in config/sahi.properties. This can be overridden in userdata/config/userdata.properties 5. resizePercentage, integer, optional Default is "sahi.screenshot.image.resize_percentage" property defined in config/sahi.properties. This can be overridden in userdata/config/userdata.properties. 100 means no compression. 6. mode, integer, optional Default is 1. Set to 2 only if element parameter is specified and element has scrollbar or element is inside a scrolled element. For Desktop Applications, only format and resizePercentage properties($props) are supported, other properties($props) are not. |
Raw script
_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 takenSahi Pro Classic API _takePageScreenShot
Skip Screenshots
Section titled “Skip Screenshots”Modes Browser
When enabled, actions namely Take Screenshot, Take Screenshots and Take Page Screenshot will be skipped. Capturing screenshot from Callback functions will also be skipped.
Parameters
| Name | Type | Description |
|---|---|---|
$enable | boolean | True to skip screenshots, false to disable. |
Raw script
// Skip capturing screenshots_skipScreenShots(true);
_focusWindow();_takeScreenShot(); // This will be skipped
// Enable capturing screenshots_skipScreenShots(false);// Now, screenshot APIs will not be skipped.Sahi Pro Classic API _skipScreenShots
Skip Screenshots Comparison
Section titled “Skip Screenshots Comparison”Modes Browser
When enabled, action Compare Images that compares screenshots will be skipped.
Parameters
| Name | Type | Description |
|---|---|---|
$enable | boolean | True to skip comparing screenshots, false to disable. |
Raw script
// Skip comparing screenshots_skipScreenShotsComparison(true);
_focusWindow();_takePageScreenShot(null, "D:/dev/images/login.png")
// Below line will be skippedvar $same = _compareImages("snapshot_login_page.png", "D:/dev/images/login.png");
// Enable comparing screenshots_skipScreenShotsComparison(false);Sahi Pro Classic API _skipScreenShotsComparison
Get Snap Shot
Section titled “Get Snap Shot”Modes BrowserWindowsJavaAndroidiOSSAP
This action is used when asserting screenshot. It captures the full page screen shot of the screen or the specified element. The captured screenshot should be used for assertion by comparing with a 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, Get Snap Shot will log failures to the playback log. The page screenshot, reference image and the differential image will be embedded in the playback log.
Parameters
| Name | Type | Description |
|---|---|---|
$element | HTML DOM elementoptional | If specified, a full page screenshot of the element would be compared with the reference image. If not, a full page screenshot of the webpage would be compared with the reference image. |
$differenceThreshold | floatoptional | If the difference between the reference image and the page screenshot is lesser than or equal to the differenceThreshold number, they are considered same. If not specified, a value of 20 is assumed. |
$displayOnSuccess | booleanoptional | When true, the page screenshot, reference image and the differential image will be embedded in the playback log, if the assertion succeeds. Default is false. Note that these images will always be embedded in case of assertion failure. |
$props | objectoptional | Properties to specify for image delay, scrollLimit, trim, format and image compression in percentage(resizePercentage). 1. delay, integer, optional, time delay between scroll and screenshot in milliseconds. For long pages, the page is scrolled, individual screenshots are taken and then stitched. Sometimes images on the page may load slowly on scroll and a wait may be needed between scroll and screenshot. Default is 100 ms. 2. scrollLimit, integer, optional, height in pixels. Maximum scroll size in pixels for a page/element. Default is 200000. 3. trim, boolean, optional, Trim the image for blank space. Default is false. 4. format, string, optional, can be GIF, JPG or PNG Default is "sahi.screenshot.image.format" property defined in config/sahi.properties. This can be overridden in userdata/config/userdata.properties 5. resizePercentage, integer, optional Default is "sahi.screenshot.image.resize_percentage" property defined in config/sahi.properties. This can be overridden in userdata/config/userdata.properties. 100 means no compression. 6. mode, integer, optional Default is 1. Set to 2 only if element attribute is specified and element has scrollbar. |
Returns
string | File path of the snapshot. Relative paths will be resolved relative to files folder of the current project. |
Raw script
_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 takenSahi Pro Classic API _assertSnapShot
Compare Images
Section titled “Compare Images”Modes BrowserWindowsJavaAndroidiOSSAP
Takes the path of the 2 images and checks if both images are same or not.
Parameters
| Name | Type | Description |
|---|---|---|
$f1 | string | File path of the first image. Relative paths will be resolved relative to files folder of the current project. |
$f2 | string | File path of the second image. Relative paths will be resolved relative to files folder of the current project. |
$differenceThreshold | floatoptional | If the difference between first and second image is lesser than or equal to the differenceThreshold number, they are considered to be same images. Default is 20. |
Returns
boolean | true if both images are same, else false |
Raw script
_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);Sahi Pro Classic API _compareImages
Configuring GraphicsMagick
Section titled “Configuring GraphicsMagick”To configure GraphicsMagick, follow the following steps.
Configure GM on Windows
Section titled “Configure GM on Windows”-
Download GraphicsMagick “GraphicsMagick-x.x.x-Qx-winxx-dll.exe” from GraphicsMagick windows
-
Install GraphicsMagick on your machine, say in
C:\GraphicsMagick\ -
Edit
sahi_pro\ext\imagetools\set_graphicsmagick.batand modify the contents to look like this:Terminal window set GM=C:\GraphicsMagick\gm
Configure GM on Linux
Section titled “Configure GM on Linux”-
Download GraphicsMagick “GraphicsMagick-x.x.xx-x.src.rpm” from GraphicsMagick linux
-
Install GraphicsMagick on your machine using apt/yum or your package manager. It would mostly install gm in
/usr/bin/(You can find the installed path by runningwhich gm) for more details Refer here. -
Edit
sahi_pro/ext/imagetools/set_graphicsmagick.shand modify the contents to look like this:Terminal window export GM=/usr/bin/gm
Configure GM on Mac
Section titled “Configure GM on Mac”-
Download GraphicsMagick “GraphicsMagick-x.x.xx-x.tar.gz” from GraphicsMagick Mac
-
Install GraphicsMagick on your machine using brew install graphicsmagick or your package manager. It would mostly install gm in
/usr/bin/(You can find the installed path by runningwhich gm) for more details Refer here. -
Edit
sahi_pro/ext/imagetools/set_graphicsmagick.shand modify the contents to look like this:Terminal window export GM=/usr/bin/gm
Skip Screenshots
Section titled “Skip Screenshots”Screenshot capturing can be skipped using Skip Screenshots action. With this, actions namely Take Screenshot, Take Screenshots and Take Page Screenshot will be skipped. Capturing screenshot from Callback functions will also be skipped.
Screenshot comparison can be skipped using Skip Screenshots Comparison action. With this, action Compare Images that compares screenshots will be skipped.
To skip screenshots in report on aborted, set property reports.skip_screenshots_on_aborted as true in userdata.properties file.
To skip screenshots in report on healed, set property reports.skip_screenshots_on_healed as true in userdata.properties file.

