Praman — Agent-First SAP UI5 Test Automation Plugin - v1.3.5
    Preparing search index...

    Interface VisualRegressionOptions

    Options for visual regression screenshot comparison.

    visualRegression.options

    const opts: VisualRegressionOptions = {
      threshold: 0.1,
      mask: visualRegression.maskFLPChrome(),
      fullPage: true,
    };
    interface VisualRegressionOptions {
        fullPage?: boolean;
        mask?: Locator[];
        maskColor?: string;
        maxDiffPixelRatio?: number;
        maxDiffPixels?: number;
        threshold?: number;
    }
    Index
    fullPage? mask? maskColor? maxDiffPixelRatio? maxDiffPixels? threshold?
    fullPage?: boolean

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

    mask?: Locator[]

    Locators to mask with a solid colour rectangle.

    maskColor?: string

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

    maxDiffPixelRatio?: number

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

    maxDiffPixels?: number

    Maximum number of different pixels before the assertion fails.

    threshold?: number

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

    Settings
    Member Visibility

    On This Page
    Properties