nsIDOMOrientationEvent

The nsIDOMOrientationEvent interface describes the event that can be delivered to DOM windows, providing information from the device's accelerometer, allowing code to determine the orientation of the device.

dom/interfaces/events/nsIDOMOrientationEvent.idlScriptable

Please add a summary to this article.

Last changed in Gecko 1.9.2 (Firefox 3.6 / Thunderbird 3.1 / Fennec 1.0)

Inherits from: nsIDOMEvent

Method overview

void initOrientationEvent(in DOMString eventTypeArg, in boolean canBubbleArg, in boolean cancelableArg,
                           in double x, in double y,

in double z);

Attributes

Attribute	Type	Description
`x`	`double`	The amount of tilt along the X axis. Read only.
`y`	`double`	The amount of tilt along the Y axis. Read only.
`z`	`double`	The amount of tilt along the Z axis. Read only.

The values of x, y, and z can range from -1 to 1, where 0 means the device is balanced on that axis. See Accelerometer values explained for details.

Methods

initOrientationEvent()

Initializes the orientation event object.

void initProgressEvent(
  in DOMString eventTypeArg,
  in boolean canBubbleArg,
  in boolean cancelableArg,
  in double x,
  in double y,
  in double z
);

Parameters

eventTypeArg: The type of event. Must be "MozOrientation".
canBubbleArg: Specifies whether or not the created event will bubble.
cancelableArg: Specifies whether or not the created event can be canceled.
x: The amount of tilt along the X axis.
y: The amount of tilt along the Y axis.
z: The amount of tilt along the Z axis.