Join MDN and developers like you at Mozilla's View Source conference, 12-14 September in Berlin, Germany. Learn more at https://viewsourceconf.org

HTMLIFrameElement.sendTouchEvent()

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

This API is available on Firefox OS for privileged or certified applications only.

The sendTouchEvent() method of the HTMLIFrameElement allows you to fake a touch event and send it to the browser <iframe>'s content.

Note: This method is available for touch-enabled devices only.

Syntax

instanceOfHTMLIframeElement.sendTouchEvent(type, x, y, rx, ry,
                                           rotationAngles, forces,
                                           count, modifiers);

Returns

Void.

Parameters

type
A string representing the event type. Possible values are touchstart, touchend, touchmove, or touchcancel.
x
An array of numbers representing the x position of each touch point relative to the browser <iframe>'s visible area in CSS pixels.
y
An array of numbers representing the y position of each touch point relative to the browser <iframe>'s visible area in CSS pixels.
rx
An array of numbers representing the x radius of each touch point in CSS pixels.
ry
An array of numbers representing the y radius of each touch point in CSS pixels.
rotationAngles
An array of numbers representing the angle of each touch point in degrees.
forces
An array of numbers representing the intensity of each touch in the range 0–1.
count
The number of touches that should be performed.
modifiers
A number representing a key pressed at the same time the mouse button was clicked:
  • 1Alt
  • 2Ctrl
  • 4Shift
  • 8Meta
  • 16Alt Gr
  • 32Caps Lock
  • 64Fn
  • 128Num Lock
  • 256Scroll
  • 512Symbol Lock
  • 1024Win

Note: You can specify multiple key modifiers separated by a pipe symbol, for example 1 | 1014.

Examples

var browser = document.querySelector('iframe');
browser.sendTouchEvent("touchstart", [1], [x], [y], [2], [2],
                       [20], [0.5], 1, 0);

Specification

Not part of any specification.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support Not supported Not supported Not supported Not supported Not supported
Feature Android Firefox Mobile (Gecko) Firefox OS (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support Not supported Not supported 1.0.1 Not supported Not supported Not supported

Note: Use of the Browser API requires a privileged app, and browser and/or embed-apps permissions, depending on what you want to do. See Using the Browser API for more details.

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, wbamberg, teoli, ajaybhat, kscarfone, Jeremie
 Last updated by: chrisdavidmills,