@applitools/eyes.selenium/lib/fluent/FloatingRegionByElement.js

Applitools Eyes SDK for Selenium WebDriver

'use strict';

const { GetFloatingRegion, FloatingMatchSettings, Location, CoordinatesType } = require('@applitools/eyes.sdk.core');

class FloatingRegionByElement extends GetFloatingRegion {
  /**
   * @param {WebElement} webElement
   * @param {number} maxUpOffset
   * @param {number} maxDownOffset
   * @param {number} maxLeftOffset
   * @param {number} maxRightOffset
   */
  constructor(webElement, maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset) {
    super();
    this._element = webElement;
    this._maxUpOffset = maxUpOffset;
    this._maxDownOffset = maxDownOffset;
    this._maxLeftOffset = maxLeftOffset;
    this._maxRightOffset = maxRightOffset;
  }

  // noinspection JSCheckFunctionSignatures
  /**
   * @override
   * @param {Eyes} eyesBase
   * @param {EyesScreenshot} screenshot
   */
  getRegion(eyesBase, screenshot) {
    const that = this;
    return that._element.getLocation()
      .then(point => that._element.getSize()
        .then(size => {
          const lTag = screenshot.convertLocation(
            new Location(point),
            CoordinatesType.CONTEXT_RELATIVE,
            CoordinatesType.SCREENSHOT_AS_IS
          );

          return new FloatingMatchSettings(
            lTag.getX(),
            lTag.getY(),
            size.width,
            size.height,
            that._maxUpOffset,
            that._maxDownOffset,
            that._maxLeftOffset,
            that._maxRightOffset
          );
        }));
  }
}

exports.FloatingRegionByElement = FloatingRegionByElement;