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

メソッドオプション

メソッドオプションは、メソッドごとに設定できるオプションです。オプションのキーがプラグインのインスタンス化時に設定されたオプションと同じ場合、このメソッドオプションはプラグインオプションの値を上書きします。

保存オプション​

disableBlinkingCursor​

  • 型: boolean
  • 必須: いいえ
  • デフォルト: false
  • サポート: Web、ハイブリッドアプリ（Webview）

アプリケーション内のすべてのinput、textarea、[contenteditable]のカーソル「点滅」を有効/無効にします。trueに設定すると、スクリーンショット撮影前にカーソルがtransparentに設定され、 終了時に元に戻されます

disableCSSAnimation​

  • 型: boolean
  • 必須: いいえ
  • デフォルト: false
  • サポート: Web、ハイブリッドアプリ（Webview）

アプリケーション内のすべてのCSSアニメーションを有効/無効にします。trueに設定すると、スクリーンショット撮影前にすべてのアニメーションが無効になり、 終了時に元に戻されます

enableLegacyScreenshotMethod​

  • 型: boolean
  • 必須: いいえ
  • デフォルト: false
  • サポート: Web、ハイブリッドアプリ（Webview）

このオプションを使用して、W3C-WebDriverプロトコルに基づく「古い」スクリーンショット方式に戻すことができます。これは、テストが既存のベースライン画像に依存している場合や、BiDiベースのスクリーンショットを完全にサポートしていない環境で実行している場合に役立ちます。 このオプションを有効にすると、解像度や品質が若干異なるスクリーンショットが生成される場合があることに注意してください。

enableLayoutTesting​

  • 型: boolean
  • 必須: いいえ
  • デフォルト: false
  • 使用先: すべてのメソッド
  • サポート: Web

ページ上のすべてのテキストを非表示にし、比較にはレイアウトのみが使用されるようにします。非表示は、__各__要素に'color': 'transparent !important'スタイルを追加することで行われます。

出力結果についてはテスト出力を参照してください

情報

このフラグを使用すると、テキストを含むすべての要素（p, h1, h2, h3, h4, h5, h6, span, a, liだけでなく、div|button|..なども）にこのプロパティが適用されます。これをカスタマイズするオプションは__ありません__。

hideScrollBars​

  • 型: boolean
  • 必須: いいえ
  • デフォルト: true
  • 使用先: すべてのメソッド
  • サポート: Web、ハイブリッドアプリ（Webview）

アプリケーションのスクロールバーを非表示にします。trueに設定すると、スクリーンショット撮影前にすべてのスクロールバーが無効になります。追加の問題を防ぐためにデフォルトでtrueに設定されています。

hideElements​

  • 型: array
  • 必須: いいえ
  • 使用先: すべてのメソッド
  • サポート: Web、ハイブリッドアプリ（Webview）、ネイティブアプリ

このメソッドでは、要素の配列を提供することで、1つまたは複数の要素にvisibility: hiddenプロパティを追加して非表示にすることができます。

removeElements​

  • 型: array
  • 必須: いいえ
  • 使用先: すべてのメソッド
  • サポート: Web、ハイブリッドアプリ（Webview）、ネイティブアプリ

このメソッドでは、要素の配列を提供することで、1つまたは複数の要素にdisplay: noneプロパティを追加して_削除_することができます。

resizeDimensions​

  • 型: object
  • 必須: いいえ
  • デフォルト: { top: 0, right: 0, bottom: 0, left: 0}
  • 使用先: saveElementまたはcheckElementのみ
  • サポート: Web、ハイブリッドアプリ（Webview）、ネイティブアプリ

要素の切り抜きを大きくするために必要なtop、right、bottom、leftのピクセル数を含むオブジェクト。

userBasedFullPageScreenshot​

  • 型: boolean
  • 必須: いいえ
  • デフォルト: false
  • サポート: Web、ハイブリッドアプリ（Webview）

trueに設定すると、このオプションは全ページスクリーンショットをキャプチャするためのスクロールと連結戦略を有効にします。 ブラウザのネイティブスクリーンショット機能を使用する代わりに、ページを手動でスクロールし、複数のスクリーンショットを連結します。 このメソッドは、遅延読み込みコンテンツを持つページや、完全に描画するためにスクロールが必要な複雑なレイアウトに特に有用です。

fullPageScrollTimeout​

スクロール後に待機するミリ秒単位のタイムアウト。これは遅延読み込みを持つページの識別に役立つ場合があります。

注: これはuserBasedFullPageScreenshotがtrueに設定されている場合にのみ機能します

hideAfterFirstScroll​

このメソッドは、要素の配列を提供することで、1つまたは複数の要素にvisibility: hiddenプロパティを追加して非表示にします。 これは、ページがスクロールされるとページと一緒にスクロールするスティッキー要素があるが、全ページスクリーンショットを撮ると煩わしい効果を与える場合などに便利です

注: これはuserBasedFullPageScreenshotがtrueに設定されている場合にのみ機能します

waitForFontsLoaded​

  • 型: boolean
  • 必須: いいえ
  • デフォルト: true
  • 使用先: すべてのメソッド
  • サポート: Web、ハイブリッドアプリ（Webview）

フォント（サードパーティフォントを含む）は、同期的または非同期的に読み込むことができます。非同期読み込みの場合、WebdriverIOがページが完全に読み込まれたと判断した後にフォントが読み込まれる可能性があります。フォントのレンダリングの問題を防ぐため、このモジュールは、デフォルトでスクリーンショットを撮る前にすべてのフォントが読み込まれるのを待ちます。

比較（チェック）オプション​

比較オプションは、ResembleJSによる比較の実行方法に影響を与えるオプションです。

注意
  • 保存オプションのすべてのオプションは比較メソッドでも使用できます
  • すべての比較オプションはサービスのインスタンス化時__または__各チェックメソッドごとに使用できます。メソッドオプションのキーがサービスのインスタンス化時に設定されたオプションと同じ場合、メソッドの比較オプションがサービスの比較オプションの値を上書きします。
  • すべてのオプションは以下で使用できます：
    • Web
    • ハイブリッドアプリ
    • ネイティブアプリ

ignoreAlpha​

  • 型: boolean
  • デフォルト: false
  • 必須: いいえ

画像を比較し、アルファを無視します。

blockOutSideBar​

  • 型: boolean
  • デフォルト: true
  • 必須: いいえ
  • 備考: checkScreen()でのみ使用できます。これはiPadのみのオプションです

比較中にランドスケープモードでiPadのサイドバーを自動的にブロックします。これにより、タブ/プライベート/ブックマークのネイティブコンポーネントの失敗を防ぎます。

blockOutStatusBar​

  • 型: boolean
  • デフォルト: true
  • 必須: いいえ
  • 備考: これはモバイルのみのオプションです

比較中にステータスバーとアドレスバーを自動的にブロックします。これにより、時間、Wi-Fi、バッテリーステータスによる失敗を防ぎます。

blockOutToolBar​

  • 型: boolean
  • デフォルト: true
  • 必須: いいえ
  • 備考: これはモバイルのみのオプションです

ツールバーを自動的にブロックします。

ignoreAntialiasing​

  • 型: boolean
  • デフォルト: false
  • 必須: いいえ

画像を比較し、アンチエイリアシングを無視します。

ignoreColors​

  • 型: boolean
  • デフォルト: false
  • 必須: いいえ

画像がカラーであっても、比較は2つの白黒画像を比較します

ignoreLess​

  • 型: boolean
  • デフォルト: false
  • 必須: いいえ

画像をred = 16, green = 16, blue = 16, alpha = 16, minBrightness=16, maxBrightness=240で比較します

ignoreNothing​

  • 型: boolean
  • デフォルト: false
  • 必須: いいえ

画像をred = 0, green = 0, blue = 0, alpha = 0, minBrightness=0, maxBrightness=255で比較します

rawMisMatchPercentage​

  • 型: boolean
  • デフォルト: false
  • 必須: いいえ

trueに設定すると、返されるパーセンテージは0.12345678のようになります。デフォルトは0.12です

returnAllCompareData​

  • 型: boolean
  • デフォルト: false
  • 必須: いいえ

これはすべての比較データを返します。不一致パーセンテージだけではありません

saveAboveTolerance​

  • 型: number
  • デフォルト: 0
  • 必須: いいえ

差分画像の保存を防ぐmisMatchPercentageの許容値

largeImageThreshold​

  • 型: number
  • デフォルト: 0
  • 必須: いいえ

大きな画像の比較はパフォーマンスの問題を引き起こす可能性があります。 ここでピクセル数（0より大きい）を指定すると、画像の幅または高さがlargeImageThresholdピクセルより大きい場合、比較アルゴリズムはピクセルをスキップします。

scaleImagesToSameSize​

  • 型: boolean
  • デフォルト: false
  • 必須: いいえ

比較の実行前に2つの画像を同じサイズに拡大縮小します。ignoreAntialiasingとignoreAlphaを有効にすることを強く推奨します

フォルダオプション​

ベースラインフォルダとスクリーンショットフォルダ（実際、差分）は、プラグインのインスタンス化時またはメソッド時に設定できるオプションです。特定のメソッドにフォルダオプションを設定するには、メソッドのオプションオブジェクトにフォルダオプションを渡します。これは以下で使用できます：

  • Web
  • ハイブリッドアプリ
  • ネイティブアプリ
import path from 'node:path'

const methodOptions = {
    actualFolder: path.join(process.cwd(), 'customActual'),
    baselineFolder: path.join(process.cwd(), 'customBaseline'),
    diffFolder: path.join(process.cwd(), 'customDiff'),
}

// すべてのメソッドでこれを使用できます
await expect(
    await browser.checkFullPageScreen("checkFullPage", methodOptions)
).toEqual(0)

actualFolder​

  • 型: string
  • 必須: いいえ

テストでキャプチャされたスナップショットのフォルダ。

baselineFolder​

  • 型: string
  • 必須: いいえ

比較対象として使用されるベースライン画像のフォルダ。

diffFolder​

  • 型: string
  • 必須: いいえ

ResembleJSによってレンダリングされた画像差分のフォルダ。

Welcome! How can I help?

WebdriverIO AI Copilot