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

  Edit this Doc Get Element Size

Determine an element's size in pixels

Example Usage

MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID");
Dimension elementSize = element.getSize();

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

// webdriver.io example
let size = $("~SomeAccessibilityId").getSize();

// wd example
let element = await driver.elementByAccessibilityId("SomeAccessibilityID");
let size = await element.getSize();

# ruby_lib example
find_element(:accessibility_id, 'SomeAccessibilityID').size

# ruby_lib_core example
@driver.find_element(:accessibility_id, 'SomeAccessibilityID').size

var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
Size elementSize = element.Size;

Description

The size will be returned as an object with width and height properties.

Support

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 seleniumhq.github.io
Python All selenium-python.readthedocs.io
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
C# All github.com

HTTP API Specifications

Endpoint

GET /session/:session_id/elements/:element_id/size

URL Parameters

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

JSON Parameters

None

Response

name type description
width number Width of the element
height number Height of the element

See Also