Skip to main content

[Mobile] Take Area Screenshot

  • From version 7.9.0, this keyword is available.


  • Description: Take a screenshot of a specific area. The area should be inside the application viewport; otherwise, this keyword will fail.
  • Keyword name: takeAreaScreenshot
  • Keyword syntax:
    Mobile.takeAreaScreenshot(String fileName, Rectangle rect,
    List<TestObject> ignoredElements, Color hidingColor,
    FailureHandling flowControl)
  • Parameters:

    • Name: fileName

      • Description: Absolute path to the stored image file. fileName should contain '.png' as images are stored to the '.png' format. If the file name is not defined, the test engine will generate a random file name.
      • Parameter Type: String
      • Mandatory: Optional
    • Name: rect

      • Description: A rectangle definding the position and size of the area to be captured.
      • Parameter Type: Rectangle
      • Mandatory: Required
    • Name: ignoredElements

      • Description: List of the ignored elements. These elements will be hidden by drawing an overlap color layer. If the test engine failed to hide the element by any problems, this keyword would continue without impacting the result.
      • Parameter Type: List
      • Mandatory: Optional
    • Name: hidingColor

      • Description: The color used to draw the overlap layer. If not defined, Color.GRAY is used.
      • Parameter Type: Color
      • Mandatory: Optional
    • Name: flowControl

      • Description: Specify failure handling schema to determine whether the execution should be allowed to continue or stop.
      • STOPONFAILURE: throws a StepFailedException if the step failed (default).
      • CONTINUEONFAILURE: continues the test if the test failed, but the test result is still Failed.
      • OPTIONAL: continues the test and ignores the test result.
      • Parameter Type: FailureHandling
      • Mandatory: Optional
  • Return: a String representing the path to the captured image.

  • Throw: StepFailedException if the defined rectangle is outside the application viewport or Katalon Studio can't store the image in the disk.

  • Example:

// add import libs first
import org.openqa.selenium.Rectangle as Rectangle
import com.kms.katalon.core.configuration.RunConfiguration as RunConfiguration
// take sreenshot of an area start at (x: 0 , y: 0) with size (height: 1500, width: 1000) and store to report folder
Mobile.takeAreaScreenshot(RunConfiguration.getReportFolder() + '/area_screenshot.png', new Rectangle(0, 0, 1500, 1000), [findTestObject('hide_element_1'), findTestObject('hide_element_2')], Color.BLUE)