要素のサイズをピクセル単位で決定します。GeckoDriverのようなW3C Webdriver互換クライアントの場合、このコマンドはgetLocationと同等であり、どちらも以下の情報を返します。
指定された要素の寸法と座標

  • x: 要素の左上隅のX軸位置(CSSピクセル単位)
  • y: 要素の左上隅のY軸位置(CSSピクセル単位)
  • height: 要素のバウンディングボックスの高さ(CSSピクセル単位)
  • width: Web要素のバウンディングボックスの幅(CSSピクセル単位)

コマンドgetElementSize()は、要素が存在するまで(指定されたタイムアウトまで)自動的に待機します。要素が見つからない場合は、エラーがスローされ、テストが失敗します。selector引数をオブジェクトとして指定し、suppressNotFoundErrors = trueオプションを渡すことで、要素が見つからないエラーを抑制できます。

NightwatchでのDOM要素の操作の詳細については、「DOM要素の検索と操作」ガイドページを参照してください。

使用法

                    .getElementSize(selector, [callback])
                
                    .getElementSize(using, selector, [callback])
                

module.exports = {
  demoTest(browser) {
    browser.getElementSize('#login', function(result) {
      console.log('result', result);
    });

    // with explicit locate strategy
    browser.getElementSize('css selector', '#login', function(result) {
      console.log('result', result);
    });

    // with selector object - see https://nightwatch.dokyumento.jp/guide/writing-tests/finding-interacting-with-dom-elements.html#postdoc-element-properties
    browser.getElementSize({
      selector: '#login',
      index: 1,
      suppressNotFoundErrors: true
    }, function(result) {
      console.log('result', result);
    });
  },

  demoTestAsync: async function(browser) {
    const result = await browser.getElementSize('#login');
    console.log('classList', result);
  }
}

パラメータ

名前 タイプ 説明
using
任意
string

使用するロケータ戦略。 W3C Webdriver - ロケータ戦略を参照してください。

selector string | object

要素を特定するために使用されるセレクター(CSS/Xpath)。文字列または要素のプロパティを指定するオブジェクトのいずれかを使用できます。

callback function

結果の値とともに呼び出されるコールバック関数。

戻り値

タイプ 説明
*

要素の幅と高さ(ピクセル単位)

W3C WebDriver仕様