Skip to content

Commit cecb45b

Browse files
authored
docs: add score in image elements (appium#14113)
* docs: add score in image elements * tweak * fix review
1 parent c6cb1c6 commit cecb45b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Diff for: docs/en/advanced-concepts/image-elements.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ If the image match is successful, Appium will cache information about the match
1818
* `getLocation`
1919
* `getLocationInView`
2020
* `getElementRect`
21-
* `getAttribute` (only `visual` attribute)
21+
* `getAttribute`
22+
* `visual` returns matched image as base64 data if `getMatchedImageResult` is `true`
23+
* `score` returns the similarity score as a float number in range `[0.0, 1.0]` sine Appium 1.18.0
2224

2325
These actions are supported on "Image Elements" because they are the actions which involve only use of screen position for their functioning. Other actions (like `sendKeys`, for example) are not supported, because all Appium can know based on your template image is whether or not there is a screen region which visually matches it--Appium has no way of turning that information into a driver-specific UI element object, which would be necessary for the use of other actions.
2426

0 commit comments

Comments
 (0)