メインコンテンツへスキップ

ocrSetValue

要素にキーストロークのシーケンスを送信します。以下を実行します。

  • 自動的に要素を検出します。
  • クリックしてフィールドにフォーカスを当てます。
  • フィールドに値を設定します。

このコマンドは、指定されたテキストを検索し、Fuse.jsのファジーロジックに基づいて一致を見つけようとします。つまり、スペルミスのあるセレクターを指定した場合や、見つかったテキストが100％一致しない場合でも、要素を返そうとします。下記のログを参照してください。

使い方​

await brower.ocrSetValue({
    text: "docs",
    value: "specfileretries",
});

出力​

ログ​

[0-0] 2024-05-26T04:17:51.355Z INFO webdriver: COMMAND ocrSetValue(<object>)
......................
[0-0] 2024-05-26T04:17:52.356Z INFO @wdio/ocr-service:ocrGetElementPositionByText: We searched for the word "docs" and found one match "docs" with score "100%"

オプション​

text​

  • タイプ: string
  • 必須: はい

クリックするテキストを検索します。

例​

await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
});

value​

  • タイプ: string
  • 必須: はい

追加する値。

例​

await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
});

submitValue​

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

値を入力フィールドに送信する必要があるかどうか。つまり、文字列の最後に「ENTER」が送信されます。

例​

await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    submitValue: true,
});

clickDuration​

  • タイプ: number
  • 必須: いいえ
  • デフォルト: 500ミリ秒

これはクリックの持続時間です。時間を長くすることで「長押しクリック」を作成することもできます。

例​

await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    clickDuration: 3000, // This is 3 seconds
});

contrast​

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

コントラストが高いほど画像は暗くなり、その逆も同様です。これは画像内のテキストを見つけるのに役立ちます。-1から1の間の値を受け入れます。

例​

await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    contrast: 0.5,
});

haystack​

  • タイプ: number
  • 必須: WebdriverIO.Element | ChainablePromiseElement | Rectangle

これは、OCRがテキストを検索する必要がある画面上の検索領域です。これは、x、y、width、heightを含む要素または長方形にすることができます。

例​

await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    haystack: $("elementSelector"),
});

// OR
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    haystack: await $("elementSelector"),
});

// OR
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    haystack: {
        x: 10,
        y: 50,
        width: 300,
        height: 75,
    },
});

language​

  • タイプ: string
  • 必須: いいえ
  • デフォルト: eng

Tesseractが認識する言語。詳細についてはこちらをご覧ください。サポートされている言語についてはこちらをご覧ください。

例​

import { SUPPORTED_OCR_LANGUAGES } from "@wdio/ocr-service";
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    // Use Dutch as a language
    language: SUPPORTED_OCR_LANGUAGES.DUTCH,
});

relativePosition​

  • タイプ: object
  • 必須: いいえ

一致する要素に対して相対的に画面をクリックできます。これは、一致する要素からの相対ピクセルabove、right、belowまたはleftに基づいて行うことができます。

注意

次の組み合わせが許可されています

  • 単一のプロパティ
  • above + left または above + right
  • below + left または below + right

次の組み合わせは許可されていません

  • aboveプラスbelow
  • leftプラスright

relativePosition.above​

  • タイプ: number
  • 必須: いいえ

一致する要素のabove xピクセルをクリックします。

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    relativePosition: {
        above: 100,
    },
});

relativePosition.right​

  • タイプ: number
  • 必須: いいえ

一致する要素のright xピクセルをクリックします。

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    relativePosition: {
        right: 100,
    },
});

relativePosition.below​

  • タイプ: number
  • 必須: いいえ

一致する要素のbelow xピクセルをクリックします。

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    relativePosition: {
        below: 100,
    },
});

relativePosition.left​

  • タイプ: number
  • 必須: いいえ

一致する要素のleft xピクセルをクリックします。

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    relativePosition: {
        left: 100,
    },
});

fuzzyFindOptions​

以下のオプションを使用して、テキストを見つけるためのファジーロジックを変更できます。これにより、より良い一致を見つけるのに役立つ場合があります。

fuzzyFindOptions.distance​

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

一致がファジーロケーション（ロケーションで指定）にどれだけ近い必要があるかを決定します。ファジーロケーションからdistance文字離れた完全一致は、完全な不一致としてスコア付けされます。distanceが0の場合、一致は指定された正確な場所にある必要があります。distanceが1000の場合、0.8の閾値を使用して見つけるには、完全一致がロケーションから800文字以内にある必要があります。

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    fuzzyFindOptions: {
        distance: 20,
    },
});

fuzzyFindOptions.location​

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

テキスト内でパターンが見つかると予想されるおおよその場所を決定します。

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    fuzzyFindOptions: {
        location: 20,
    },
});

fuzzyFindOptions.threshold​

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

マッチングアルゴリズムが諦めるポイント。0の閾値は完全一致（文字とロケーションの両方）を必要とし、1.0の閾値はすべてに一致します。

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    fuzzyFindOptions: {
        threshold: 0.8,
    },
});

fuzzyFindOptions.isCaseSensitive​

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

検索で大文字と小文字を区別するかどうか。

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    fuzzyFindOptions: {
        isCaseSensitive: true,
    },
});

fuzzyFindOptions.minMatchCharLength​

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

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

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    fuzzyFindOptions: {
        minMatchCharLength: 5,
    },
});

fuzzyFindOptions.findAllMatches​

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

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

例​
await browser.ocrSetValue({
    text: "WebdriverIO",
    value: "The Value",
    fuzzyFindOptions: {
        findAllMatches: 100,
    },
});

ようこそ！何かお手伝いできることはありますか？

WebdriverIO AI Copilot