spiegel-keyman/web/docs/engine/reference/osk/getRect.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

42 lines
597 B
Markdown

---
title: getRect
---
## Summary
Get absolute position and size of OSK window.
## Syntax
```c
keyman.osk.getRect()
```
### Parameters
None.
### Return Value
`Object`
: The position and size of the OSK's container element.
## Description
The returned `getRect` object contains the following members:
`left`
: `number`
: The x-coordinate corresponding to the left side of the OSK.
`top`
: `number`
: The y-coordinate corresponding to the top of the OSK.
`width`
: `number`
: The width (in pixels) of the OSK.
`height`
: `number`
: The height (in pixels) of the OSK.