appium/commands-yml/commands/element/attributes/location.yml

Automation for Apps.

---
name: Get Element Location
short_description: Determine an element's location on the page or screen

description: The point (0, 0) refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with x and y properties

example_usage:
  java:
    |
      List<MobileElement> element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID");
      Point location = element.getLocation();
  python:
    |
      location = self.driver.find_element_by_accessibility_id('SomeAccessibilityID').location
  javascript_wd:
    |
      let element = await driver.elementByAccessibilityId("SomeAccessibilityID");
      let location = await element.getLocation();
  javascript_wdio:
    |
      let location = driver.getLocation("~SomeAccessibilityId");
  ruby:
    |
      @driver.find_element(:accessibility_id, 'SomeAccessibilityID').location
  php:
    |
      $el = $this->byAccessibilityId('SomeAccessibilityID');
      $location = $el->location();
  csharp:
    |
      // TODO C# sample

client_docs:
  java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/WebElement.html#getLocation--"
  python: "http://selenium-python.readthedocs.io/api.html#selenium.webdriver.remote.webelement.WebElement.location"
  javascript_wdio: "http://webdriver.io/api/property/getLocation.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2175"
  ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:location"
  php: "https://github.com/appium/php-client/" # TODO PHP documentation link
  csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

# TODO: Confirm if all the drivers support this
driver_support:
  ios:
    xcuitest: true
    uiautomation: true
  android:
    uiautomator2: true
    uiautomator: true
  mac:
    mac: true
  windows:
    windows: true
client_support:
  java: true
  python: true
  ruby: true
  php: true
  csharp: true
  javascript_wd: true
  javascript_wdio: true


# Information about the HTTP endpoints
endpoint:
  url: /wd/hub/session/:session_id/elements/:element_id/location
  method: GET
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
    - name: element_id
      description: ID of the element to get the location of
  response:
    - name: x
      type: number
      description: X coordinate
    - name: y
      type: number
      description: Y coordinate

# Links to specifications. Should link to at least one specification
specifications:
  jsonwp: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidlocation