fully method

Class: WebdriverioCheckSettingsPlatform: WebdriverIO 5Language: JavaScript SDK:

Defines if the screenshot for this target should be extended to contain the entire element or region being checked, even if it extends the borders of the viewport.

Syntax


eyes.check(Target.window().fully(fully))
eyes.check(Target.window().fully())

Parameters

fully
Type:boolean [Optional ]
If this parameter has a value of true, then Eyes will use scrolling and stitching to capture the entire page. If it's false, then only the viewport will be captured. If the method is called without a parameter, then the default is true.

Return value

Type: WebdriverioCheckSettings
The value returned is the object that called the method. You can use it to call other methods supported by the object class.

Remarks

This method overrides the global default or the most recent value set by the Eyes.setForceFullPageScreenshot method or Configuration.setForceFullPageScreenshot method. If stitching is done, then the stitch mode used, StitchMode.CSS or StitchMode.SCROLL is determined by the global default or the value set using, Eyes.setStitchMode or Configuration.setStitchMode You can use the method WebdriverioCheckSettings.scrollRootElement to specify which element should be scrolled to render all of the content of the page. You may only specify one such element per checkpoint. You may only call this method once in a given target.