Skip to content
This repository was archived by the owner on Dec 24, 2023. It is now read-only.

Update OPTIONS.md #16

Merged
merged 1 commit into from
May 22, 2019
Merged

Update OPTIONS.md #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/OPTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,12 +448,11 @@ This will retun all compare data, not only the mismatch percentage

Allowable value of misMatchPercentage that prevents saving image with differences


### `largeImageThreshold`
- **Type:** `number`
- **Default:** `0`
- **Mandatory:** no
- **Remark:** *Can also be used for `checkElement`, `checkScreen()` and `checkFullPageScreen()`. It will override the plugin setting*
### `largeImageThreshold`
- **Type:** `number`
- **Default:** `0`
- **Mandatory:** no
- **Remark:** *Can also be used for `checkElement`, `checkScreen()` and `checkFullPageScreen()`. It will override the plugin setting*

Comparing large images can lead to performance issues.
When providing a number for the amount of pixels here (higher then 0), the comparison algorithm skips pixels when the image width or height is larger than `largeImageThreshold` pixels.
Comparing large images can lead to performance issues.
When providing a number for the amount of pixels here (higher then 0), the comparison algorithm skips pixels when the image width or height is larger than `largeImageThreshold` pixels.