MatchingResult对象
## 匹配结果 |matches
| 方法名 | 返回值 | 备注 |
| -------------- | -------- | ------------------------------------------------------ |
| matches | | 返回图片image在点(x, y)处的像素的ARGB值。 |
| **参数名** | **类型** | |
| 匹配结果的数组 | 数组 | `point` {Point} 匹配位置、`similarity` {number} 相似度 |
```javascript
var result = images.matchTemplate(img, template, {
max: 100
});
result.matches.forEach(match => {
log("point = " + match.point + ", similarity = " + match.similarity);
});
```
## 匹配位置 |points
| 方法名 | 返回值 | 备注 |
| -------------- | -------- | -------------- |
| points | | 匹配位置的数组 |
| **参数名** | **类型** | |
| 匹配位置的数组 | 数组 | |
## 第一个匹配结果 |first
| 方法名 | 返回值 | 备注 |
| ------- | ------ | ------------------------------------------------ |
| first() | Match | 第一个匹配结果。如果没有任何匹配,则返回`null`。 |
## 最后一个匹配结果 |last
| 方法名 | 返回值 | 备注 |
| ------ | ------ | -------------------------------------------------- |
| last() | Match | 最后一个匹配结果。如果没有任何匹配,则返回`null`。 |
## 最左边的匹配结果 |leftmost
| 方法名 | 返回值 | 备注 |
| ---------- | ------ | ------------------------------------------------------------ |
| leftmost() | Match | 位于大图片最左边的匹配结果。如果没有任何匹配,则返回`null`。 |
## 最上边的匹配结果 |topmost
| 方法名 | 返回值 | 备注 |
| --------- | ------ | ------------------------------------------------------------ |
| topmost() | Match | 位于大图片最上边的匹配结果。如果没有任何匹配,则返回`null`。 |
## 最右边的匹配结果 |rightmost
| 方法名 | 返回值 | 备注 |
| ----------- | ------ | ------------------------------------------------------------ |
| rightmost() | Match | 位于大图片最右边的匹配结果。如果没有任何匹配,则返回`null`。 |
## 最下边的匹配结果 |bottommost
| 方法名 | 返回值 | 备注 |
| ------------ | ------ | ------------------------------------------------------------ |
| bottommost() | Match | 位于大图片最下边的匹配结果。如果没有任何匹配,则返回`null`。 |
## 相似度最高的匹配结果 |best
| 方法名 | 返回值 | 备注 |
| ------ | ------ | ------------------------------------------------------ |
| best() | Match | 相似度最高的匹配结果。如果没有任何匹配,则返回`null`。 |
## 相似度最低的匹配结果 |worst
| 方法名 | 返回值 | 备注 |
| ------- | ------ | ------------------------------------------------------ |
| worst() | Match | 相似度最低的匹配结果。如果没有任何匹配,则返回`null`。 |
## 对匹配结果进行排序 |sortBy
| 方法名 | 返回值 | 备注 |
| ---------- | --------------- | ------------------------------------------------------------ |
| sortBy() | Match | 对匹配结果进行排序,并返回排序后的结果。 |
| **参数名** | **类型** | |
| 比较函数 | Function/string | 比较函数,或者是一个字符串表示排序方向。例如"left"表示将匹配结果按匹配位置从左往右排序、"top"表示将匹配结果按匹配位置从上往下排序,"left-top"表示将匹配结果按匹配位置从左往右、从上往下排序。方向包括left(左), top (上), right (右), bottom(下)。 |
```javascript
//对匹配结果进行排序,并返回排序后的结果。
var result = images.matchTemplate(img, template, {
max: 100
});
log(result.sortBy("top-right"));
```