ImagesCheckSettings class

Platform: ImagesLanguage: JavaScript SDK:
The methods in this class are used as part of the check Fluent API to configure and execute checkpoints.
To use these methods, first create a target object using a method from the Target class, then call one or more of the methods in this class on the returned object, chaining them one after the other using the '.' operator.

Require statement

const {ImagesCheckSettings} = require('@applitools/eyes-images');
	

Methods

accessibilityRegion()
Use to define an accessibility region and its type.
content()
If called without parameters, sets the match level for this target to . Otherwise, defines that a match level of Content should be used for the regions passed as a parameters.
contentRegions()
Defines that a match level of Content should be used for the region(s) passed as parameter(s).
exact()
Sets the match level for this target to Exact.
floatingRegion()
Add one more floating region to this target.
floatingRegions()
Define multiple floating regions for this target.
ignore()
Add one or more ignore regions to this target (i.e. areas whose content matches anything).
ignoreCaret()
Use this method to tell Eyes that for this target it should detect mismatch artifacts caused by a blinking cursor and not report them as mismatches.
ignoreDisplacements()
Sets whether Test Manager should intially display mismatches for image features that have only been displaced, as opposed to real mismatches.
ignoreRegions()
Add one or more ignore regions to this target (i.e. areas whose content matches anything).
imageSize()
Provide the dimensions of the image defined using Target.url method.
layout()
If called without parameters, sets the match level for this target to Layout. Otherwise, defines that a match level of Layout should be used for the regions passed as parameters.
layoutRegions()
Defines that a match level of Layout should be used for the region(s) passed as parameter(s).
matchLevel()
Use this method to set the default match level (the type of matching) to use for this target when matching the captured image to the baseline image.
region()
Requests that only a region within a selected i-frame should be matched.
strict()
If called without parameters, sets the match level for this target to Strict. Otherwise, defines that a match level of Strict should be used for the regions passed as a parameters.
strictRegions()
Defines that a match level of Strict should be used for the region(s) passed as parameter(s).
withName()
Assigns a name to the checkpoint.