CheckSettingsPlain class

Platform: Selenium 4Language: JavaScript SDK:
The methods in this type 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 type on the returned object, chaining them one after the other using the '.' operator.

Properties

accessibilityRegionsType:({region:RegionPlain|WebElement|Selector;type?:AccessibilityRegionTypePlain}|RegionPlain|WebElement|Selector)[]
Define multiple accessibility regions and their types.
contentRegionsType:(RegionPlain|WebElement|Selector)[]
Defines that a match level of Content should be used for the region(s) passed as parameter(s).
floatingRegionsType:({region:RegionPlain|WebElement|Selector;maxUpOffset?:number;maxDownOffset?:number;maxLeftOffset?:number;maxRightOffset?:number;}|RegionPlain|WebElement|Selector)[]
Define multiple floating regions for this target.
framesType:({frame:WebElement|Selector|string|number;scrollRootElement?:WebElement|Selector}|WebElement|Selector|string|number)[]
Define the full frame hierarchy to the direct parent frame of the HTML element to be checked.
fullyType:boolean
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.
ignoreCaretType:boolean
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.
ignoreDisplacementsType:boolean
Sets whether Test Manager should intially display mismatches for image features that have only been displaced, as opposed to real mismatches.
ignoreRegionsType:(RegionPlain|WebElement|Selector)[]
Add one or more ignore regions to this target (i.e. areas whose content matches anything).
layoutBreakpointsType:boolean|number[]
Configure the SDK to capture multiple DOM images for multiple viewport sizes.
layoutRegionsType:(RegionPlain|WebElement|Selector)[]
Defines that a match level of Layout should be used for the region(s) passed as parameter(s).
matchLevelType:MatchLevelPlain
Use this property to set and retrieve the default match level (the type of matching) to use for this target when matching the captured image to the baseline image.
nameType:string
Assigns a name to the checkpoint.
regionType:RegionPlain|WebElement|Selector
Requests that only a region within a selected i-frame should be matched.
scrollRootElementType:WebElement|Selector
Normally, Eyes will select the most appropriate element to scroll to execute the fully method. You can use the scrollRootElement method to specify the element to scroll explicitly.
sendDomType:boolean
Enable or disable sending DOM for this checkpoint.
strictRegionsType:(RegionPlain|WebElement|Selector)[]
Defines that a match level of Strict should be used for the region(s) passed as parameter(s).
timeoutType:number
Defines the timeout to use when acquiring and comparing screenshots for this target.
variationGroupIdType:string
Set the variation group ID for this checkpoint.
visualGridOptionsType:{[key:string]:any}
Use this property to set and retrieve configuration values for the Ultrafast Grid.