This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Get Element Rect

Gets dimensions and coordinates of an element

Example Usage

MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID");
Rectangle rect = element.getRect();

element = self.driver.find_element_by_accessibility_id('SomeAccessibilityID')

// example
let element = $("~SomeAccessibilityId")
let rect = driver.getElementRect(element.elementId);

// wd example
let element = await driver.elementByAccessibilityId("SomeAccessibilityID");
let rect = await element.getRect();

# ruby_lib example
element = find_element :accessibility_id, "SomeAccessibilityID"

# ruby_lib_core example
element = @driver.find_element :accessibility_id, "SomeAccessibilityID"

var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
Rectangle rect = element.Rect;


Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.3+ All All
Mac Mac ?+ 1.6.4+ All
Windows Windows 10+ 1.6.0+ All

Appium Clients

Language Support Documentation
Java All
Python All
Javascript (WebdriverIO) All
Javascript (WD) All
Ruby All
C# All

HTTP API Specifications


GET /session/:session_id/elements/:element_id/rect

URL Parameters

name description
session_id ID of the session to route the command to
element_id ID of the element to get the rect of

JSON Parameters



name type description
x number X coordinate
y number Y coordinate
height number Height of the bounding rectangle
width number Width of the bounding rectangle

See Also