ocrWaitForTextDisplayed

等待屏幕上显示特定文本。

用法

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
});

输出

日志

[0-0] 2024-05-26T04:32:52.005Z INFO webdriver: COMMAND ocrWaitForTextDisplayed(<object>)
......................
# ocrWaitForTextDisplayed uses ocrGetElementPositionByText under the hood, that is why you see the command ocrGetElementPositionByText in the logs
[0-0] 2024-05-26T04:32:52.735Z INFO @wdio/ocr-service:ocrGetElementPositionByText: Multiple matches were found based on the word "specFileRetries". The match "specFileRetries" with score "100%" will be used.

选项

text

• 类型： string
• 必填： 是

您要搜索以点击的文本。

示例

await browser.ocrWaitForTextDisplayed({ text: "specFileRetries" });

timeout

• 类型： number
• 必填： 否
• 默认值： 18000（18 秒）

以毫秒为单位的时间。请注意，OCR 过程可能需要一些时间，因此请不要将其设置得太低。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries"
    timeout: 25000 // wait for 25 seconds
});

timeoutMsg

• 类型： string
• 必填： 否
• 默认值： 在请求的时间内找不到文本“{selector}”。

它覆盖默认错误消息。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries"
    timeoutMsg: "My new timeout message."
});

contrast

• 类型： number
• 必填： 否
• 默认值： 0.25

对比度越高，图像越暗，反之亦然。这可以帮助在图像中查找文本。它接受介于-1和1之间的值。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    contrast: 0.5,
});

haystack

• 类型： number
• 必填： WebdriverIO.Element | ChainablePromiseElement | Rectangle

这是屏幕上 OCR 需要查找文本的搜索区域。这可以是包含x、y、width和height的元素或矩形。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    haystack: $("elementSelector"),
});

// OR
await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    haystack: await $("elementSelector"),
});

// OR
await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    haystack: {
        x: 10,
        y: 50,
        width: 300,
        height: 75,
    },
});

language

• 类型： string
• 必填： 否
• 默认值： eng

Tesseract 将识别的语言。更多信息可以在此处找到，支持的语言可以在此处找到。

示例

import { SUPPORTED_OCR_LANGUAGES } from "@wdio/ocr-service";
await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    // Use Dutch as a language
    language: SUPPORTED_OCR_LANGUAGES.DUTCH,
});

fuzzyFindOptions

您可以使用以下选项更改模糊逻辑以查找文本。这可能有助于找到更好的匹配项

fuzzyFindOptions.distance

• 类型： number
• 必填： 否
• 默认值 100

确定匹配项必须与模糊位置（由位置指定）有多接近。与模糊位置相距 distance 个字符的精确字母匹配将被计为完全不匹配。距离为 0 要求匹配项位于指定的确切位置。距离为 1000 则要求完美匹配在距离位置 800 个字符以内才能使用阈值为 0.8 找到。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    fuzzyFindOptions: {
        distance: 20,
    },
});

fuzzyFindOptions.location

• 类型： number
• 必填： 否
• 默认值 0

确定文本中大约在哪个位置预期找到模式。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    fuzzyFindOptions: {
        location: 20,
    },
});

fuzzyFindOptions.threshold

• 类型： number
• 必填： 否
• 默认值 0.6

匹配算法在什么点放弃。阈值为 0 要求完全匹配（字母和位置），阈值为 1.0 将匹配任何内容。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    fuzzyFindOptions: {
        threshold: 0.8,
    },
});

fuzzyFindOptions.isCaseSensitive

• 类型： boolean
• 必填： 否
• 默认值： false

搜索是否区分大小写。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    fuzzyFindOptions: {
        isCaseSensitive: true,
    },
});

fuzzyFindOptions.minMatchCharLength

• 类型： number
• 必填： 否
• 默认值 2

只有长度超过此值的匹配项才会返回。（例如，如果要忽略结果中的单个字符匹配项，则将其设置为 2）

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    fuzzyFindOptions: {
        minMatchCharLength: 5,
    },
});

fuzzyFindOptions.findAllMatches

• 类型： number
• 必填： 否
• 默认值： false

当true时，即使在字符串中已经找到完美匹配项，匹配函数也将继续到搜索模式的末尾。

示例

await browser.ocrWaitForTextDisplayed({
    text: "specFileRetries",
    fuzzyFindOptions: {
        findAllMatches: 100,
    },
});