1"use strict";(self.webpackChunkKatalon_Docs=self.webpackChunkKatalon_Docs||[]).push([[12785],{19975:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>_,contentTitle:()=>d,default:()=>l,frontMatter:()=>o,metadata:()=>n,toc:()=>r});const n=JSON.parse('{"id":"keywords/keyword-description-in-katalon-studio/visual-based-web-testing-keywords/webui-take-full-page-screenshot-as-checkpoint","title":"[WebUI] Take Full Page Screenshot as Checkpoint","description":"Description","source":"@site/docs/katalon-studio/keywords/keyword-description-in-katalon-studio/visual-based-web-testing-keywords/webui-take-full-page-screenshot-as-checkpoint.md","sourceDirName":"keywords/keyword-description-in-katalon-studio/visual-based-web-testing-keywords","slug":"/keywords/keyword-description-in-katalon-studio/visual-based-web-testing-keywords/webui-take-full-page-screenshot-as-checkpoint","permalink":"/katalon-studio/keywords/keyword-description-in-katalon-studio/visual-based-web-testing-keywords/webui-take-full-page-screenshot-as-checkpoint","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1764053770000,"frontMatter":{"title":"[WebUI] Take Full Page Screenshot as Checkpoint"},"sidebar":"katalon-studio","previous":{"title":"[WebUI] Take Element Screenshot as Checkpoint","permalink":"/katalon-studio/keywords/keyword-description-in-katalon-studio/visual-based-web-testing-keywords/webui-take-element-screenshot-as-checkpoint"},"next":{"title":"[WebUI] Take Screenshot as a Checkpoint","permalink":"/katalon-studio/keywords/keyword-description-in-katalon-studio/visual-based-web-testing-keywords/webui-take-a-screenshot-as-checkpoint"}}');var a=s(74848),i=s(28453);const o={title:"[WebUI] Take Full Page Screenshot as Checkpoint"},d=void 0,_={},r=[{value:"Description",id:"description",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Example",id:"example",level:2}];function c(e){const t={h2:"h2",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h2,{id:"description",children:"Description"}),"\n",(0,a.jsxs)("div",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,a.jsxs)("div",{className:"note note note_note",children:[(0,a.jsx)("span",{className:"note__title",children:"Note:"}),"\n",(0,a.jsx)("ul",{className:"ul",children:(0,a.jsx)("li",{className:"li",children:"If this method is used with the ignored elements, JavaScript is required to be enabled on test browser. The method used to take an entire-page screenshot is simulating a scroll action to the end of the page. If the web page uses infinity-scrolling, it's not recommended to use this keyword."})}),"\n"]})," Take an entire-page screenshot to send to TestOps Vision. The captured image will be saved in '.png' format and stored in the 'keyes' folder in the report folder. This method simulates a scroll action, takes a numbers of shots, then merges them together to make a full-page screenshot. "]}),"\n",(0,a.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["Keyword name: ",(0,a.jsx)("code",{className:"ph codeph",children:"takeFullPageScreenshotAsCheckpoint"})]}),"\n",(0,a.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)("table",{xmlns:"http://www.w3.org/1999/xhtml",className:"table anchor_top_offset",id:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5",children:[(0,a.jsx)("caption",{}),(0,a.jsxs)("colgroup",{children:[(0,a.jsx)("col",{style:{width:"20%"}}),(0,a.jsx)("col",{style:{width:"20%"}}),(0,a.jsx)("col",{style:{width:"20%"}}),(0,a.jsx)("col",{style:{width:"40%"}})]}),(0,a.jsx)("thead",{className:"thead",children:(0,a.jsxs)("tr",{className:!0,children:[(0,a.jsx)("th",{className:"entry anchor_top_offset",id:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1",children:"Parameter "}),(0,a.jsx)("th",{className:"entry anchor_top_offset",id:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2",children:"Parameter Type"}),(0,a.jsx)("th",{className:"entry anchor_top_offset",id:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3",children:"Required"}),(0,a.jsx)("th",{className:"entry anchor_top_offset",id:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4",children:"Description"})]})}),(0,a.jsxs)("tbody",{className:"tbody",children:[(0,a.jsxs)("tr",{className:!0,children:[(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",rowSpan:1,colSpan:1,children:"checkpointName"}),(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",rowSpan:1,colSpan:1,children:"String"}),(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",rowSpan:1,colSpan:1,children:"Yes"}),(0,a.jsxs)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",rowSpan:1,colSpan:1,children:["Represents the name of the image on TestOps Vision. On local machine, this name will be appended with TestOps Vision prefix (",(0,a.jsx)("code",{className:"ph codeph",children:"keyes-"}),")."]})]}),(0,a.jsxs)("tr",{className:!0,children:[(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",children:"ignoredElements"}),(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",children:"List"}),(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",children:"Optional"}),(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",children:"List of Test Objects you want to hide when taking a screenshot."})]}),(0,a.jsxs)("tr",{className:!0,children:[(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",children:"flowControl"}),(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",children:"FailureHandling"}),(0,a.jsx)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",children:"Optional"}),(0,a.jsxs)("td",{className:"entry",headers:"topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__1 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__2 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__3 topic-6838__3fb5479a-067e-4088-8d6e-7410113d8ee5__entry__4 ",children:["Specify ",(0,a.jsx)("a",{className:"xref",href:"/katalon-studio/maintain-tests/configure-failure-handling-settings-in-katalon-studio",children:"failure handling "}),"schema to determine whether the execution should be allowed to continue or stop."]})]})]})]}),"\n",(0,a.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,a.jsxs)("ul",{xmlns:"http://www.w3.org/1999/xhtml",className:"ul",children:[(0,a.jsx)("li",{className:"li",children:(0,a.jsxs)("div",{className:"p",children:[" You want to take a full-page screenshot as TestOps Vision checkpoint named ",(0,a.jsx)("code",{className:"ph codeph",children:"full-page"})," and use default ",(0,a.jsx)("a",{className:"xref",href:"/katalon-studio/maintain-tests/configure-failure-handling-settings-in-katalon-studio",children:"failure handling"}),": ",(0,a.jsx)("pre",{className:"pre codeblock",children:(0,a.jsx)("code",{children:"WebUI.takeFullPageScreenshotAsCheckpoint('current_viewport')"})})," "]})}),(0,a.jsx)("li",{className:"li",children:(0,a.jsxs)("div",{className:"p",children:["You want to take a full-page screenshot as TestOps Vision checkpoint named ",(0,a.jsx)("code",{className:"ph codeph",children:"full_view_no_logo"})," and hide some web elements: ",(0,a.jsx)("pre",{className:"pre codeblock",children:(0,a.jsxs)("code",{children:["import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject","\n","\n","WebUI.takeFullPageScreenshotAsCheckpoint('full_view_no_elements', [findTestObject('UI/logo')])ebUI.takeFullPageScreenshotAsCheckpoint('current_viewport')"]})})]})}),(0,a.jsx)("li",{className:"li",children:(0,a.jsxs)("div",{className:"p",children:["You want to take a full-page screenshot as TestOps Vision checkpoint named ",(0,a.jsx)("code",{className:"ph codeph",children:"full_view_no_elements"})," and hide some web elements defined in a variable named ",(0,a.jsx)("code",{className:"ph codeph",children:"ignoredElements"}),": ",(0,a.jsx)("pre",{className:"pre codeblock",children:(0,a.jsx)("code",{children:"// where ignoredElements is a user-defined List-typed variable. WebUI.takeFullPageScreenshotAsCheckpoint('full_view_no_elements', ignoredElements)"})})]})})]})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>d});var n=s(96540);const a={},i=n.createContext(a);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.