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の場合、しきい値0.8を使用して検出するには、完全一致がロケーションから800文字以内である必要があります。

例

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

長さがこの値を超える一致のみが返されます。（たとえば、結果で1文字の一致を無視する場合は、2に設定します）

例

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

fuzzyFindOptions.findAllMatches

• タイプ: number
• 必須: いいえ
• デフォルト: false

trueの場合、マッチング関数は、文字列内で完全一致が既に見つかっていても、検索パターンの最後まで続行します。

例

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