ImageMatchSettings (eyes-common-java3 3.37.1 API)

java.lang.Object
- com.applitools.eyes.ImageMatchSettings

public class ImageMatchSettings
extends Object

Encapsulates match settings for the a session.

Constructor Summary

Constructors
Constructor and Description
`ImageMatchSettings()` See `ImageMatchSettings(MatchLevel, ExactMatchSettings)`.
`ImageMatchSettings(MatchLevel matchLevel, ExactMatchSettings exact)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Region[]`	`getContentRegions()` Returns the array of regions to check using the Content method.
`ExactMatchSettings`	`getExact()`
`FloatingMatchSettings[]`	`getFloatingRegions()` Returns an array of floating regions.
`Boolean`	`getIgnoreCaret()`
`Region[]`	`getIgnoreRegions()` Returns the array of regions to ignore.
`Region[]`	`getLayoutRegions()` Returns the array of regions to check using the Layout method.
`MatchLevel`	`getMatchLevel()`
`Region[]`	`getStrictRegions()` Returns the array of regions to check using the Strict method.
`void`	`setContentRegions(Region[] contentRegions)` Sets an array of regions to check using the Content method.
`void`	`setExact(ExactMatchSettings exact)`
`void`	`setFloatingRegions(FloatingMatchSettings[] floatingRegions)` Sets an array of floating regions.
`void`	`setIgnoreCaret(Boolean ignoreCaret)`
`void`	`setIgnoreRegions(Region[] ignoreRegions)` Sets an array of regions to ignore.
`void`	`setLayoutRegions(Region[] layoutRegions)` Sets an array of regions to check using the Layout method.
`void`	`setMatchLevel(MatchLevel matchLevel)`
`void`	`setStrictRegions(Region[] strictRegions)` Sets an array of regions to check using the Strict method.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ImageMatchSettings
```
public ImageMatchSettings(MatchLevel matchLevel,
                          ExactMatchSettings exact)
```
  - ImageMatchSettings
```
public ImageMatchSettings()
```
    See ImageMatchSettings(MatchLevel, ExactMatchSettings). matchLevel defaults to STRICT, exact defaults to null.
- Method Detail
  - getMatchLevel
```
public MatchLevel getMatchLevel()
```
    Returns:
    
    The "strictness" level of the match.
  - setMatchLevel
```
public void setMatchLevel(MatchLevel matchLevel)
```
    Parameters:
    
    matchLevel - The "strictness" level of the match.
  - getExact
```
public ExactMatchSettings getExact()
```
    Returns:
    
    The parameters for the "Exact" match settings.
  - setExact
```
public void setExact(ExactMatchSettings exact)
```
    Parameters:
    
    exact - The parameters for the "exact" match settings.
  - getIgnoreCaret
```
public Boolean getIgnoreCaret()
```
    Returns:
    
    The parameters for the "IgnoreCaret" match settings.
  - setIgnoreRegions
```
public void setIgnoreRegions(Region[] ignoreRegions)
```
    Sets an array of regions to ignore.
    
    Parameters:
    
    ignoreRegions - The array of regions to ignore.
  - setLayoutRegions
```
public void setLayoutRegions(Region[] layoutRegions)
```
    Sets an array of regions to check using the Layout method.
    
    Parameters:
    
    layoutRegions - The array of regions to ignore.
  - setStrictRegions
```
public void setStrictRegions(Region[] strictRegions)
```
    Sets an array of regions to check using the Strict method.
    
    Parameters:
    
    strictRegions - The array of regions to ignore.
  - setContentRegions
```
public void setContentRegions(Region[] contentRegions)
```
    Sets an array of regions to check using the Content method.
    
    Parameters:
    
    contentRegions - The array of regions to ignore.
  - getIgnoreRegions
```
public Region[] getIgnoreRegions()
```
    Returns the array of regions to ignore.
    
    Returns:
    
    the array of regions to ignore.
  - getStrictRegions
```
public Region[] getStrictRegions()
```
    Returns the array of regions to check using the Strict method.
    
    Returns:
    
    the array of regions to check using the Strict method.
  - getLayoutRegions
```
public Region[] getLayoutRegions()
```
    Returns the array of regions to check using the Layout method.
    
    Returns:
    
    the array of regions to check using the Layout method.
  - getContentRegions
```
public Region[] getContentRegions()
```
    Returns the array of regions to check using the Content method.
    
    Returns:
    
    the array of regions to check using the Content method.
  - setFloatingRegions
```
public void setFloatingRegions(FloatingMatchSettings[] floatingRegions)
```
    Sets an array of floating regions.
    
    Parameters:
    
    floatingRegions - The array of floating regions.
  - getFloatingRegions
```
public FloatingMatchSettings[] getFloatingRegions()
```
    Returns an array of floating regions.
    
    Returns:
    
    an array of floating regions.
  - setIgnoreCaret
```
public void setIgnoreCaret(Boolean ignoreCaret)
```
    Parameters:
    
    ignoreCaret - The parameters for the "ignoreCaret" match settings.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ImageMatchSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageMatchSettings

ImageMatchSettings

Method Detail

getMatchLevel

setMatchLevel

getExact

setExact

getIgnoreCaret

setIgnoreRegions

setLayoutRegions

setStrictRegions

setContentRegions

getIgnoreRegions

getStrictRegions

getLayoutRegions

getContentRegions

setFloatingRegions

getFloatingRegions

setIgnoreCaret

toString