[WebUI] Take Area Screenshot

Description

Take screenshot of a specific area in the viewport. The captured image will be saved in .png format.

Keyword name: takeAreaScreenshot

Note:

From version 7.7.0, this keyword is available.

Parameters

Parameter	Parameter Type	Required	Description
fileName	String	Optional	Represents the path to the saved image. The path can be absolute path or relative path.
rect	Rectangle	Yes	Defines location and size of the area you want to take screenshot. The area must be within the viewport.
flowControl	FailureHandling	Optional	Specify failure handling schema to determine whether the execution should be allowed to continue or stop.

Example

• Description: Take screenshot of a specific area in the viewport. The captured image will be saved in '.png' format.
• Keyword name: takeAreaScreenshot
• Keyword syntax: WebUI.takeAreaScreenshot(fileName, rect, flowControl)

• Parameters:

  • Name: fileName

    • Description: A String that represents the path to the saved image. The path can be absolute path or relative path.
    • Parameter Type: String
    • Mandatory: Optional

  • Name: rect

    • Description: A Rectangle which defines location and size of the area you want to take screenshot. The area must be within the viewport.
    • Parameter Type: Rectangle
    • Mandatory: Required

  • Name: flowControl

    • Description: Specify failure handling schema to determine whether the execution should be allowed to continue or stop.
    • Parameter Type: FailureHandling
    • Mandatory: Optional

• Examples:

You want to take a screenshot of an area at x: 50, y: 25, width: 100, height: 150 and save the 'advertisements.png' file in the current project's report folder:

import org.openqa.selenium.Rectangle as Rectangle
import com.kms.katalon.core.configuration.RunConfiguration as RunConfiguration

WebUI.takeAreaScreenshot(RunConfiguration.getReportFolder() + '/advertisements.png', new Rectangle(50, 25, 100, 150))

You want to take a screenshot of an area at x: 50, y: 25, width: 100, height: 150 and use the default file name:

import org.openqa.selenium.Rectangle as Rectangle

WebUI.takeAreaScreenshot(new Rectangle(50, 25, 150, 100))

You want to take a screenshot of an area at x: 50, y: 25, width: 100, height: 150 and save it somewhere else:

import org.openqa.selenium.Rectangle as Rectangle

WebUI.takeAreaScreenshot('E:\\area.png', new Rectangle(50, 25, 150, 100)