How to use this.getElementRect method in Appium Xcuitest Driver

...201                    marginOverlay.style.top = inspectOverlay.style.top;202                }203            }204            marginOverlay.style.visibility = "visible";205            if (marginProp === 'top' && (targetRect = this.getElementRect(marginOverlay)) && !this.isRectVisible(targetRect)) {206                marginOverlay.scrollIntoView();207                marginOverlay.style.left = inspectOverlay.style.left;208                marginOverlay.style.top = parseFloat(inspectOverlay.style.top) - parseFloat(marginValue) + 'px';209                this.setInspectOverlayDimensions(this.getElementRect(element));210            }211        } else {212            marginOverlay.style.visibility = "hidden";213        }214    };215216    this.positionPaddingOverlay = function (element, inspectOverlay, paddingProp) {217        var style = element.currentStyle || window.getComputedStyle(element),218            paddingValue,219            paddingFill = 'rgba(147, 196, 125, 0.55)',220            paddingOverlay;221222        if (paddingProp === 'top') {223            paddingValue = style.paddingTop;224            paddingOverlay = this.createOrGetOverlay(this.inspectPaddingTopOverlayId, paddingFill);225        } else if (paddingProp === 'right') {226            paddingValue = style.paddingRight;227            paddingOverlay = this.createOrGetOverlay(this.inspectPaddingRightOverlayId, paddingFill);228        } else if (paddingProp === 'bottom') {229            paddingValue = style.paddingBottom;230            paddingOverlay = this.createOrGetOverlay(this.inspectPaddingBottomOverlayId, paddingFill);231        } else {232            paddingValue = style.paddingLeft;233            paddingOverlay = this.createOrGetOverlay(this.inspectPaddingLeftOverlayId, paddingFill);234        }235236        if (parseFloat(paddingValue) > 0) {237            if (paddingProp === 'top') {238                paddingOverlay.style.left = inspectOverlay.style.left;239                paddingOverlay.style.width = inspectOverlay.style.width;240                paddingOverlay.style.height = paddingValue;241                paddingOverlay.style.top = inspectOverlay.style.top;242            } else if (paddingProp === 'right') {243                paddingOverlay.style.left = parseFloat(inspectOverlay.style.left) + parseFloat(inspectOverlay.style.width) - parseFloat(paddingValue) + 'px';244                paddingOverlay.style.width = paddingValue;245                paddingOverlay.style.height = inspectOverlay.style.height;246                paddingOverlay.style.top = inspectOverlay.style.top;247            } else if (paddingProp === 'bottom') {248                paddingOverlay.style.left = inspectOverlay.style.left;249                paddingOverlay.style.width = inspectOverlay.style.width;250                paddingOverlay.style.height = paddingValue;251                paddingOverlay.style.top = parseFloat(inspectOverlay.style.top) + parseFloat(inspectOverlay.style.height) - parseFloat(paddingValue) + 'px';252            } else {253                paddingOverlay.style.left = inspectOverlay.style.left;254                paddingOverlay.style.width = paddingValue;255                paddingOverlay.style.height = inspectOverlay.style.height;256                paddingOverlay.style.top = inspectOverlay.style.top;257            }258            paddingOverlay.style.visibility = "visible";259        } else {260            paddingOverlay.style.visibility = "hidden";261        }262    };263264    this.createAndPositionMarginOverlays = function (element, inspectOverlay) {265        this.positionMarginOverlay(element, inspectOverlay, 'top');266        this.positionMarginOverlay(element, inspectOverlay, 'right');267        this.positionMarginOverlay(element, inspectOverlay, 'bottom');268        this.positionMarginOverlay(element, inspectOverlay, 'left');269    };270271    this.createAndPositionPaddingOverlays = function (element, inspectOverlay) {272        this.positionPaddingOverlay(element, inspectOverlay, 'top');273        this.positionPaddingOverlay(element, inspectOverlay, 'right');274        this.positionPaddingOverlay(element, inspectOverlay, 'bottom');275        this.positionPaddingOverlay(element, inspectOverlay, 'left');276    };277    278    this.hideAllOverlays = function () {279        this.createOrGetOverlay(this.inspectPaddingTopOverlayId, '').style.visibility = "hidden";280        this.createOrGetOverlay(this.inspectPaddingBottomOverlayId, '').style.visibility = "hidden";281        this.createOrGetOverlay(this.inspectPaddingLeftOverlayId, '').style.visibility = "hidden";282        this.createOrGetOverlay(this.inspectPaddingRightOverlayId, '').style.visibility = "hidden";283        this.createOrGetOverlay(this.inspectMarginBottomOverlayId, '').style.visibility = "hidden";284        this.createOrGetOverlay(this.inspectMarginLeftOverlayId, '').style.visibility = "hidden";285        this.createOrGetOverlay(this.inspectMarginRightOverlayId, '').style.visibility = "hidden";286        this.createOrGetOverlay(this.inspectMarginTopOverlayId, '').style.visibility = "hidden";287        var inspectOverlay = document.getElementById(this.inspectOverlayElemId);288        if (inspectOverlay) {289            inspectOverlay.style.visibility = "hidden";290        }291    };292    293    this.doInspect = function (liveEditId, selectorString) {294        var self = this;295        296        if (this.inspectTimerHandle) {297            window.clearTimeout(this.inspectTimerHandle);298        }299        300        this.inspectTimerHandle = window.setTimeout(function () {301            self.doInspectImpl(liveEditId, selectorString);302        }, this.INSPECT_TIMER);303    };304    305    this.doInspectImpl = function (liveEditId, selectorString) {306        var inspectOverlay,307            elementList = document.querySelectorAll("[data_liveedit_tagid='" + liveEditId + "']"),308            element = null,309            targetRect = null;310        311        if (elementList.length !== 0) {312            element = elementList[0];313        } else if (selectorString) {314            elementList = document.querySelectorAll(selectorString);315            if (elementList.length !== 0) {316                element = elementList[0];317            }318        }319        320        if (!(element && this.isElementVisible(element))) {321            this.hideAllOverlays();322            return;323        }324		325        inspectOverlay = document.getElementById(this.inspectOverlayElemId);326        if (!inspectOverlay) {327            inspectOverlay = this.createInspectOverlay();328        }329        330        if ((targetRect = this.getElementRect(element)) && !this.isRectVisible(targetRect)) {331            element.scrollIntoView();332			targetRect = this.getElementRect(element);333        }334		335        inspectOverlay.style.visibility = "visible";336        this.setInspectOverlayDimensions(targetRect);337        this.createAndPositionMarginOverlays(element, inspectOverlay);338        this.createAndPositionPaddingOverlays(element, inspectOverlay);339    };340    341    this.doScrollElementIntoView = function (liveId, selectorString) {342        var elementList = document.querySelectorAll("[data_liveedit_tagid='" + liveId + "']"),343            element,344            targetRect;345        346        if (elementList.length !== 0) {347            element = elementList[0];348        } else if (selectorString) {349            elementList = document.querySelectorAll(selectorString);350            if (elementList.length !== 0) {351                element = elementList[0];352            }353        }354        355        if (element && this.isElementVisible(element) && !this.isRectVisible(this.getElementRect(element))) {356            element.scrollIntoView();357        }358    };359}360361362window.addEventListener("message", function (e) {363    'use strict';364    if (e.data.event === 'scroll') {365        var xperc = e.data.xperc,366            yperc = e.data.yperc,367            xoffset = (xperc / 100) * (document.body.scrollWidth - window.innerWidth),368            yoffset = (yperc / 100) * (document.body.scrollHeight - window.innerHeight);369
...

...66      loc.y += yOffset;67    }68    return loc;69  }70  const rect = await this.getElementRect(el);71  return {x: rect.x, y: rect.y};72};73commands.getLocationInView = async function (el) {74  return await this.getLocation(el);75};76commands.getSize = async function (el) {77  el = util.unwrapElement(el);78  if (this.isWebContext()) {79    let atomsElement = this.getAtomsElement(el);80    if (atomsElement === null) {81      throw new errors.UnknownError(`Error converting element ID for using in WD atoms: '${el}'`);82    }83    return await this.executeAtom('get_size', [atomsElement]);84  }85  const rect = await this.getElementRect(el);86  return {width: rect.width, height: rect.height};87};88function hasSpecialKeys (keys) {89  for (let char of keys) {90    if (isSpecialKey(char)) {91      return true;92    }93  }94  return false;95}96function isSpecialKey (k) {97  if (k === '\uE003' || k === '\ue017') { // BACKSPACE or DELETE98    return true;99  } else if (k === '\uE006' || k === '\uE007') { // RETURN or ENTER100    return true;101  }102  return false;103}104function translateKey (k) {105  if (k === '\uE006' || k === '\uE007') { // RETURN or ENTER106    return '\n';107  } else if (k === '\uE003' || k === '\ue017') { // BACKSPACE or DELETE108    return '\b';109  }110  return k;111}112extensions.bringUpKeyboard = async function (element) {113  // sometimes input is attempted before we have a keyboard. Try to bring one up114  // but we want to handle the retries on find115  let implicitWaitMs = this.implicitWaitMs;116  await this.setImplicitWait(0);117  try {118    await retryInterval(10, 10, async () => {119      try {120        await this.findNativeElementOrElements('class name', 'XCUIElementTypeKeyboard', false);121        log.debug('Keyboard found. Continuing with text input.');122      } catch (err) {123        // no keyboard found124        log.debug('No keyboard found. Clicking element to open it.');125        await this.nativeClick(element);126        await this.findNativeElementOrElements('class name', 'XCUIElementTypeKeyboard', false);127      }128    });129  } finally {130    // no matter what we do, make sure we have the implicit wait set up correctly131    await this.setImplicitWait(implicitWaitMs);132  }133};134commands.setValueImmediate = async function (value, el) {135  // WDA does not provide no way to set the value directly136  log.info('There is currently no way to bypass typing using XCUITest. Setting value through keyboard');137  await this.setValue(value, el);138};139commands.setValue = async function (value, el) {140  el = util.unwrapElement(el);141  if (this.isWebContext()) {142    let atomsElement = this.useAtomsElement(el);143    await this.executeAtom('click', [atomsElement]);144    await this.executeAtom('type', [atomsElement, value]);145  } else {146    const setFormattedValue = async (input, isKeyboardPresenceCheckEnabled) => {147      if (typeof input !== 'string' && !(input instanceof Array)) {148        input = input.toString().split('');149      }150      try {151        await this.proxyCommand(`/element/${el}/value`, 'POST', {value: input});152      } catch (err) {153        // make sure there is a keyboard if this is a text field154        if (isKeyboardPresenceCheckEnabled && await this.getAttribute('type', el) === 'XCUIElementTypeTextField') {155          log.info(`Cannot type in the text field because of ${err}.\nTrying to apply a workaround...`);156          await this.bringUpKeyboard(el);157          await this.proxyCommand(`/element/${el}/value`, 'POST', {value: input});158        } else {159          throw err;160        }161      }162    };163    // possible values of `value`:164    //   ['some text']165    //   ['s', 'o', 'm', 'e', ' ', 't', 'e', 'x', 't']166    //   'some text'167    if (_.isNull(value) || _.isUndefined(value) || _.isPlainObject(value)) {168      throw new Error(`Only strings and arrays of strings are supported as input arguments. Received: '${JSON.stringify(value)}'`);169    }170    if (_.isArray(value)) {171      // make sure that all the strings inside are a single character long172      value = _.flatMap(value, (v) => (_.isString(v) ? v : JSON.stringify(v)).split(''));173    } else {174      // make it into an array of characters175      value = (value || '').toString().split('');176    }177    if (!hasSpecialKeys(value)) {178      // nothing special, so just send it in179      await setFormattedValue(value, true);180      return;181    }182    // if there are special characters, go through the value until we get to one,183    // and then print it individually184    // currently only supporting return, enter, backspace, and delete185    let buffer = [];186    let isFirstChar = true;187    for (let k of value) {188      let char = translateKey(k);189      if (char === k) {190        buffer.push(char);191        continue;192      }193      // write and clear the buffer194      await setFormattedValue(buffer, isFirstChar);195      isFirstChar = false;196      buffer = [];197      // write the character198      await setFormattedValue([char], isFirstChar);199    }200    // finally, send anything that might be left201    if (buffer.length) {202      await setFormattedValue(buffer, false);203    }204  }205};206commands.keys = async function (value) {207  if (_.isArray(value)) {208    // concatenate any individual strings209    value = value.join('');210  }211  if (_.isString(value)) {212    // split into component characters213    value = value.split('');214  }215  let buffer = [];216  for (let k of value) {217    let char = translateKey(k);218    buffer.push(char);219  }220  await this.proxyCommand('/wda/keys', 'POST', {value: buffer});221};222commands.clear = async function (el) {223  el = util.unwrapElement(el);224  if (this.isWebContext()) {225    let atomsElement = this.useAtomsElement(el);226    await this.executeAtom('clear', [atomsElement]);227    return;228  }229  await retry(5, this.proxyCommand.bind(this), `/element/${el}/clear`, 'POST');230};231commands.getContentSize = async function (el) {232  if (this.isWebContext()) {233    throw new errors.NotYetImplementedError('Support for getContentSize for webcontext is not yet implemented. Please contact an Appium dev');234  }235  const type = await this.getAttribute('type', el);236  if (type !== 'XCUIElementTypeTable' &&237      type !== 'XCUIElementTypeCollectionView') {238    throw new Error(`Can't get content size for type '${type}', only for ` +239                    `tables and collection views`);240  }241  let locator = '*';242  if (type === 'XCUIElementTypeTable') {243    // only find table cells, not just any children244    locator = 'XCUIElementTypeCell';245  }246  let contentHeight = 0;247  let children = await this.findElOrEls(`class chain`, locator, true, el);248  if (children.length === 1) {249    // if we know there's only one element, we can optimize to make just one250    // call to WDA251    const rect = await this.getElementRect(_.head(children));252    contentHeight = rect.height;253  } else if (children.length) {254    // otherwise if we have multiple elements, logic differs based on element255    // type256    switch (type) {257      case 'XCUIElementTypeTable': {258        const firstRect = await this.getElementRect(_.head(children));259        const lastRect = await this.getElementRect(_.last(children));260        contentHeight = lastRect.y + lastRect.height - firstRect.y;261        break;262      }263      case 'XCUIElementTypeCollectionView': {264        let elsInRow = 1; // we know there must be at least one element in the row265        let firstRect = await this.getElementRect(_.head(children));266        let initialRects = [firstRect];267        for (let i = 1; i < children.length; i++) {268          const rect = await this.getElementRect(children[i]);269          initialRects.push(rect);270          if (rect.y !== firstRect.y) {271            elsInRow = i;272            break;273          }274        }275        const spaceBetweenEls = initialRects[elsInRow].y - initialRects[elsInRow - 1].y - initialRects[elsInRow - 1].height;276        const numRows = Math.ceil(children.length / elsInRow);277        // assume all cells are the same height278        contentHeight = (numRows * firstRect.height) + (spaceBetweenEls * (numRows - 1));279        break;280      }281      default: throw new Error(`Programming error: type '${type}' was not ` +282                               `valid but should have already been rejected`);...

...7	this.scrollDirection = 'down';8	var resize = function() {9		//resize all elements10		for ( var i = 0 ; i < list.length ; i++ ) {11			list[i] = this.getElementRect( list[i] );12		}13		resizeNeeded = false;14	}.bind(this);15	var loop = function() {16		var top = window.pageYOffset;17		var bottom = top + window.innerHeight;18		//detect scroll direction19		previous = previous === null ? top : previous;20		this.scrollDirection = previous > top ? 'top' : 'bottom';21		previous = top;22		//throttle checking23		window.requestAnimationFrame(loop);24		//prevent looping when user hasnt scrolled25		if (prev === top && !resizeNeeded) {26			return false;27		}28		//resize needed?29		if (resizeNeeded) {30			resize();31		}32		//save current scroll33		prev = top;34		//define readline35		var readline = top + window.innerHeight * 0.3;36		var item, myTop, myBottom;37		for ( var i = 0 ; i < list.length ; i++ ) {38			item = list[i];39			myTop = item.top;40			myBottom = item.bottom;41			//sticky?42			if (item.sticky) {43				myTop += window.innerHeight;44				myBottom -= window.innerHeight;45			}46			//offset?47			if (item.offset._top) {48				myTop += item.offset._top;49			}50			if (item.offset._bottom) {51				myBottom += item.offset._bottom;52			}53			var position = top > myTop ? 'bottom' : 'top';54			if (55				(myTop >= top && myTop < bottom) ||56				(myBottom > top && myBottom < bottom) ||57				(myTop < top && myBottom > bottom)58			) {59				//don't repeatedly trigger events60				if (!item.inview) {61					//trigger event62					item.inview = true;63					item.evt(true, position);64				}65			} else if (item.inview === true) {66				//send an event when going out of view67				item.inview = false;68				item.evt(false, position);69			}70			//readline71			if ( item.readline && item.top < readline && item.bottom > readline ) {72				if ( !item.readlineActive ) {73					$rootScope.$broadcast('readline', item);74					item.readlineActive = true;75				}76			} else {77				item.readlineActive = false;78			}79		}80		item = null;81		myTop = null;82		myBottom = null;83	}.bind(this);84	//start looping85	loop();86	var getOffset = function(value) {87		if (value.indexOf('%') > -1) {88			return (parseInt(value) / 100) * window.innerHeight;89		} else {90			return parseInt(value);91		}92	};93	this.getElementRect = function(object) {94		var rect = _offset(object.element);95		//do calculations96		object.top = rect.top;97		object.bottom = rect.top + object.element.offsetHeight;98		//offset?99		if (object.offset.top) {100			object.offset._top = getOffset(object.offset.top);101		}102		if (object.offset.bottom) {103			object.offset._bottom = getOffset(object.offset.bottom);104		}105		rect = null;106		//return information about rectangle/boundingbox of element107		return object;108	};109	this.add = function(options) {110		options = Object.assign({111			element: null,112			evt: function() {},113			offset: 0,114			readline: false,115			changeClass: false,116			inview: false,117			id: THREE.Math.generateUUID()118		}, options);119		//get top and bottom position (in px) of element120		var rect = this.getElementRect(options);121		//add properties of element to list122		list.push(rect);123		//return id for removing124		return rect.id;125	};126	this.clear = function() {127		list = [];128	};129	this.remove = function(id) {130		for ( var i = 0 ; i < list.length ; i++ ) {131			if ( list[i].id === id) {132				list[i].element = null;133				list[i].evt = null;134				list[i].offset = null;...

...46		if(pos==0){47			this.x = elem.style.left + "px";48			this.y = elem.style.top + "px";49		}else{50			var pluginRect = this.getElementRect(elem);51			this.x = (pluginRect.left + x) + 'px';52			this.y = (pluginRect.top + y ) + 'px';53			54		}// end if55		56		this.iframe.style.position = 'absolute';57		cont.style.position = 'absolute';58		cont.style.left = this.iframe.style.left = this.x;59		cont.style.top = this.iframe.style.top = this.y;60		61		cont.style.width = this.iframe.style.width = cont.offsetWidth + 'px';62		cont.style.height = this.iframe.style.height = cont.offsetHeight + 'px';63		64		...

...22    }23    /**24     * get coordinates to drag and drop25     */26    const sourceRect = await this.getElementRect(this.elementId)27    const targetRect = await this.getElementRect(target.elementId)28    const sourceX = parseInt(sourceRect.x + (sourceRect.width / 2), 10)29    const sourceY = parseInt(sourceRect.y + (sourceRect.height / 2), 10)30    const targetX = parseInt(targetRect.x + (targetRect.width / 2), 10) - sourceX31    const targetY = parseInt(targetRect.y + (targetRect.height / 2), 10) - sourceY32    /**33     * W3C way of handle the drag and drop action34     */35    return this.performActions([{36        type: 'pointer',37        id: 'finger1',38        parameters: { pointerType: 'mouse' },39        actions: [40            {type: "pointerMove", duration: 0, x: sourceX, y: sourceY},41            {type: "pointerDown", button: ACTION_BUTTON},...

...30    };31    return zoomedRect;32};33exports.getElementRectAsJson = function(element) {34    return JSON.stringify(this.getElementRect(element));35};36exports.getIndexOfFirstOnScreenElement = function(elementPrefix, elementCount){37    for (var i = 0; i < elementCount; ++i) {38        var div = document.getElementById(elementPrefix + i);39        if (div === null) {40            continue;41        }42        var rect = this.getElementRect(div);43        if ( (rect.top >= -1) || ((rect.top + rect.height) >= 50)) {44            return i;45        }46    }47    return -1;48};49function getElementFromPoint(x, y){50    return document.elementFromPoint(x - window.pageXOffset, y - window.pageYOffset);51}...

...26 */27export default async function getLocation (prop) {28    let location = {}29    if (this.isW3C) {30        location = await this.getElementRect(this.elementId)31        delete location.width32        delete location.height33    } else {34        location = await this.getElementLocation(this.elementId)35    }36    if (prop === 'x' || prop === 'y') {37        return location[prop]38    }39    return location...

...25 */26export default async function getElementSize(prop = null) {27    let rect = {}28    if (this.isW3C) {29        rect = await this.getElementRect(this.elementId)30    } else {31        rect = await this.getElementSize(this.elementId)32    }33    if(rect[prop]) {34        return rect[prop]35    }36    return {37        width: rect.width,38        height: rect.height39    }...