The information in this topic may be out of date. The current SDK reference guide has moved here.

CheckSettings class

Platform: Selenium 4Language: 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.

Methods

accessibilityRegion(): Use to define an accessibility region and its type.

accessibilityRegions(): Define multiple accessibility regions and their types.

beforeRenderScreenshotHook(): Use this to supply a JavaScript snippet that should be executed on the Ultrafast Grid before the DOM is rendered.

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.

frame(): Select a frame that is a direct descendent of a frame selected previously in the chain.

fully(): 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.

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).

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.

layoutBreakpoints(): Configure the SDK to capture multiple DOM images for multiple viewport sizes.

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.

scrollRootElement(): 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.

sendDom(): Enable or disable sending DOM for this checkpoint.

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).

timeout(): Defines the timeout to use when acquiring and comparing screenshots for this target.

variationGroupId(): Set the variation group ID for this checkpoint.

visualGridOption(): Use this method to set configuration values for the Ultrafast Grid.

withName(): Assigns a name to the checkpoint.