メインコンテンツまでスキップ

共通オプションの説明

このモジュールは 20260507 以降のバージョンでのみ使用できます

複数の ui_element API は、対象 App、返却数、再帰の深さ、ヒット検証、スクロールのステップを指定するオプションテーブルを受け取ります。

クエリオプション​

local options = {
pid = app.front_pid(),
max_level = 2,
max_elements = 200,
include_hit_state = true,
}
  • pid
    整数型。対象 App のプロセス識別子を指定します。省略した場合は通常、フォアグラウンドの App を使用します。
  • max_level
    整数型。子要素を再帰的に展開する深さです。通常は 1 または 2 を使用して返却データ量を制御します。
  • max_elements
    整数型。返却するトップレベル要素の最大数です。
  • fallback_children
    ブール型。通常の一覧が空の場合に子要素の取得を試みます。デフォルト値は API によって異なります。
  • include_hit_state
    ブール型。ヒット状態フィールドを追加するかどうかを指定します。
  • hit_test
    ブール型。画面サンプリングによるヒット検索を有効にするかどうかを指定します。通常のスクリプトでは有効にする必要はありません。
  • fallback_hit_test
    ブール型。通常の一覧が空の場合に画面サンプリングによるヒット検索を試みるかどうかを指定します。
  • hit_test_spacing
    数値型。画面サンプリングの間隔を論理座標単位で指定します。デフォルトは 40 です。

属性の除外オプション​

20261115 以降で使用可能。snapshot() と list_text_elements() 専用です。すべてブール型で、デフォルトは false、子要素にも適用されます。これらの状態が不要な場合、除外オプションを有効にすると、問い合わせの負荷を減らし、スナップショットの取得を高速化できます。

  • exclude_visibility
    true の場合、可視性の問い合わせを省略し、isVisible を返しません。
  • exclude_map
    true の場合、地図属性の判定を省略し、isMap を返しません。地図要素自体は保持されます。
  • exclude_hit_state
    true の場合、中心点でのヒット検証を省略し、canHit、hitVerified、hitTestPoint、hitTestPointLogical を返しません。include_hit_state = true とは併用できません。

要素の範囲、テキスト、座標、および hit_test / fallback_hit_test による要素の補完ルールは変わりません。状態による絞り込みが必要な場合は、対応するフィールドを除外しないでください。

アクションオプション​

  • point
    テーブル型。スクロールまたはヒット検索に使用する座標点を指定します。例:{ x = 200, y = 700 }。単位は物理ピクセルです。
  • x / y
    整数型。point と同等で、オプションテーブルに直接指定できます。
  • steps
    数値型。スクロール、増加、減少の各操作に使用するステップパラメータです。実際の動作は対象のコントロールによって異なります。

説明​

list_text_elements() は古いスクリプトとの互換性を保つため、より控えめなデフォルト設定を使用します。 find()、find_all()、snapshot()、およびアクション系 API は、新しいスクリプトで直接使用するのに適しています。 hit_test は現在の最前面により近い要素を返す場合がありますが、処理コストが高くなります。通常のクエリで要素を取得できない場合にのみ使用することを推奨します。