Package com.applitools.eyes.playwright.fluent

Class PlaywrightCheckSettings

java.lang.Object

com.applitools.eyes.fluent.CheckSettings

com.applitools.eyes.playwright.fluent.PlaywrightCheckSettings

All Implemented Interfaces:

com.applitools.eyes.fluent.ICheckSettingsInternal, IPlaywrightCheckSettings, com.applitools.ICheckSettings, com.applitools.ICheckSettingsInternal

public class PlaywrightCheckSettings
extends com.applitools.eyes.fluent.CheckSettings
implements IPlaywrightCheckSettings

Field Summary

Fields inherited from class com.applitools.eyes.fluent.CheckSettings

accessibilityRegions, BEFORE_CAPTURE_SCREENSHOT, contentRegions, dynamicRegions, enablePatterns, floatingRegions, ignoreDisplacements, ignoreRegions, layoutRegions, name, pageId, scriptHooks, sendDom, strictRegions, useDom

Constructor Summary

Constructors

Constructor	Description
PlaywrightCheckSettings()

Method Summary

Modifier and Type	Method	Description
PlaywrightCheckSettings	accessibility(com.applitools.eyes.Region region, com.applitools.eyes.AccessibilityRegionType regionType)
PlaywrightCheckSettings	accessibility(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.AccessibilityRegionType type)	Adds an accessibility region with a AccessibilityRegionType.
PlaywrightCheckSettings	accessibility(com.microsoft.playwright.Locator locator, com.applitools.eyes.AccessibilityRegionType type)	Adds an accessibility region with a AccessibilityRegionType.
PlaywrightCheckSettings	accessibility(String selector, com.applitools.eyes.AccessibilityRegionType type)	Adds an accessibility region with a AccessibilityRegionType.
protected void	accessibility_(com.applitools.eyes.Region rect, com.applitools.eyes.AccessibilityRegionType regionType)
PlaywrightCheckSettings	autProxy(com.applitools.eyes.AutProxySettings autProxy)
PlaywrightCheckSettings	beforeRenderScreenshotHook(String hook)
PlaywrightCheckSettings	clone()	Create a new clone of this settings object.
PlaywrightCheckSettings	content()	Deprecated.
PlaywrightCheckSettings	content(com.applitools.eyes.Region[] regions)	Deprecated.
PlaywrightCheckSettings	content(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)	Deprecated.
PlaywrightCheckSettings	content(com.microsoft.playwright.ElementHandle element)	Deprecated.
PlaywrightCheckSettings	content(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding)	Deprecated.
PlaywrightCheckSettings	content(com.microsoft.playwright.ElementHandle element, String regionId)	Deprecated.
PlaywrightCheckSettings	content(com.microsoft.playwright.Locator locator)	Deprecated.
PlaywrightCheckSettings	content(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding)	Deprecated.
PlaywrightCheckSettings	content(com.microsoft.playwright.Locator locator, String regionId)	Deprecated.
PlaywrightCheckSettings	content(String selector)	Deprecated.
PlaywrightCheckSettings	content(String selector, com.applitools.eyes.Padding padding)	Deprecated.
PlaywrightCheckSettings	content(String selector, String regionId)	Deprecated.
PlaywrightCheckSettings	densityMetrics(int xDpi, int yDpi)
PlaywrightCheckSettings	densityMetrics(int xDpi, int yDpi, Double scaleRatio)
PlaywrightCheckSettings	dynamic()
PlaywrightCheckSettings	dynamic(com.applitools.eyes.Region region, com.applitools.eyes.DynamicTextType... textTypes)
PlaywrightCheckSettings	dynamic(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.DynamicTextType... textTypes)
PlaywrightCheckSettings	dynamic(com.microsoft.playwright.Locator locator, com.applitools.eyes.DynamicTextType... textTypes)
PlaywrightCheckSettings	dynamic(String locator, com.applitools.eyes.DynamicTextType... textTypes)
PlaywrightCheckSettings	enablePatterns()
PlaywrightCheckSettings	enablePatterns(Boolean enablePatterns)
PlaywrightCheckSettings	exact()
PlaywrightCheckSettings	floating(int maxOffset, com.applitools.eyes.Region... regions)
PlaywrightCheckSettings	floating(int maxOffset, com.microsoft.playwright.ElementHandle element)	Adds a floating region.
PlaywrightCheckSettings	floating(int maxOffset, com.microsoft.playwright.Locator locator)	Adds a floating region.
PlaywrightCheckSettings	floating(int maxOffset, String selector)	Adds a floating region.
PlaywrightCheckSettings	floating(com.applitools.eyes.Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
PlaywrightCheckSettings	floating(com.microsoft.playwright.ElementHandle element, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)	Adds a floating region.
PlaywrightCheckSettings	floating(com.microsoft.playwright.Locator locator, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)	Adds a floating region.
PlaywrightCheckSettings	floating(String selector, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)	Adds a floating region.
protected void	floating_(com.applitools.eyes.Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)	internal
PlaywrightCheckSettings	frame(com.microsoft.playwright.ElementHandle frameElement)	Specify the target as a frame.
PlaywrightCheckSettings	frame(com.microsoft.playwright.Locator frameLocator)	Specify the target as a frame.
PlaywrightCheckSettings	frame(Integer frameIndex)	Specify the target as a frame.
PlaywrightCheckSettings	frame(String frameNameOrId)	Specify the target as a frame.
PlaywrightCheckSettings	fully()
PlaywrightCheckSettings	fully(Boolean fully)
com.applitools.eyes.fluent.GetRegion[]	getAccessibilityRegions()	internal
com.applitools.eyes.fluent.GetRegion[]	getContentRegions()	internal
com.applitools.eyes.fluent.GetRegion[]	getDynamicRegions()	internal
com.applitools.eyes.fluent.GetRegion[]	getFloatingRegions()	internal
List<FrameLocator>	getFrameChain()	internal
com.applitools.eyes.fluent.GetRegion[]	getIgnoreRegions()	internal
List<Integer>	getLayoutBreakpoints()
com.applitools.eyes.fluent.GetRegion[]	getLayoutRegions()	internal
com.applitools.eyes.LazyLoadOptions	getLazyLoadOptions()	internal
com.applitools.eyes.universal.Reference	getScrollRootElement()	internal
com.applitools.eyes.fluent.GetRegion[]	getStrictRegions()	internal
com.applitools.eyes.universal.Reference	getTargetElement()	internal
PlaywrightCheckSettings	hideCaret(Boolean hideCaret)
PlaywrightCheckSettings	hideScrollBars(Boolean hideScrollBars)
PlaywrightCheckSettings	ignore(com.applitools.eyes.Region[] regions)
PlaywrightCheckSettings	ignore(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
PlaywrightCheckSettings	ignore(com.microsoft.playwright.ElementHandle element)	Adds an ignore region.
PlaywrightCheckSettings	ignore(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding)	Adds an ignore region with Padding.
PlaywrightCheckSettings	ignore(com.microsoft.playwright.ElementHandle element, String regionId)	Adds an ignore region with a region ID.
PlaywrightCheckSettings	ignore(com.microsoft.playwright.Locator locator)	Adds an ignore region.
PlaywrightCheckSettings	ignore(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding)	Adds an ignore region with Padding.
PlaywrightCheckSettings	ignore(com.microsoft.playwright.Locator locator, String regionId)	Adds an ignore region with a region ID.
PlaywrightCheckSettings	ignore(String selector)	Adds an ignore region.
PlaywrightCheckSettings	ignore(String selector, com.applitools.eyes.Padding padding)	Adds an ignore region with Padding.
PlaywrightCheckSettings	ignore(String selector, String regionId)	Adds an ignore region with a region ID.
protected void	ignore_(com.applitools.eyes.Region region)	internal
PlaywrightCheckSettings	ignoreCaret()
PlaywrightCheckSettings	ignoreCaret(Boolean ignoreCaret)
PlaywrightCheckSettings	ignoreColors()	Shortcut to set the match level to MatchLevel.CONTENT.
PlaywrightCheckSettings	ignoreColors(com.applitools.eyes.Region[] regions)	Adds one or more ignore colors regions.
PlaywrightCheckSettings	ignoreColors(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)	Adds one or more ignore colors regions.
PlaywrightCheckSettings	ignoreColors(com.microsoft.playwright.ElementHandle element)	Adds an ignore colors region.
PlaywrightCheckSettings	ignoreColors(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding)	Adds an ignore colors region with Padding.
PlaywrightCheckSettings	ignoreColors(com.microsoft.playwright.ElementHandle element, String regionId)	Adds an ignore colors region with a region ID.
PlaywrightCheckSettings	ignoreColors(com.microsoft.playwright.Locator locator)	Adds an ignore colors region.
PlaywrightCheckSettings	ignoreColors(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding)	Adds an ignore colors region with Padding.
PlaywrightCheckSettings	ignoreColors(com.microsoft.playwright.Locator locator, String regionId)	Adds an ignore colors region with a region ID.
PlaywrightCheckSettings	ignoreColors(String selector)	Adds an ignore colors region.
PlaywrightCheckSettings	ignoreColors(String selector, com.applitools.eyes.Padding padding)	Adds an ignore colors region with Padding.
PlaywrightCheckSettings	ignoreColors(String selector, String regionId)	Adds an ignore colors region with a region ID.
protected void	ignoreColors_(com.applitools.eyes.Region region)	internal
PlaywrightCheckSettings	ignoreDisplacements()
PlaywrightCheckSettings	ignoreDisplacements(Boolean ignoreDisplacements)
Boolean	isDefaultLayoutBreakpointsSet()
PlaywrightCheckSettings	layout()
PlaywrightCheckSettings	layout(com.applitools.eyes.Region[] regions)
PlaywrightCheckSettings	layout(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
PlaywrightCheckSettings	layout(com.microsoft.playwright.ElementHandle element)	Adds a layout region.
PlaywrightCheckSettings	layout(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding)	Adds a layout region with Padding.
PlaywrightCheckSettings	layout(com.microsoft.playwright.ElementHandle element, String regionId)	Adds a layout region with a region ID.
PlaywrightCheckSettings	layout(com.microsoft.playwright.Locator locator)	Adds a layout region.
PlaywrightCheckSettings	layout(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding)	Adds a layout region with Padding.
PlaywrightCheckSettings	layout(com.microsoft.playwright.Locator locator, String regionId)	Adds a layout region with a region ID.
PlaywrightCheckSettings	layout(String selector)	Adds a layout region.
PlaywrightCheckSettings	layout(String selector, com.applitools.eyes.Padding padding)	Adds a layout region with Padding.
PlaywrightCheckSettings	layout(String selector, String regionId)	Adds a layout region with a region ID.
protected void	layout_(com.applitools.eyes.Region region)	internal
PlaywrightCheckSettings	layoutBreakpoints(int[] breakpoints)	Enable and set the layout breakpoints for the current target.
PlaywrightCheckSettings	layoutBreakpoints(com.applitools.eyes.options.LayoutBreakpointsOptions layoutBreakpointsOptions)	Enable and set the layout breakpoints for the current target.
PlaywrightCheckSettings	layoutBreakpoints(Boolean shouldSet)	Enable layout breakpoints for the current target.
PlaywrightCheckSettings	layoutBreakpoints(Integer... breakpoints)	Enable and set the layout breakpoints for the current target.
PlaywrightCheckSettings	lazyLoad()
PlaywrightCheckSettings	lazyLoad(com.applitools.eyes.LazyLoadOptions lazyLoadOptions)
PlaywrightCheckSettings	matchLevel(com.applitools.eyes.MatchLevel matchLevel)
PlaywrightCheckSettings	pageId(String pageId)
PlaywrightCheckSettings	region(com.applitools.eyes.Region region)	Specify the target as a region.
PlaywrightCheckSettings	region(com.microsoft.playwright.ElementHandle element)	Specify the target as a region.
PlaywrightCheckSettings	region(com.microsoft.playwright.Locator locator)	Specify the target as a region.
PlaywrightCheckSettings	region(String selector)	Specify the target as a region.
PlaywrightCheckSettings	scrollRootElement(com.microsoft.playwright.ElementHandle element)	Specify the scroll root element for the current target.
PlaywrightCheckSettings	scrollRootElement(com.microsoft.playwright.Locator locator)	Specify the scroll root element for the current target.
PlaywrightCheckSettings	scrollRootElement(String selector)	Specify the scroll root element for the current target.
PlaywrightCheckSettings	sendDom()
PlaywrightCheckSettings	sendDom(Boolean sendDom)
PlaywrightCheckSettings	setAccessibilityValidation(com.applitools.eyes.AccessibilitySettings accessibilitySettings)
PlaywrightCheckSettings	setDisableBrowserFetching(Boolean disableBrowserFetching)
PlaywrightCheckSettings	setHideCaret(Boolean hideCaret)	Deprecated.
PlaywrightCheckSettings	setHideScrollBars(Boolean hideScrollBars)	Deprecated.
PlaywrightCheckSettings	setLayoutBreakpoints(int... breakpoints)	Deprecated.
PlaywrightCheckSettings	setLayoutBreakpoints(Boolean shouldSet)	Deprecated.
PlaywrightCheckSettings	setLayoutBreakpoints(Integer... breakpoints)	Deprecated.
PlaywrightCheckSettings	stitchMode(com.applitools.eyes.selenium.StitchMode stitchMode)
PlaywrightCheckSettings	stitchOverlap(com.applitools.eyes.StitchOverlap stitchOverlap)
PlaywrightCheckSettings	stitchOverlap(Integer overlap)
PlaywrightCheckSettings	strict()
PlaywrightCheckSettings	strict(com.applitools.eyes.Region[] regions)
PlaywrightCheckSettings	strict(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions)
PlaywrightCheckSettings	strict(com.microsoft.playwright.ElementHandle element)	Adds a strict region.
PlaywrightCheckSettings	strict(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding)	Adds a strict region with Padding.
PlaywrightCheckSettings	strict(com.microsoft.playwright.ElementHandle element, String regionId)	Adds a strict region with a region ID.
PlaywrightCheckSettings	strict(com.microsoft.playwright.Locator locator)	Adds a strict region.
PlaywrightCheckSettings	strict(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding)	Adds a strict region with Padding.
PlaywrightCheckSettings	strict(com.microsoft.playwright.Locator locator, String regionId)	Adds a strict region with a region ID.
PlaywrightCheckSettings	strict(String selector)	Adds a strict region.
PlaywrightCheckSettings	strict(String selector, com.applitools.eyes.Padding padding)	Adds a strict region with Padding.
PlaywrightCheckSettings	strict(String selector, String regionId)	Adds a strict region with a region ID.
protected void	strict_(com.applitools.eyes.Region region)	internal
PlaywrightCheckSettings	timeout(Integer timeoutMilliseconds)
PlaywrightCheckSettings	useDom(Boolean useDom)
PlaywrightCheckSettings	variationGroupId(String variationGroupId)
PlaywrightCheckSettings	visualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption... options)
PlaywrightCheckSettings	waitBeforeCapture(Integer milliSec)
PlaywrightCheckSettings	withName(String name)

Methods inherited from class com.applitools.eyes.fluent.CheckSettings

accessibility, accessibility_, content_, content_, dynamic_, dynamic_, floating, getAccessibilityValidation, getAutProxy, getDensityMetrics, getHideCaret, getHideScrollBars, getIgnoreCaret, getLayoutBreakpointsOptions, getMatchLevel, getName, getOcrRegion, getOverlap, getPageId, getScriptHooks, getSizeMode, getStepPositionProvider, getStitchContent, getStitchMode, getStitchOverlap, getTargetRegion, getTimeout, getVariationGroupId, getVisualGridOptions, getWaitBeforeCapture, ignore_, isCheckWindow, isDisableBrowserFetching, isEnablePatterns, isIgnoreDisplacements, isSendDom, isStitchContent, isUseDom, layout_, ocrRegion, populateClone, scriptHook, setOverlap, setStitchContent, strict_, updateTargetRegion

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.applitools.ICheckSettings

isCheckWindow, scriptHook

Constructor Details

PlaywrightCheckSettings

public PlaywrightCheckSettings()

Method Details

region

public PlaywrightCheckSettings region(@Nonnull
 com.applitools.eyes.Region region)

Specify the target as a region.

Specified by:

region in interface com.applitools.ICheckSettings

Specified by:

region in interface IPlaywrightCheckSettings

Overrides:

region in class com.applitools.eyes.fluent.CheckSettings

Parameters:

region - the region

Returns:

an updated instance of this settings object

region

public PlaywrightCheckSettings region(@Nonnull
 String selector)

Specify the target as a region.

Specified by:

region in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector

Returns:

an updated instance of this settings object

region

public PlaywrightCheckSettings region(@Nonnull
 com.microsoft.playwright.Locator locator)

Specify the target as a region.

Specified by:

region in interface IPlaywrightCheckSettings

Parameters:

locator - the locator

Returns:

an updated instance of this settings object

region

public PlaywrightCheckSettings region(@Nonnull
 com.microsoft.playwright.ElementHandle element)

Specify the target as a region.

Specified by:

region in interface IPlaywrightCheckSettings

Parameters:

element - the element

Returns:

an updated instance of this settings object

frame

public PlaywrightCheckSettings frame(@Nonnull
 String frameNameOrId)

Specify the target as a frame.

Specified by:

frame in interface IPlaywrightCheckSettings

Parameters:

frameNameOrId - the frame's name or its id

Returns:

an updated instance of this settings object

frame

public PlaywrightCheckSettings frame(@Nonnull
 Integer frameIndex)

Specify the target as a frame.

Specified by:

frame in interface IPlaywrightCheckSettings

Parameters:

frameIndex - the frame's index

Returns:

an updated instance of this settings object

frame

public PlaywrightCheckSettings frame(@Nonnull
 com.microsoft.playwright.Locator frameLocator)

Specify the target as a frame.

Specified by:

frame in interface IPlaywrightCheckSettings

Parameters:

frameLocator - the frame as a locator

Returns:

an updated instance of this settings object

frame

public PlaywrightCheckSettings frame(@Nonnull
 com.microsoft.playwright.ElementHandle frameElement)

Specify the target as a frame.

Specified by:

frame in interface IPlaywrightCheckSettings

Parameters:

frameElement - the frame as an element

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 String selector)

Adds an ignore region.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to ignore match

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 com.microsoft.playwright.Locator locator)

Adds an ignore region.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to ignore match

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 com.microsoft.playwright.ElementHandle element)

Adds an ignore region.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

element - the element to ignore match

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 String selector,
 @Nonnull
 String regionId)

Adds an ignore region with a region ID.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to ignore match

regionId - the region ID

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 com.microsoft.playwright.Locator locator,
 @Nonnull
 String regionId)

Adds an ignore region with a region ID.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to ignore match

regionId - the region ID

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 @Nonnull
 String regionId)

Adds an ignore region with a region ID.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

element - the element to ignore match

regionId - the region ID

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 String selector,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds an ignore region with Padding.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to ignore match

padding - the padding

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 com.microsoft.playwright.Locator locator,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds an ignore region with Padding.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to ignore match

padding - the padding

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds an ignore region with Padding.

Specified by:

ignore in interface IPlaywrightCheckSettings

Parameters:

element - the element to ignore match

padding - the padding

Returns:

an updated instance of this settings object

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 com.applitools.eyes.Region[] regions)

Specified by:

ignore in interface com.applitools.ICheckSettings

Overrides:

ignore in class com.applitools.eyes.fluent.CheckSettings

ignore

public PlaywrightCheckSettings ignore(@Nonnull
 com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Specified by:

ignore in interface com.applitools.ICheckSettings

Overrides:

ignore in class com.applitools.eyes.fluent.CheckSettings

ignore_

protected void ignore_(com.applitools.eyes.Region region)

internal

Overrides:

ignore_ in class com.applitools.eyes.fluent.CheckSettings

layout

public PlaywrightCheckSettings layout(@Nonnull
 String selector)

Adds a layout region.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to match using the layout algorithm

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 com.microsoft.playwright.Locator locator)

Adds a layout region.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the layout algorithm

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 com.microsoft.playwright.ElementHandle element)

Adds a layout region.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

element - the css or xpath selector to match using the layout algorithm

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 String selector,
 @Nonnull
 String regionId)

Adds a layout region with a region ID.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to match using the layout algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 com.microsoft.playwright.Locator locator,
 @Nonnull
 String regionId)

Adds a layout region with a region ID.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the layout algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 @Nonnull
 String regionId)

Adds a layout region with a region ID.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

element - the element to match using the layout algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 String selector,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds a layout region with Padding.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to match using the layout algorithm

padding - the padding

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 com.microsoft.playwright.Locator locator,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds a layout region with Padding.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the layout algorithm

padding - the padding

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds a layout region with Padding.

Specified by:

layout in interface IPlaywrightCheckSettings

Parameters:

element - the element to match using the layout algorithm

padding - the padding

Returns:

an updated instance of this settings object

layout

public PlaywrightCheckSettings layout(@Nonnull
 com.applitools.eyes.Region[] regions)

Specified by:

layout in interface com.applitools.ICheckSettings

Overrides:

layout in class com.applitools.eyes.fluent.CheckSettings

layout

public PlaywrightCheckSettings layout(@Nonnull
 com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Specified by:

layout in interface com.applitools.ICheckSettings

Overrides:

layout in class com.applitools.eyes.fluent.CheckSettings

layout_

protected void layout_(com.applitools.eyes.Region region)

internal

Overrides:

layout_ in class com.applitools.eyes.fluent.CheckSettings

strict

public PlaywrightCheckSettings strict(@Nonnull
 String selector)

Adds a strict region.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to match using the strict algorithm

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 com.microsoft.playwright.Locator locator)

Adds a strict region.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the strict algorithm

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 com.microsoft.playwright.ElementHandle element)

Adds a strict region.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

element - the element to match using the strict algorithm

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 String selector,
 @Nonnull
 String regionId)

Adds a strict region with a region ID.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to match using the strict algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 com.microsoft.playwright.Locator locator,
 @Nonnull
 String regionId)

Adds a strict region with a region ID.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the strict algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 @Nonnull
 String regionId)

Adds a strict region with a region ID.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

element - the element to match using the strict algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 String selector,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds a strict region with Padding.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to match using the strict algorithm

padding - the padding

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 com.microsoft.playwright.Locator locator,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds a strict region with Padding.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the strict algorithm

padding - the padding

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds a strict region with Padding.

Specified by:

strict in interface IPlaywrightCheckSettings

Parameters:

element - the element to match using the strict algorithm

padding - the padding

Returns:

an updated instance of this settings object

strict

public PlaywrightCheckSettings strict(@Nonnull
 com.applitools.eyes.Region[] regions)

Specified by:

strict in interface com.applitools.ICheckSettings

Overrides:

strict in class com.applitools.eyes.fluent.CheckSettings

strict

public PlaywrightCheckSettings strict(@Nonnull
 com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Specified by:

strict in interface com.applitools.ICheckSettings

Overrides:

strict in class com.applitools.eyes.fluent.CheckSettings

strict_

protected void strict_(com.applitools.eyes.Region region)

internal

Overrides:

strict_ in class com.applitools.eyes.fluent.CheckSettings

ignoreColors

public PlaywrightCheckSettings ignoreColors()

Shortcut to set the match level to MatchLevel.CONTENT.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Overrides:

ignoreColors in class com.applitools.eyes.fluent.CheckSettings

Returns:

An updated clone of this settings object.

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 String selector)

Adds an ignore colors region.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to match using the ignore colors algorithm

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 com.microsoft.playwright.Locator locator)

Adds an ignore colors region.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the ignore colors algorithm

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 com.microsoft.playwright.ElementHandle element)

Adds an ignore colors region.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

element - the element to match using the ignore colors algorithm

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 String selector,
 @Nonnull
 String regionId)

Adds an ignore colors region with a region ID.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath to match using the ignore colors algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 com.microsoft.playwright.Locator locator,
 @Nonnull
 String regionId)

Adds an ignore colors region with a region ID.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the ignore colors algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 @Nonnull
 String regionId)

Adds an ignore colors region with a region ID.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

element - the element to match using the ignore colors algorithm

regionId - the region ID

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 String selector,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds an ignore colors region with Padding.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector to match using the ignore colors algorithm

padding - the padding

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 com.microsoft.playwright.Locator locator,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds an ignore colors region with Padding.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

locator - the locator to match using the ignore colors algorithm

padding - the padding

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 @Nonnull
 com.applitools.eyes.Padding padding)

Adds an ignore colors region with Padding.

Specified by:

ignoreColors in interface IPlaywrightCheckSettings

Parameters:

element - the element to match using the ignore colors algorithm

padding - the padding

Returns:

an updated instance of this settings object

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 com.applitools.eyes.Region[] regions)

Adds one or more ignore colors regions.

Parameters:

regions - An array of regions to match using the ignore colors method.

Returns:

An updated clone of this settings object.

ignoreColors

public PlaywrightCheckSettings ignoreColors(@Nonnull
 com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Adds one or more ignore colors regions.

Parameters:

region - A region to match using the Content method.

regions - Optional extra regions to match using the Content method.

Returns:

An updated clone of this settings object.

ignoreColors_

protected void ignoreColors_(com.applitools.eyes.Region region)

internal

floating

public PlaywrightCheckSettings floating(String selector,
 int maxUpOffset,
 int maxDownOffset,
 int maxLeftOffset,
 int maxRightOffset)

Adds a floating region. A floating region is a region that can be placed within the boundaries of a bigger region.

Specified by:

floating in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector

maxUpOffset - how much the content can move up

maxDownOffset - how much the content can move down

maxLeftOffset - how much the content can move to the left

maxRightOffset - how much the content can move to the right

Returns:

an updated clone of this settings object

floating

public PlaywrightCheckSettings floating(com.microsoft.playwright.Locator locator,
 int maxUpOffset,
 int maxDownOffset,
 int maxLeftOffset,
 int maxRightOffset)

Adds a floating region. A floating region is a region that can be placed within the boundaries of a bigger region.

Specified by:

floating in interface IPlaywrightCheckSettings

Parameters:

locator - the locator

maxUpOffset - how much the content can move up

maxDownOffset - how much the content can move down

maxLeftOffset - how much the content can move to the left

maxRightOffset - how much the content can move to the right

Returns:

an updated clone of this settings object

floating

public PlaywrightCheckSettings floating(com.microsoft.playwright.ElementHandle element,
 int maxUpOffset,
 int maxDownOffset,
 int maxLeftOffset,
 int maxRightOffset)

Adds a floating region. A floating region is a region that can be placed within the boundaries of a bigger region.

Specified by:

floating in interface IPlaywrightCheckSettings

Parameters:

element - the element

maxUpOffset - how much the content can move up

maxDownOffset - how much the content can move down

maxLeftOffset - how much the content can move to the left

maxRightOffset - how much the content can move to the right

Returns:

an updated clone of this settings object

floating

public PlaywrightCheckSettings floating(int maxOffset,
 String selector)

Adds a floating region. A floating region is a region that can be placed within the boundaries of a bigger region.

Specified by:

floating in interface IPlaywrightCheckSettings

Parameters:

maxOffset - how much the content can move in all directions

selector - the css or xpath selector

Returns:

an updated clone of this settings object

floating

public PlaywrightCheckSettings floating(int maxOffset,
 com.microsoft.playwright.Locator locator)

Adds a floating region. A floating region is a region that can be placed within the boundaries of a bigger region.

Specified by:

floating in interface IPlaywrightCheckSettings

Parameters:

maxOffset - how much the content can move in all directions

locator - the locator

Returns:

an updated clone of this settings object

floating

public PlaywrightCheckSettings floating(int maxOffset,
 com.microsoft.playwright.ElementHandle element)

Adds a floating region. A floating region is a region that can be placed within the boundaries of a bigger region.

Specified by:

floating in interface IPlaywrightCheckSettings

Parameters:

maxOffset - how much the content can move in all directions

element - the element

Returns:

an updated clone of this settings object

floating

public PlaywrightCheckSettings floating(int maxOffset,
 com.applitools.eyes.Region... regions)

Specified by:

floating in interface com.applitools.ICheckSettings

Overrides:

floating in class com.applitools.eyes.fluent.CheckSettings

floating

public PlaywrightCheckSettings floating(com.applitools.eyes.Region region,
 int maxUpOffset,
 int maxDownOffset,
 int maxLeftOffset,
 int maxRightOffset)

Specified by:

floating in interface com.applitools.ICheckSettings

Overrides:

floating in class com.applitools.eyes.fluent.CheckSettings

floating_

protected void floating_(com.applitools.eyes.Region region,
 int maxUpOffset,
 int maxDownOffset,
 int maxLeftOffset,
 int maxRightOffset)

internal

Overrides:

floating_ in class com.applitools.eyes.fluent.CheckSettings

accessibility

public PlaywrightCheckSettings accessibility(@Nonnull
 String selector,
 com.applitools.eyes.AccessibilityRegionType type)

Adds an accessibility region with a AccessibilityRegionType.

Specified by:

accessibility in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector

type - the accessibility region type

Returns:

an updated clone of this settings object

accessibility

public PlaywrightCheckSettings accessibility(@Nonnull
 com.microsoft.playwright.Locator locator,
 com.applitools.eyes.AccessibilityRegionType type)

Adds an accessibility region with a AccessibilityRegionType.

Specified by:

accessibility in interface IPlaywrightCheckSettings

Parameters:

locator - the css or xpath selector

type - the accessibility region type

Returns:

an updated clone of this settings object

accessibility

public PlaywrightCheckSettings accessibility(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 com.applitools.eyes.AccessibilityRegionType type)

Adds an accessibility region with a AccessibilityRegionType.

Specified by:

accessibility in interface IPlaywrightCheckSettings

Parameters:

element - the element

type - the accessibility region type

Returns:

an updated clone of this settings object

accessibility

public PlaywrightCheckSettings accessibility(com.applitools.eyes.Region region,
 com.applitools.eyes.AccessibilityRegionType regionType)

Specified by:

accessibility in interface com.applitools.ICheckSettings

Overrides:

accessibility in class com.applitools.eyes.fluent.CheckSettings

accessibility_

protected void accessibility_(com.applitools.eyes.Region rect,
 com.applitools.eyes.AccessibilityRegionType regionType)

Overrides:

accessibility_ in class com.applitools.eyes.fluent.CheckSettings

dynamic

public PlaywrightCheckSettings dynamic(String locator,
 com.applitools.eyes.DynamicTextType... textTypes)

dynamic

public PlaywrightCheckSettings dynamic(com.microsoft.playwright.Locator locator,
 com.applitools.eyes.DynamicTextType... textTypes)

dynamic

public PlaywrightCheckSettings dynamic(@Nonnull
 com.microsoft.playwright.ElementHandle element,
 com.applitools.eyes.DynamicTextType... textTypes)

dynamic

public PlaywrightCheckSettings dynamic(com.applitools.eyes.Region region,
 com.applitools.eyes.DynamicTextType... textTypes)

Overrides:

dynamic in class com.applitools.eyes.fluent.CheckSettings

scrollRootElement

public PlaywrightCheckSettings scrollRootElement(@Nonnull
 String selector)

Specify the scroll root element for the current target.

Specified by:

scrollRootElement in interface IPlaywrightCheckSettings

Parameters:

selector - the css or xpath selector

Returns:

an updated clone of this settings object

scrollRootElement

public PlaywrightCheckSettings scrollRootElement(@Nonnull
 com.microsoft.playwright.Locator locator)

Specify the scroll root element for the current target.

Specified by:

scrollRootElement in interface IPlaywrightCheckSettings

Parameters:

locator - the locator

Returns:

an updated clone of this settings object

scrollRootElement

public PlaywrightCheckSettings scrollRootElement(@Nonnull
 com.microsoft.playwright.ElementHandle element)

Specify the scroll root element for the current target.

Specified by:

scrollRootElement in interface IPlaywrightCheckSettings

Parameters:

element - the element

Returns:

an updated clone of this settings object

layoutBreakpoints

public PlaywrightCheckSettings layoutBreakpoints(int[] breakpoints)

Enable and set the layout breakpoints for the current target.

Overrides:

layoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

Parameters:

breakpoints - one or more viewport widths explicitly

Returns:

an updated clone of this settings object

layoutBreakpoints

public PlaywrightCheckSettings layoutBreakpoints(Integer... breakpoints)

Enable and set the layout breakpoints for the current target.

Specified by:

layoutBreakpoints in interface com.applitools.ICheckSettings

Overrides:

layoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

Parameters:

breakpoints - one or more viewport widths explicitly

Returns:

an updated clone of this settings object

layoutBreakpoints

public PlaywrightCheckSettings layoutBreakpoints(Boolean shouldSet)

Enable layout breakpoints for the current target.

Specified by:

layoutBreakpoints in interface com.applitools.ICheckSettings

Overrides:

layoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

Parameters:

shouldSet - should enable this feature

Returns:

an updated clone of this settings object

layoutBreakpoints

public PlaywrightCheckSettings layoutBreakpoints(com.applitools.eyes.options.LayoutBreakpointsOptions layoutBreakpointsOptions)

Enable and set the layout breakpoints for the current target.

Specified by:

layoutBreakpoints in interface com.applitools.ICheckSettings

Overrides:

layoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

Parameters:

layoutBreakpointsOptions - the layout breakpoints options

Returns:

an updated clone of this settings object

setLayoutBreakpoints

@Deprecated
public PlaywrightCheckSettings setLayoutBreakpoints(int... breakpoints)

Deprecated.

Overrides:

setLayoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

setLayoutBreakpoints

@Deprecated
public PlaywrightCheckSettings setLayoutBreakpoints(Integer... breakpoints)

Deprecated.

Overrides:

setLayoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

setLayoutBreakpoints

@Deprecated
public PlaywrightCheckSettings setLayoutBreakpoints(Boolean shouldSet)

Deprecated.

Overrides:

setLayoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

getLayoutBreakpoints

public List<Integer> getLayoutBreakpoints()

Overrides:

getLayoutBreakpoints in class com.applitools.eyes.fluent.CheckSettings

isDefaultLayoutBreakpointsSet

public Boolean isDefaultLayoutBreakpointsSet()

Overrides:

isDefaultLayoutBreakpointsSet in class com.applitools.eyes.fluent.CheckSettings

fully

public PlaywrightCheckSettings fully()

Specified by:

fully in interface com.applitools.ICheckSettings

Overrides:

fully in class com.applitools.eyes.fluent.CheckSettings

fully

public PlaywrightCheckSettings fully(Boolean fully)

Specified by:

fully in interface com.applitools.ICheckSettings

Overrides:

fully in class com.applitools.eyes.fluent.CheckSettings

withName

public PlaywrightCheckSettings withName(String name)

Specified by:

withName in interface com.applitools.ICheckSettings

Overrides:

withName in class com.applitools.eyes.fluent.CheckSettings

ignoreCaret

public PlaywrightCheckSettings ignoreCaret(Boolean ignoreCaret)

Specified by:

ignoreCaret in interface com.applitools.ICheckSettings

Overrides:

ignoreCaret in class com.applitools.eyes.fluent.CheckSettings

sendDom

public PlaywrightCheckSettings sendDom(Boolean sendDom)

Specified by:

sendDom in interface com.applitools.ICheckSettings

Overrides:

sendDom in class com.applitools.eyes.fluent.CheckSettings

sendDom

public PlaywrightCheckSettings sendDom()

Specified by:

sendDom in interface com.applitools.ICheckSettings

Overrides:

sendDom in class com.applitools.eyes.fluent.CheckSettings

enablePatterns

public PlaywrightCheckSettings enablePatterns(Boolean enablePatterns)

Specified by:

enablePatterns in interface com.applitools.ICheckSettings

Overrides:

enablePatterns in class com.applitools.eyes.fluent.CheckSettings

enablePatterns

public PlaywrightCheckSettings enablePatterns()

Specified by:

enablePatterns in interface com.applitools.ICheckSettings

Overrides:

enablePatterns in class com.applitools.eyes.fluent.CheckSettings

beforeRenderScreenshotHook

public PlaywrightCheckSettings beforeRenderScreenshotHook(String hook)

Specified by:

beforeRenderScreenshotHook in interface com.applitools.ICheckSettings

Specified by:

beforeRenderScreenshotHook in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

beforeRenderScreenshotHook in class com.applitools.eyes.fluent.CheckSettings

timeout

public PlaywrightCheckSettings timeout(Integer timeoutMilliseconds)

Specified by:

timeout in interface com.applitools.ICheckSettings

Overrides:

timeout in class com.applitools.eyes.fluent.CheckSettings

useDom

public PlaywrightCheckSettings useDom(Boolean useDom)

Specified by:

useDom in interface com.applitools.ICheckSettings

Overrides:

useDom in class com.applitools.eyes.fluent.CheckSettings

variationGroupId

public PlaywrightCheckSettings variationGroupId(String variationGroupId)

Overrides:

variationGroupId in class com.applitools.eyes.fluent.CheckSettings

visualGridOptions

public PlaywrightCheckSettings visualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption... options)

Specified by:

visualGridOptions in interface com.applitools.ICheckSettings

Overrides:

visualGridOptions in class com.applitools.eyes.fluent.CheckSettings

waitBeforeCapture

public PlaywrightCheckSettings waitBeforeCapture(Integer milliSec)

Specified by:

waitBeforeCapture in interface com.applitools.ICheckSettings

Overrides:

waitBeforeCapture in class com.applitools.eyes.fluent.CheckSettings

setDisableBrowserFetching

public PlaywrightCheckSettings setDisableBrowserFetching(Boolean disableBrowserFetching)

Specified by:

setDisableBrowserFetching in interface com.applitools.ICheckSettingsInternal

Overrides:

setDisableBrowserFetching in class com.applitools.eyes.fluent.CheckSettings

autProxy

public PlaywrightCheckSettings autProxy(com.applitools.eyes.AutProxySettings autProxy)

Overrides:

autProxy in class com.applitools.eyes.fluent.CheckSettings

setAccessibilityValidation

public PlaywrightCheckSettings setAccessibilityValidation(com.applitools.eyes.AccessibilitySettings accessibilitySettings)

Overrides:

setAccessibilityValidation in class com.applitools.eyes.fluent.CheckSettings

stitchMode

public PlaywrightCheckSettings stitchMode(com.applitools.eyes.selenium.StitchMode stitchMode)

Overrides:

stitchMode in class com.applitools.eyes.fluent.CheckSettings

hideScrollBars

public PlaywrightCheckSettings hideScrollBars(Boolean hideScrollBars)

Overrides:

hideScrollBars in class com.applitools.eyes.fluent.CheckSettings

hideCaret

public PlaywrightCheckSettings hideCaret(Boolean hideCaret)

Overrides:

hideCaret in class com.applitools.eyes.fluent.CheckSettings

stitchOverlap

public PlaywrightCheckSettings stitchOverlap(Integer overlap)

Overrides:

stitchOverlap in class com.applitools.eyes.fluent.CheckSettings

stitchOverlap

public PlaywrightCheckSettings stitchOverlap(com.applitools.eyes.StitchOverlap stitchOverlap)

Overrides:

stitchOverlap in class com.applitools.eyes.fluent.CheckSettings

pageId

public PlaywrightCheckSettings pageId(String pageId)

Overrides:

pageId in class com.applitools.eyes.fluent.CheckSettings

ignoreDisplacements

public PlaywrightCheckSettings ignoreDisplacements(Boolean ignoreDisplacements)

Specified by:

ignoreDisplacements in interface com.applitools.ICheckSettings

Overrides:

ignoreDisplacements in class com.applitools.eyes.fluent.CheckSettings

ignoreDisplacements

public PlaywrightCheckSettings ignoreDisplacements()

Specified by:

ignoreDisplacements in interface com.applitools.ICheckSettings

Overrides:

ignoreDisplacements in class com.applitools.eyes.fluent.CheckSettings

ignoreCaret

public PlaywrightCheckSettings ignoreCaret()

Specified by:

ignoreCaret in interface com.applitools.ICheckSettings

Overrides:

ignoreCaret in class com.applitools.eyes.fluent.CheckSettings

matchLevel

public PlaywrightCheckSettings matchLevel(com.applitools.eyes.MatchLevel matchLevel)

Specified by:

matchLevel in interface com.applitools.ICheckSettings

Overrides:

matchLevel in class com.applitools.eyes.fluent.CheckSettings

strict

public PlaywrightCheckSettings strict()

Specified by:

strict in interface com.applitools.ICheckSettings

Overrides:

strict in class com.applitools.eyes.fluent.CheckSettings

layout

public PlaywrightCheckSettings layout()

Specified by:

layout in interface com.applitools.ICheckSettings

Overrides:

layout in class com.applitools.eyes.fluent.CheckSettings

dynamic

public PlaywrightCheckSettings dynamic()

Specified by:

dynamic in interface com.applitools.ICheckSettings

Overrides:

dynamic in class com.applitools.eyes.fluent.CheckSettings

exact

public PlaywrightCheckSettings exact()

Specified by:

exact in interface com.applitools.ICheckSettings

Overrides:

exact in class com.applitools.eyes.fluent.CheckSettings

lazyLoad

public PlaywrightCheckSettings lazyLoad()

Specified by:

lazyLoad in interface com.applitools.ICheckSettings

Overrides:

lazyLoad in class com.applitools.eyes.fluent.CheckSettings

lazyLoad

public PlaywrightCheckSettings lazyLoad(com.applitools.eyes.LazyLoadOptions lazyLoadOptions)

Specified by:

lazyLoad in interface com.applitools.ICheckSettings

Overrides:

lazyLoad in class com.applitools.eyes.fluent.CheckSettings

densityMetrics

public PlaywrightCheckSettings densityMetrics(int xDpi,
 int yDpi)

Specified by:

densityMetrics in interface com.applitools.ICheckSettings

Overrides:

densityMetrics in class com.applitools.eyes.fluent.CheckSettings

densityMetrics

public PlaywrightCheckSettings densityMetrics(int xDpi,
 int yDpi,
 Double scaleRatio)

Specified by:

densityMetrics in interface com.applitools.ICheckSettings

Overrides:

densityMetrics in class com.applitools.eyes.fluent.CheckSettings

clone

public PlaywrightCheckSettings clone()

Create a new clone of this settings object.

Specified by:

clone in interface com.applitools.ICheckSettingsInternal

Overrides:

clone in class com.applitools.eyes.fluent.CheckSettings

Returns:

the clone of this settings object

getTargetElement

public com.applitools.eyes.universal.Reference getTargetElement()

internal

getScrollRootElement

public com.applitools.eyes.universal.Reference getScrollRootElement()

internal

getFrameChain

public List<FrameLocator> getFrameChain()

internal

getLazyLoadOptions

public com.applitools.eyes.LazyLoadOptions getLazyLoadOptions()

internal

Overrides:

getLazyLoadOptions in class com.applitools.eyes.fluent.CheckSettings

getIgnoreRegions

public com.applitools.eyes.fluent.GetRegion[] getIgnoreRegions()

internal

Specified by:

getIgnoreRegions in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

getIgnoreRegions in class com.applitools.eyes.fluent.CheckSettings

getLayoutRegions

public com.applitools.eyes.fluent.GetRegion[] getLayoutRegions()

internal

Specified by:

getLayoutRegions in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

getLayoutRegions in class com.applitools.eyes.fluent.CheckSettings

getStrictRegions

public com.applitools.eyes.fluent.GetRegion[] getStrictRegions()

internal

Specified by:

getStrictRegions in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

getStrictRegions in class com.applitools.eyes.fluent.CheckSettings

getContentRegions

public com.applitools.eyes.fluent.GetRegion[] getContentRegions()

internal

Specified by:

getContentRegions in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

getContentRegions in class com.applitools.eyes.fluent.CheckSettings

getFloatingRegions

public com.applitools.eyes.fluent.GetRegion[] getFloatingRegions()

internal

Specified by:

getFloatingRegions in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

getFloatingRegions in class com.applitools.eyes.fluent.CheckSettings

getAccessibilityRegions

public com.applitools.eyes.fluent.GetRegion[] getAccessibilityRegions()

internal

Specified by:

getAccessibilityRegions in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

getAccessibilityRegions in class com.applitools.eyes.fluent.CheckSettings

getDynamicRegions

public com.applitools.eyes.fluent.GetRegion[] getDynamicRegions()

internal

Specified by:

getDynamicRegions in interface com.applitools.eyes.fluent.ICheckSettingsInternal

Overrides:

getDynamicRegions in class com.applitools.eyes.fluent.CheckSettings

content

@Deprecated
public PlaywrightCheckSettings content()

Deprecated.

see ignoreColors()

Specified by:

content in interface com.applitools.ICheckSettings

Overrides:

content in class com.applitools.eyes.fluent.CheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(String selector)

Deprecated.

see ignoreColors(String)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(com.microsoft.playwright.Locator locator)

Deprecated.

see ignoreColors(Locator)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(com.microsoft.playwright.ElementHandle element)

Deprecated.

see ignoreColors(ElementHandle)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(String selector,
 String regionId)

Deprecated.

see ignoreColors(String, String)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(com.microsoft.playwright.Locator locator,
 String regionId)

Deprecated.

see ignoreColors(Locator, String)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(com.microsoft.playwright.ElementHandle element,
 String regionId)

Deprecated.

see ignoreColors(ElementHandle, String)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(String selector,
 com.applitools.eyes.Padding padding)

Deprecated.

see ignoreColors(String, Padding)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(com.microsoft.playwright.Locator locator,
 com.applitools.eyes.Padding padding)

Deprecated.

see ignoreColors(Locator, Padding)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(com.microsoft.playwright.ElementHandle element,
 com.applitools.eyes.Padding padding)

Deprecated.

see ignoreColors(Locator, Padding)

Specified by:

content in interface IPlaywrightCheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(com.applitools.eyes.Region[] regions)

Deprecated.

see ignoreColors(Region[])

Specified by:

content in interface com.applitools.ICheckSettings

Overrides:

content in class com.applitools.eyes.fluent.CheckSettings

content

@Deprecated
public PlaywrightCheckSettings content(com.applitools.eyes.Region region,
 com.applitools.eyes.Region... regions)

Deprecated.

see ignoreColors(Region, Region...)

Specified by:

content in interface com.applitools.ICheckSettings

Overrides:

content in class com.applitools.eyes.fluent.CheckSettings

setHideCaret

@Deprecated
public PlaywrightCheckSettings setHideCaret(Boolean hideCaret)

Deprecated.

see hideCaret(Boolean)

Overrides:

setHideCaret in class com.applitools.eyes.fluent.CheckSettings

setHideScrollBars

@Deprecated
public PlaywrightCheckSettings setHideScrollBars(Boolean hideScrollBars)

Deprecated.

see hideScrollBars(Boolean)

Overrides:

setHideScrollBars in class com.applitools.eyes.fluent.CheckSettings