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 -
Method Summary
Modifier and TypeMethodDescriptionaccessibility(com.applitools.eyes.Region region, com.applitools.eyes.AccessibilityRegionType regionType) accessibility(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.AccessibilityRegionType type) Adds an accessibility region with aAccessibilityRegionType.accessibility(com.microsoft.playwright.Locator locator, com.applitools.eyes.AccessibilityRegionType type) Adds an accessibility region with aAccessibilityRegionType.accessibility(String selector, com.applitools.eyes.AccessibilityRegionType type) Adds an accessibility region with aAccessibilityRegionType.protected voidaccessibility_(com.applitools.eyes.Region rect, com.applitools.eyes.AccessibilityRegionType regionType) autProxy(com.applitools.eyes.AutProxySettings autProxy) clone()Create a new clone of this settings object.content()Deprecated.content(com.applitools.eyes.Region[] regions) Deprecated.content(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) Deprecated.content(com.microsoft.playwright.ElementHandle element) Deprecated.content(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding) Deprecated.Deprecated.content(com.microsoft.playwright.Locator locator) Deprecated.content(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding) Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.densityMetrics(int xDpi, int yDpi) densityMetrics(int xDpi, int yDpi, Double scaleRatio) dynamic()dynamic(com.applitools.eyes.Region region, com.applitools.eyes.DynamicTextType... textTypes) dynamic(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.DynamicTextType... textTypes) dynamic(com.microsoft.playwright.Locator locator, com.applitools.eyes.DynamicTextType... textTypes) enablePatterns(Boolean enablePatterns) exact()floating(int maxOffset, com.applitools.eyes.Region... regions) floating(int maxOffset, com.microsoft.playwright.ElementHandle element) Adds a floating region.floating(int maxOffset, com.microsoft.playwright.Locator locator) Adds a floating region.Adds a floating region.floating(com.applitools.eyes.Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset) floating(com.microsoft.playwright.ElementHandle element, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset) Adds a floating region.floating(com.microsoft.playwright.Locator locator, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset) Adds a floating region.floating(String selector, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset) Adds a floating region.protected voidfloating_(com.applitools.eyes.Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset) internalframe(com.microsoft.playwright.ElementHandle frameElement) Specify the target as a frame.frame(com.microsoft.playwright.Locator frameLocator) Specify the target as a frame.Specify the target as a frame.Specify the target as a frame.fully()com.applitools.eyes.fluent.GetRegion[]internalcom.applitools.eyes.fluent.GetRegion[]internalcom.applitools.eyes.fluent.GetRegion[]internalcom.applitools.eyes.fluent.GetRegion[]internalinternalcom.applitools.eyes.fluent.GetRegion[]internalcom.applitools.eyes.fluent.GetRegion[]internalcom.applitools.eyes.LazyLoadOptionsinternalcom.applitools.eyes.universal.Referenceinternalcom.applitools.eyes.fluent.GetRegion[]internalcom.applitools.eyes.universal.ReferenceinternalhideScrollBars(Boolean hideScrollBars) ignore(com.applitools.eyes.Region[] regions) ignore(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) ignore(com.microsoft.playwright.ElementHandle element) Adds an ignore region.ignore(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding) Adds an ignore region withPadding.Adds an ignore region with a region ID.ignore(com.microsoft.playwright.Locator locator) Adds an ignore region.ignore(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding) Adds an ignore region withPadding.Adds an ignore region with a region ID.Adds an ignore region.Adds an ignore region withPadding.Adds an ignore region with a region ID.protected voidignore_(com.applitools.eyes.Region region) internalignoreCaret(Boolean ignoreCaret) Shortcut to set the match level toMatchLevel.CONTENT.ignoreColors(com.applitools.eyes.Region[] regions) Adds one or more ignore colors regions.ignoreColors(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) Adds one or more ignore colors regions.ignoreColors(com.microsoft.playwright.ElementHandle element) Adds an ignore colors region.ignoreColors(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding) Adds an ignore colors region withPadding.ignoreColors(com.microsoft.playwright.ElementHandle element, String regionId) Adds an ignore colors region with a region ID.ignoreColors(com.microsoft.playwright.Locator locator) Adds an ignore colors region.ignoreColors(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding) Adds an ignore colors region withPadding.ignoreColors(com.microsoft.playwright.Locator locator, String regionId) Adds an ignore colors region with a region ID.ignoreColors(String selector) Adds an ignore colors region.ignoreColors(String selector, com.applitools.eyes.Padding padding) Adds an ignore colors region withPadding.ignoreColors(String selector, String regionId) Adds an ignore colors region with a region ID.protected voidignoreColors_(com.applitools.eyes.Region region) internalignoreDisplacements(Boolean ignoreDisplacements) layout()layout(com.applitools.eyes.Region[] regions) layout(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) layout(com.microsoft.playwright.ElementHandle element) Adds a layout region.layout(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding) Adds a layout region withPadding.Adds a layout region with a region ID.layout(com.microsoft.playwright.Locator locator) Adds a layout region.layout(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding) Adds a layout region withPadding.Adds a layout region with a region ID.Adds a layout region.Adds a layout region withPadding.Adds a layout region with a region ID.protected voidlayout_(com.applitools.eyes.Region region) internallayoutBreakpoints(int[] breakpoints) Enable and set the layout breakpoints for the current target.layoutBreakpoints(com.applitools.eyes.options.LayoutBreakpointsOptions layoutBreakpointsOptions) Enable and set the layout breakpoints for the current target.layoutBreakpoints(Boolean shouldSet) Enable layout breakpoints for the current target.layoutBreakpoints(Integer... breakpoints) Enable and set the layout breakpoints for the current target.lazyLoad()lazyLoad(com.applitools.eyes.LazyLoadOptions lazyLoadOptions) matchLevel(com.applitools.eyes.MatchLevel matchLevel) region(com.applitools.eyes.Region region) Specify the target as a region.region(com.microsoft.playwright.ElementHandle element) Specify the target as a region.region(com.microsoft.playwright.Locator locator) Specify the target as a region.Specify the target as a region.scrollRootElement(com.microsoft.playwright.ElementHandle element) Specify the scroll root element for the current target.scrollRootElement(com.microsoft.playwright.Locator locator) Specify the scroll root element for the current target.scrollRootElement(String selector) Specify the scroll root element for the current target.sendDom()setAccessibilityValidation(com.applitools.eyes.AccessibilitySettings accessibilitySettings) setDisableBrowserFetching(Boolean disableBrowserFetching) setHideCaret(Boolean hideCaret) Deprecated.setHideScrollBars(Boolean hideScrollBars) Deprecated.setLayoutBreakpoints(int... breakpoints) Deprecated.setLayoutBreakpoints(Boolean shouldSet) Deprecated.setLayoutBreakpoints(Integer... breakpoints) Deprecated.stitchMode(com.applitools.eyes.selenium.StitchMode stitchMode) stitchOverlap(com.applitools.eyes.StitchOverlap stitchOverlap) stitchOverlap(Integer overlap) strict()strict(com.applitools.eyes.Region[] regions) strict(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) strict(com.microsoft.playwright.ElementHandle element) Adds a strict region.strict(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding) Adds a strict region withPadding.Adds a strict region with a region ID.strict(com.microsoft.playwright.Locator locator) Adds a strict region.strict(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding) Adds a strict region withPadding.Adds a strict region with a region ID.Adds a strict region.Adds a strict region withPadding.Adds a strict region with a region ID.protected voidstrict_(com.applitools.eyes.Region region) internalvariationGroupId(String variationGroupId) visualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption... options) waitBeforeCapture(Integer milliSec) 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_, updateTargetRegionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.applitools.ICheckSettings
isCheckWindow, scriptHook
-
Constructor Details
-
PlaywrightCheckSettings
public PlaywrightCheckSettings()
-
-
Method Details
-
region
Specify the target as a region.- Specified by:
regionin interfacecom.applitools.ICheckSettings- Specified by:
regionin interfaceIPlaywrightCheckSettings- Overrides:
regionin classcom.applitools.eyes.fluent.CheckSettings- Parameters:
region- the region- Returns:
- an updated instance of this settings object
-
region
Specify the target as a region.- Specified by:
regionin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector- Returns:
- an updated instance of this settings object
-
region
Specify the target as a region.- Specified by:
regionin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator- Returns:
- an updated instance of this settings object
-
region
Specify the target as a region.- Specified by:
regionin interfaceIPlaywrightCheckSettings- Parameters:
element- the element- Returns:
- an updated instance of this settings object
-
frame
Specify the target as a frame.- Specified by:
framein interfaceIPlaywrightCheckSettings- Parameters:
frameNameOrId- the frame's name or its id- Returns:
- an updated instance of this settings object
-
frame
Specify the target as a frame.- Specified by:
framein interfaceIPlaywrightCheckSettings- Parameters:
frameIndex- the frame's index- Returns:
- an updated instance of this settings object
-
frame
Specify the target as a frame.- Specified by:
framein interfaceIPlaywrightCheckSettings- Parameters:
frameLocator- the frame as a locator- Returns:
- an updated instance of this settings object
-
frame
Specify the target as a frame.- Specified by:
framein interfaceIPlaywrightCheckSettings- Parameters:
frameElement- the frame as an element- Returns:
- an updated instance of this settings object
-
ignore
Adds an ignore region.- Specified by:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to ignore match- Returns:
- an updated instance of this settings object
-
ignore
Adds an ignore region.- Specified by:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to ignore match- Returns:
- an updated instance of this settings object
-
ignore
Adds an ignore region.- Specified by:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
element- the element to ignore match- Returns:
- an updated instance of this settings object
-
ignore
Adds an ignore region with a region ID.- Specified by:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to ignore matchregionId- 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:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to ignore matchregionId- 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:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
element- the element to ignore matchregionId- 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 withPadding.- Specified by:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to ignore matchpadding- 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 withPadding.- Specified by:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to ignore matchpadding- 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 withPadding.- Specified by:
ignorein interfaceIPlaywrightCheckSettings- Parameters:
element- the element to ignore matchpadding- the padding- Returns:
- an updated instance of this settings object
-
ignore
- Specified by:
ignorein interfacecom.applitools.ICheckSettings- Overrides:
ignorein classcom.applitools.eyes.fluent.CheckSettings
-
ignore
public PlaywrightCheckSettings ignore(@Nonnull com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) - Specified by:
ignorein interfacecom.applitools.ICheckSettings- Overrides:
ignorein classcom.applitools.eyes.fluent.CheckSettings
-
ignore_
protected void ignore_(com.applitools.eyes.Region region) internal- Overrides:
ignore_in classcom.applitools.eyes.fluent.CheckSettings
-
layout
Adds a layout region.- Specified by:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to match using the layout algorithm- Returns:
- an updated instance of this settings object
-
layout
Adds a layout region.- Specified by:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to match using the layout algorithm- Returns:
- an updated instance of this settings object
-
layout
Adds a layout region.- Specified by:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
element- the css or xpath selector to match using the layout algorithm- Returns:
- an updated instance of this settings object
-
layout
Adds a layout region with a region ID.- Specified by:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to match using the layout algorithmregionId- 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:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to match using the layout algorithmregionId- 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:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
element- the element to match using the layout algorithmregionId- 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 withPadding.- Specified by:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to match using the layout algorithmpadding- 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 withPadding.- Specified by:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to match using the layout algorithmpadding- 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 withPadding.- Specified by:
layoutin interfaceIPlaywrightCheckSettings- Parameters:
element- the element to match using the layout algorithmpadding- the padding- Returns:
- an updated instance of this settings object
-
layout
- Specified by:
layoutin interfacecom.applitools.ICheckSettings- Overrides:
layoutin classcom.applitools.eyes.fluent.CheckSettings
-
layout
public PlaywrightCheckSettings layout(@Nonnull com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) - Specified by:
layoutin interfacecom.applitools.ICheckSettings- Overrides:
layoutin classcom.applitools.eyes.fluent.CheckSettings
-
layout_
protected void layout_(com.applitools.eyes.Region region) internal- Overrides:
layout_in classcom.applitools.eyes.fluent.CheckSettings
-
strict
Adds a strict region.- Specified by:
strictin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to match using the strict algorithm- Returns:
- an updated instance of this settings object
-
strict
Adds a strict region.- Specified by:
strictin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to match using the strict algorithm- Returns:
- an updated instance of this settings object
-
strict
Adds a strict region.- Specified by:
strictin interfaceIPlaywrightCheckSettings- Parameters:
element- the element to match using the strict algorithm- Returns:
- an updated instance of this settings object
-
strict
Adds a strict region with a region ID.- Specified by:
strictin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to match using the strict algorithmregionId- 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:
strictin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to match using the strict algorithmregionId- 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:
strictin interfaceIPlaywrightCheckSettings- Parameters:
element- the element to match using the strict algorithmregionId- 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 withPadding.- Specified by:
strictin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to match using the strict algorithmpadding- 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 withPadding.- Specified by:
strictin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to match using the strict algorithmpadding- 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 withPadding.- Specified by:
strictin interfaceIPlaywrightCheckSettings- Parameters:
element- the element to match using the strict algorithmpadding- the padding- Returns:
- an updated instance of this settings object
-
strict
- Specified by:
strictin interfacecom.applitools.ICheckSettings- Overrides:
strictin classcom.applitools.eyes.fluent.CheckSettings
-
strict
public PlaywrightCheckSettings strict(@Nonnull com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) - Specified by:
strictin interfacecom.applitools.ICheckSettings- Overrides:
strictin classcom.applitools.eyes.fluent.CheckSettings
-
strict_
protected void strict_(com.applitools.eyes.Region region) internal- Overrides:
strict_in classcom.applitools.eyes.fluent.CheckSettings
-
ignoreColors
Shortcut to set the match level toMatchLevel.CONTENT.- Specified by:
ignoreColorsin interfaceIPlaywrightCheckSettings- Overrides:
ignoreColorsin classcom.applitools.eyes.fluent.CheckSettings- Returns:
- An updated clone of this settings object.
-
ignoreColors
Adds an ignore colors region.- Specified by:
ignoreColorsin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to match using the ignore colors algorithm- Returns:
- an updated instance of this settings object
-
ignoreColors
Adds an ignore colors region.- Specified by:
ignoreColorsin interfaceIPlaywrightCheckSettings- 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:
ignoreColorsin interfaceIPlaywrightCheckSettings- Parameters:
element- the element to match using the ignore colors algorithm- Returns:
- an updated instance of this settings object
-
ignoreColors
Adds an ignore colors region with a region ID.- Specified by:
ignoreColorsin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath to match using the ignore colors algorithmregionId- 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:
ignoreColorsin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to match using the ignore colors algorithmregionId- 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:
ignoreColorsin interfaceIPlaywrightCheckSettings- Parameters:
element- the element to match using the ignore colors algorithmregionId- 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 withPadding.- Specified by:
ignoreColorsin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector to match using the ignore colors algorithmpadding- 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 withPadding.- Specified by:
ignoreColorsin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locator to match using the ignore colors algorithmpadding- 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 withPadding.- Specified by:
ignoreColorsin interfaceIPlaywrightCheckSettings- Parameters:
element- the element to match using the ignore colors algorithmpadding- the padding- Returns:
- an updated instance of this settings object
-
ignoreColors
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:
floatingin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selectormaxUpOffset- how much the content can move upmaxDownOffset- how much the content can move downmaxLeftOffset- how much the content can move to the leftmaxRightOffset- 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:
floatingin interfaceIPlaywrightCheckSettings- Parameters:
locator- the locatormaxUpOffset- how much the content can move upmaxDownOffset- how much the content can move downmaxLeftOffset- how much the content can move to the leftmaxRightOffset- 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:
floatingin interfaceIPlaywrightCheckSettings- Parameters:
element- the elementmaxUpOffset- how much the content can move upmaxDownOffset- how much the content can move downmaxLeftOffset- how much the content can move to the leftmaxRightOffset- how much the content can move to the right- Returns:
- an updated clone of this settings object
-
floating
Adds a floating region. A floating region is a region that can be placed within the boundaries of a bigger region.- Specified by:
floatingin interfaceIPlaywrightCheckSettings- Parameters:
maxOffset- how much the content can move in all directionsselector- the css or xpath selector- Returns:
- an updated clone of this settings object
-
floating
Adds a floating region. A floating region is a region that can be placed within the boundaries of a bigger region.- Specified by:
floatingin interfaceIPlaywrightCheckSettings- Parameters:
maxOffset- how much the content can move in all directionslocator- 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:
floatingin interfaceIPlaywrightCheckSettings- Parameters:
maxOffset- how much the content can move in all directionselement- the element- Returns:
- an updated clone of this settings object
-
floating
- Specified by:
floatingin interfacecom.applitools.ICheckSettings- Overrides:
floatingin classcom.applitools.eyes.fluent.CheckSettings
-
floating
public PlaywrightCheckSettings floating(com.applitools.eyes.Region region, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset) - Specified by:
floatingin interfacecom.applitools.ICheckSettings- Overrides:
floatingin classcom.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 classcom.applitools.eyes.fluent.CheckSettings
-
accessibility
public PlaywrightCheckSettings accessibility(@Nonnull String selector, com.applitools.eyes.AccessibilityRegionType type) Adds an accessibility region with aAccessibilityRegionType.- Specified by:
accessibilityin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selectortype- 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 aAccessibilityRegionType.- Specified by:
accessibilityin interfaceIPlaywrightCheckSettings- Parameters:
locator- the css or xpath selectortype- 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 aAccessibilityRegionType.- Specified by:
accessibilityin interfaceIPlaywrightCheckSettings- Parameters:
element- the elementtype- 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:
accessibilityin interfacecom.applitools.ICheckSettings- Overrides:
accessibilityin classcom.applitools.eyes.fluent.CheckSettings
-
accessibility_
protected void accessibility_(com.applitools.eyes.Region rect, com.applitools.eyes.AccessibilityRegionType regionType) - Overrides:
accessibility_in classcom.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:
dynamicin classcom.applitools.eyes.fluent.CheckSettings
-
scrollRootElement
Specify the scroll root element for the current target.- Specified by:
scrollRootElementin interfaceIPlaywrightCheckSettings- Parameters:
selector- the css or xpath selector- Returns:
- an updated clone of this settings object
-
scrollRootElement
Specify the scroll root element for the current target.- Specified by:
scrollRootElementin interfaceIPlaywrightCheckSettings- 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:
scrollRootElementin interfaceIPlaywrightCheckSettings- Parameters:
element- the element- Returns:
- an updated clone of this settings object
-
layoutBreakpoints
Enable and set the layout breakpoints for the current target.- Overrides:
layoutBreakpointsin classcom.applitools.eyes.fluent.CheckSettings- Parameters:
breakpoints- one or more viewport widths explicitly- Returns:
- an updated clone of this settings object
-
layoutBreakpoints
Enable and set the layout breakpoints for the current target.- Specified by:
layoutBreakpointsin interfacecom.applitools.ICheckSettings- Overrides:
layoutBreakpointsin classcom.applitools.eyes.fluent.CheckSettings- Parameters:
breakpoints- one or more viewport widths explicitly- Returns:
- an updated clone of this settings object
-
layoutBreakpoints
Enable layout breakpoints for the current target.- Specified by:
layoutBreakpointsin interfacecom.applitools.ICheckSettings- Overrides:
layoutBreakpointsin classcom.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:
layoutBreakpointsin interfacecom.applitools.ICheckSettings- Overrides:
layoutBreakpointsin classcom.applitools.eyes.fluent.CheckSettings- Parameters:
layoutBreakpointsOptions- the layout breakpoints options- Returns:
- an updated clone of this settings object
-
setLayoutBreakpoints
Deprecated.- Overrides:
setLayoutBreakpointsin classcom.applitools.eyes.fluent.CheckSettings
-
setLayoutBreakpoints
Deprecated.- Overrides:
setLayoutBreakpointsin classcom.applitools.eyes.fluent.CheckSettings
-
setLayoutBreakpoints
Deprecated.- Overrides:
setLayoutBreakpointsin classcom.applitools.eyes.fluent.CheckSettings
-
getLayoutBreakpoints
-
isDefaultLayoutBreakpointsSet
- Overrides:
isDefaultLayoutBreakpointsSetin classcom.applitools.eyes.fluent.CheckSettings
-
fully
- Specified by:
fullyin interfacecom.applitools.ICheckSettings- Overrides:
fullyin classcom.applitools.eyes.fluent.CheckSettings
-
fully
- Specified by:
fullyin interfacecom.applitools.ICheckSettings- Overrides:
fullyin classcom.applitools.eyes.fluent.CheckSettings
-
withName
- Specified by:
withNamein interfacecom.applitools.ICheckSettings- Overrides:
withNamein classcom.applitools.eyes.fluent.CheckSettings
-
ignoreCaret
- Specified by:
ignoreCaretin interfacecom.applitools.ICheckSettings- Overrides:
ignoreCaretin classcom.applitools.eyes.fluent.CheckSettings
-
sendDom
- Specified by:
sendDomin interfacecom.applitools.ICheckSettings- Overrides:
sendDomin classcom.applitools.eyes.fluent.CheckSettings
-
sendDom
- Specified by:
sendDomin interfacecom.applitools.ICheckSettings- Overrides:
sendDomin classcom.applitools.eyes.fluent.CheckSettings
-
enablePatterns
- Specified by:
enablePatternsin interfacecom.applitools.ICheckSettings- Overrides:
enablePatternsin classcom.applitools.eyes.fluent.CheckSettings
-
enablePatterns
- Specified by:
enablePatternsin interfacecom.applitools.ICheckSettings- Overrides:
enablePatternsin classcom.applitools.eyes.fluent.CheckSettings
-
beforeRenderScreenshotHook
- Specified by:
beforeRenderScreenshotHookin interfacecom.applitools.ICheckSettings- Specified by:
beforeRenderScreenshotHookin interfacecom.applitools.eyes.fluent.ICheckSettingsInternal- Overrides:
beforeRenderScreenshotHookin classcom.applitools.eyes.fluent.CheckSettings
-
timeout
- Specified by:
timeoutin interfacecom.applitools.ICheckSettings- Overrides:
timeoutin classcom.applitools.eyes.fluent.CheckSettings
-
useDom
- Specified by:
useDomin interfacecom.applitools.ICheckSettings- Overrides:
useDomin classcom.applitools.eyes.fluent.CheckSettings
-
variationGroupId
- Overrides:
variationGroupIdin classcom.applitools.eyes.fluent.CheckSettings
-
visualGridOptions
public PlaywrightCheckSettings visualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption... options) - Specified by:
visualGridOptionsin interfacecom.applitools.ICheckSettings- Overrides:
visualGridOptionsin classcom.applitools.eyes.fluent.CheckSettings
-
waitBeforeCapture
- Specified by:
waitBeforeCapturein interfacecom.applitools.ICheckSettings- Overrides:
waitBeforeCapturein classcom.applitools.eyes.fluent.CheckSettings
-
setDisableBrowserFetching
- Specified by:
setDisableBrowserFetchingin interfacecom.applitools.ICheckSettingsInternal- Overrides:
setDisableBrowserFetchingin classcom.applitools.eyes.fluent.CheckSettings
-
autProxy
- Overrides:
autProxyin classcom.applitools.eyes.fluent.CheckSettings
-
setAccessibilityValidation
public PlaywrightCheckSettings setAccessibilityValidation(com.applitools.eyes.AccessibilitySettings accessibilitySettings) - Overrides:
setAccessibilityValidationin classcom.applitools.eyes.fluent.CheckSettings
-
stitchMode
- Overrides:
stitchModein classcom.applitools.eyes.fluent.CheckSettings
-
hideScrollBars
- Overrides:
hideScrollBarsin classcom.applitools.eyes.fluent.CheckSettings
-
hideCaret
- Overrides:
hideCaretin classcom.applitools.eyes.fluent.CheckSettings
-
stitchOverlap
- Overrides:
stitchOverlapin classcom.applitools.eyes.fluent.CheckSettings
-
stitchOverlap
- Overrides:
stitchOverlapin classcom.applitools.eyes.fluent.CheckSettings
-
pageId
- Overrides:
pageIdin classcom.applitools.eyes.fluent.CheckSettings
-
ignoreDisplacements
- Specified by:
ignoreDisplacementsin interfacecom.applitools.ICheckSettings- Overrides:
ignoreDisplacementsin classcom.applitools.eyes.fluent.CheckSettings
-
ignoreDisplacements
- Specified by:
ignoreDisplacementsin interfacecom.applitools.ICheckSettings- Overrides:
ignoreDisplacementsin classcom.applitools.eyes.fluent.CheckSettings
-
ignoreCaret
- Specified by:
ignoreCaretin interfacecom.applitools.ICheckSettings- Overrides:
ignoreCaretin classcom.applitools.eyes.fluent.CheckSettings
-
matchLevel
- Specified by:
matchLevelin interfacecom.applitools.ICheckSettings- Overrides:
matchLevelin classcom.applitools.eyes.fluent.CheckSettings
-
strict
- Specified by:
strictin interfacecom.applitools.ICheckSettings- Overrides:
strictin classcom.applitools.eyes.fluent.CheckSettings
-
layout
- Specified by:
layoutin interfacecom.applitools.ICheckSettings- Overrides:
layoutin classcom.applitools.eyes.fluent.CheckSettings
-
dynamic
- Specified by:
dynamicin interfacecom.applitools.ICheckSettings- Overrides:
dynamicin classcom.applitools.eyes.fluent.CheckSettings
-
exact
- Specified by:
exactin interfacecom.applitools.ICheckSettings- Overrides:
exactin classcom.applitools.eyes.fluent.CheckSettings
-
lazyLoad
- Specified by:
lazyLoadin interfacecom.applitools.ICheckSettings- Overrides:
lazyLoadin classcom.applitools.eyes.fluent.CheckSettings
-
lazyLoad
- Specified by:
lazyLoadin interfacecom.applitools.ICheckSettings- Overrides:
lazyLoadin classcom.applitools.eyes.fluent.CheckSettings
-
densityMetrics
- Specified by:
densityMetricsin interfacecom.applitools.ICheckSettings- Overrides:
densityMetricsin classcom.applitools.eyes.fluent.CheckSettings
-
densityMetrics
- Specified by:
densityMetricsin interfacecom.applitools.ICheckSettings- Overrides:
densityMetricsin classcom.applitools.eyes.fluent.CheckSettings
-
clone
Create a new clone of this settings object.- Specified by:
clonein interfacecom.applitools.ICheckSettingsInternal- Overrides:
clonein classcom.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
internal -
getLazyLoadOptions
public com.applitools.eyes.LazyLoadOptions getLazyLoadOptions()internal- Overrides:
getLazyLoadOptionsin classcom.applitools.eyes.fluent.CheckSettings
-
getIgnoreRegions
public com.applitools.eyes.fluent.GetRegion[] getIgnoreRegions()internal- Specified by:
getIgnoreRegionsin interfacecom.applitools.eyes.fluent.ICheckSettingsInternal- Overrides:
getIgnoreRegionsin classcom.applitools.eyes.fluent.CheckSettings
-
getLayoutRegions
public com.applitools.eyes.fluent.GetRegion[] getLayoutRegions()internal- Specified by:
getLayoutRegionsin interfacecom.applitools.eyes.fluent.ICheckSettingsInternal- Overrides:
getLayoutRegionsin classcom.applitools.eyes.fluent.CheckSettings
-
getStrictRegions
public com.applitools.eyes.fluent.GetRegion[] getStrictRegions()internal- Specified by:
getStrictRegionsin interfacecom.applitools.eyes.fluent.ICheckSettingsInternal- Overrides:
getStrictRegionsin classcom.applitools.eyes.fluent.CheckSettings
-
getContentRegions
public com.applitools.eyes.fluent.GetRegion[] getContentRegions()internal- Specified by:
getContentRegionsin interfacecom.applitools.eyes.fluent.ICheckSettingsInternal- Overrides:
getContentRegionsin classcom.applitools.eyes.fluent.CheckSettings
-
getFloatingRegions
public com.applitools.eyes.fluent.GetRegion[] getFloatingRegions()internal- Specified by:
getFloatingRegionsin interfacecom.applitools.eyes.fluent.ICheckSettingsInternal- Overrides:
getFloatingRegionsin classcom.applitools.eyes.fluent.CheckSettings
-
getAccessibilityRegions
public com.applitools.eyes.fluent.GetRegion[] getAccessibilityRegions()internal- Specified by:
getAccessibilityRegionsin interfacecom.applitools.eyes.fluent.ICheckSettingsInternal- Overrides:
getAccessibilityRegionsin classcom.applitools.eyes.fluent.CheckSettings
-
getDynamicRegions
public com.applitools.eyes.fluent.GetRegion[] getDynamicRegions()internal- Specified by:
getDynamicRegionsin interfacecom.applitools.eyes.fluent.ICheckSettingsInternal- Overrides:
getDynamicRegionsin classcom.applitools.eyes.fluent.CheckSettings
-
content
Deprecated.seeignoreColors()- Specified by:
contentin interfacecom.applitools.ICheckSettings- Overrides:
contentin classcom.applitools.eyes.fluent.CheckSettings
-
content
Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
@Deprecated public PlaywrightCheckSettings content(com.microsoft.playwright.Locator locator, String regionId) Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
@Deprecated public PlaywrightCheckSettings content(com.microsoft.playwright.ElementHandle element, String regionId) Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
@Deprecated public PlaywrightCheckSettings content(String selector, com.applitools.eyes.Padding padding) Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
@Deprecated public PlaywrightCheckSettings content(com.microsoft.playwright.Locator locator, com.applitools.eyes.Padding padding) Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
@Deprecated public PlaywrightCheckSettings content(com.microsoft.playwright.ElementHandle element, com.applitools.eyes.Padding padding) Deprecated.- Specified by:
contentin interfaceIPlaywrightCheckSettings
-
content
Deprecated.- Specified by:
contentin interfacecom.applitools.ICheckSettings- Overrides:
contentin classcom.applitools.eyes.fluent.CheckSettings
-
content
@Deprecated public PlaywrightCheckSettings content(com.applitools.eyes.Region region, com.applitools.eyes.Region... regions) Deprecated.- Specified by:
contentin interfacecom.applitools.ICheckSettings- Overrides:
contentin classcom.applitools.eyes.fluent.CheckSettings
-
setHideCaret
Deprecated.- Overrides:
setHideCaretin classcom.applitools.eyes.fluent.CheckSettings
-
setHideScrollBars
Deprecated.- Overrides:
setHideScrollBarsin classcom.applitools.eyes.fluent.CheckSettings
-