Back to Content

PointerEvent: tiltY property

files/en-us/web/api/pointerevent/tilty/index.md

latest1.5 KB
Original Source

{{ APIRef("Pointer Events") }}

The tiltY read-only property of the {{domxref("PointerEvent")}} interface is the angle (in degrees) between the X-Z plane of the pointer and the screen. This property is typically only useful for a pen/stylus pointer type.

Depending on the specific hardware and platform, user agents will likely only receive one set of values for the transducer orientation relative to the screen plane — either {{domxref("PointerEvent.tiltX", "tiltX")}} and tiltY or {{domxref("PointerEvent.altitudeAngle", "altitudeAngle")}} and {{domxref("PointerEvent.azimuthAngle", "azimuthAngle")}}.

For an additional illustration of this property, see Figure 3 in the specification.

Value

The angle in degrees between the X-Z plane of the pointer (stylus) and the screen. The range of values is -90 to 90, inclusive, where a positive value is a tilt towards the user. For devices that do not support this property, the value is 0.

Examples

This example illustrates simple accessing of the {{domxref("PointerEvent.tiltX","tiltX")}} and tiltY properties.

js
someElement.addEventListener("pointerdown", (event) => {
  processTilt(event.tiltX, event.tiltY);
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("PointerEvent.tiltX")}}
  • {{domxref("PointerEvent.altitudeAngle")}}
  • {{domxref("PointerEvent.azimuthAngle")}}