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

Applitools Eyes SDK for Selenium WebDriver

'use strict';

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

class FloatingRegionBySelector extends GetFloatingRegion {
  /**
   * @param {By} regionSelector
   * @param {number} maxUpOffset
   * @param {number} maxDownOffset
   * @param {number} maxLeftOffset
   * @param {number} maxRightOffset
   */
  constructor(regionSelector, maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset) {
    super();
    this._element = regionSelector;
    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 eyesBase.getDriver()
      .findElement(that._element)
      .then(element => {
        let location;
        return element.getLocation()
          .then(point => {
            location = new Location(point);
            return element.getSize();
          })
          .then(size => {
            const lTag = screenshot.convertLocation(
              location,
              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.FloatingRegionBySelector = FloatingRegionBySelector;