You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+40-16Lines changed: 40 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -172,26 +172,50 @@ public class Example {
172
172
-`driver` (**required**) - A selenium driver instance
173
173
-`name` (**required**) - The screenshot name; must be unique to each screenshot
174
174
-`options` (**optional**) - There are various options supported by percy.screenshot to server further functionality.
175
-
-`freezeAnimation` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations.
175
+
-`freezeAnimatedImage` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations.
176
+
-`freezeImageBySelectors` - List of selectors. Images will be freezed which are passed using selectors. For this to work `freezeAnimatedImage` must be set to true.
177
+
-`freezeImageByXpaths` - List of xpaths. Images will be freezed which are passed using xpaths. For this to work `freezeAnimatedImage` must be set to true.
176
178
-`percyCSS` - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.
177
-
-`ignoreRegionXpaths` - elements in the DOM can be ignored using xpath
178
-
-`ignoreRegionSelectors` - elements in the DOM can be ignored using selectors.
179
-
-`ignoreRegionSeleniumElements` - elements can be ignored using selenium_elements.
180
-
-`customIgnoreRegions` - elements can be ignored using custom boundaries
181
-
- IgnoreRegion:-
182
-
- Description: This class represents a rectangular area on a screen that needs to be ignored for visual diff.
183
-
184
-
- Constructor:
179
+
-`ignoreRegionXpaths` - List of xpaths. elements in the DOM can be ignored using xpath
180
+
-`ignoreRegionSelectors` - List of selectors. elements in the DOM can be ignored using selectors.
181
+
-`ignoreRegionSeleniumElements` - List of selenium web-element. elements can be ignored using selenium_elements.
182
+
-`customIgnoreRegions` - List of custom objects. elements can be ignored using custom boundaries
183
+
- Refer to example -
184
+
-```
185
+
List<HashMap> customRegion = new ArrayList<>();
186
+
HashMap<String, Integer> region1 = new HashMap<>();
- `top` (int): Top coordinate of the ignore region.
196
+
- `bottom` (int): Bottom coordinate of the ignore region.
197
+
- `left` (int): Left coordinate of the ignore region.
198
+
- `right` (int): Right coordinate of the ignore region.
199
+
- `considerRegionXpaths` - List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths.
200
+
- `considerRegionSelectors` - List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors.
201
+
- `considerRegionSeleniumElements` - List of selenium web-element. elements can be considered for diffing and will be ignored by Intelli Ignore using selenium_elements.
202
+
- `customConsiderRegions` - List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundaries
203
+
- Refer to example -
204
+
- ```
205
+
List<HashMap> customRegion = new ArrayList<>();
206
+
HashMap<String, Integer> region2 = new HashMap<>();
`bottom` (int): Bottom coordinate of the ignore region.
191
-
`left` (int): Left coordinate of the ignore region.
192
-
`right` (int): Right coordinate of the ignore region.
193
-
- Raises:ValueError: If top, bottom, left, or right is less than 0 or top is greater than or equal to bottom or left is greater than or equal to right.
194
-
- valid: Ignore region should be within the boundaries of the screen.
215
+
- `top` (int): Top coordinate of the consider region.
216
+
- `bottom` (int): Bottom coordinate of the consider region.
217
+
- `left` (int): Left coordinate of the consider region.
218
+
- `right` (int): Right coordinate of the consider region.
195
219
196
220
### Creating Percy on automate build
197
221
Note: Automate Percy Token starts with `auto` keyword. The command can be triggered using `exec` keyword.
0 commit comments