schema_visual-visual-test-object.md

Visual test object Schema

schema_visual.json#/items

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	schema_visual.json*

items Type

object (Visual test object)

items Properties

Property	Type	Required	Nullable	Defined by
name	string	Required	cannot be null	Visual config file
path	string	Required	cannot be null	Visual config file
directory	string	Optional	cannot be null	Visual config file
sensitivity	number	Optional	cannot be null	Visual config file
allowedDifference	number	Optional	cannot be null	Visual config file
delay	number	Optional	cannot be null	Visual config file
maxScreenshots	Merged	Optional	cannot be null	Visual config file
scrollPage	boolean	Optional	cannot be null	Visual config file
createDiffImg	boolean	Optional	cannot be null	Visual config file
before	array	Optional	cannot be null	Visual config file

name

Name of the test case

name

• is required

• Type: string

• cannot be null

• defined in: Visual config file

name Type

string

path

Pathname to the website page (relative to hostname)

path

• is required

• Type: string

• cannot be null

• defined in: Visual config file

path Type

string

path Constraints

pattern: the string must match the following regular expression:

^/

try pattern

directory

Path to the screenshot dir

directory

• is optional

• Type: string

• cannot be null

• defined in: Visual config file

directory Type

string

directory Default Value

The default value is:

"./_results/screenshots"

sensitivity

Comparison sensitivity threshold (in float between 0 and 1, larger is more sensitive)

sensitivity

• is optional

• Type: number

• cannot be null

• defined in: Visual config file

sensitivity Type

number

sensitivity Constraints

maximum: the value of this number must smaller than or equal to: 1

minimum: the value of this number must greater than or equal to: 0

sensitivity Default Value

The default value is:

0.9

allowedDifference

Allowed number of different pixels for images to be considered similar (in px)

allowedDifference

• is optional

• Type: number

• cannot be null

• defined in: Visual config file

allowedDifference Type

number

allowedDifference Constraints

minimum: the value of this number must greater than or equal to: 0

delay

Delay (in ms) to wait after page load and before making the screenshot

delay

• is optional

• Type: number

• cannot be null

• defined in: Visual config file

delay Type

number

delay Constraints

minimum: the value of this number must greater than or equal to: 0

maxScreenshots

Number of recent screenshots to store. If false, old screenshots will not be deleted

maxScreenshots

• is optional

• Type: merged type (Details)

• cannot be null

• defined in: Visual config file

maxScreenshots Type

merged type (Details)

one (and only one) of

• Untitled number in Visual config file

• Untitled boolean in Visual config file

scrollPage

Whether to automatically scroll to the bottom of the page

scrollPage

• is optional

• Type: boolean

• cannot be null

• defined in: Visual config file

scrollPage Type

boolean

scrollPage Default Value

The default value is:

true

createDiffImg

Whether to place the differential png file in the screenshots folder

createDiffImg

• is optional

• Type: boolean

• cannot be null

• defined in: Visual config file

createDiffImg Type

boolean

before

Execute actions before performing the check

before

• is optional

• Type: an array of merged types (Before section)

• cannot be null

• defined in: Visual config file

before Type

an array of merged types (Before section)