This is documentation for the next version of Grafana k6 documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/browserbreadcrumb arrow Locatorbreadcrumb arrow boundingBox([options])
Open source

boundingBox([options])

Returns the bounding box of the element. The bounding box is calculated with respect to the position of the Frame of the current element, which is usually the Page’s main frame.

ParameterTypeDefaultDescription
optionsobjectnull
options.timeoutnumber30000Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on BrowserContext or Page.

Returns

TypeDescription
Promise<null | Rect>A Promise that fulfills with the bounding box of the element as a Rect. If the element is not visible, the Promise resolves to null.

Rect

The Rect object represents the bounding box of an element.

PropertyTypeDescription
xnumberThe x-coordinate of the element in pixels.
ynumberThe y-coordinate of the element in pixels.
widthnumberThe width of the element in pixels.
heightnumberThe height of the element in pixels.

Example

JavaScript
JavaScript 
import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();
  await page.goto('https://test.k6.io/browser.php');

  const textbox = page.locator('#text1');
  const boundingBox = await textbox.boundingBox();
  console.log(`x: ${boundingBox.x}, y: ${boundingBox.y}, width: ${boundingBox.width}, height: ${boundingBox.height}`);

  await page.close();
}