Skip to main content
Version: 1.x

Interface: VisualRegressionOptions

Options for visual regression screenshot comparison.

Capability​

visualRegression.options

Example​

const opts: VisualRegressionOptions = {
  threshold: 0.1,
  mask: visualRegression.maskFLPChrome(),
  fullPage: true,
};

Properties​

fullPage?​

optional fullPage?: boolean

Capture the full scrollable page instead of the viewport. Default: false.

mask?​

optional mask?: Locator[]

Locators to mask with a solid colour rectangle.

maskColor?​

optional maskColor?: string

Colour used to fill masked regions. Default: '#FF00FF'.

maxDiffPixelRatio?​

optional maxDiffPixelRatio?: number

Maximum ratio of different pixels (0-1) before the assertion fails.

maxDiffPixels?​

optional maxDiffPixels?: number

Maximum number of different pixels before the assertion fails.

threshold?​

optional threshold?: number

Per-pixel colour distance threshold (0-1). Default: 0.2.