Interface DeviceOrientationEvent

The DeviceOrientationEvent interface of the Device Orientation Events provides web developers with information from the physical orientation of the device running the web page. Available only in secure contexts.

MDN Reference

interface DeviceOrientationEvent {
    absolute: boolean;
    alpha: number | null;
    AT_TARGET: 2;
    beta: number | null;
    bubbles: boolean;
    BUBBLING_PHASE: 3;
    cancelable: boolean;
    cancelBubble: boolean;
    CAPTURING_PHASE: 1;
    composed: boolean;
    currentTarget: EventTarget | null;
    defaultPrevented: boolean;
    eventPhase: number;
    gamma: number | null;
    isTrusted: boolean;
    NONE: 0;
    returnValue: boolean;
    srcElement: EventTarget | null;
    target: EventTarget | null;
    timeStamp: number;
    type: string;
    composedPath(): EventTarget[];
    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}
Hierarchy
  • Event
    • DeviceOrientationEvent
Index

Properties

absolute alpha AT_TARGET beta bubbles BUBBLING_PHASE cancelable cancelBubble CAPTURING_PHASE composed currentTarget defaultPrevented eventPhase gamma isTrusted NONE returnValue srcElement target timeStamp type

Methods

composedPath initEvent preventDefault stopImmediatePropagation stopPropagation

Properties

absolute: boolean

The absolute read-only property of the DeviceOrientationEvent interface indicates whether or not the device is providing orientation data absolutely (that is, in reference to the Earth's coordinate frame) or using some arbitrary frame determined by the device.

MDN Reference

alpha: number | null

The alpha read-only property of the DeviceOrientationEvent interface returns the rotation of the device around the Z axis; that is, the number of degrees by which the device is being twisted around the center of the screen.

MDN Reference

AT_TARGET: 2
beta: number | null

The beta read-only property of the DeviceOrientationEvent interface returns the rotation of the device around the X axis; that is, the number of degrees, ranged between -180 and 180, by which the device is tipped forward or backward.

MDN Reference

bubbles: boolean

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

BUBBLING_PHASE: 3
cancelable: boolean

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

cancelBubble: boolean

The cancelBubble property of the Event interface is deprecated.

MDN Reference

CAPTURING_PHASE: 1
composed: boolean

The read-only composed property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

currentTarget: EventTarget | null

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

defaultPrevented: boolean

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

eventPhase: number

The eventPhase read-only property of the being evaluated.

MDN Reference

gamma: number | null

The gamma read-only property of the DeviceOrientationEvent interface returns the rotation of the device around the Y axis; that is, the number of degrees, ranged between -90 and 90, by which the device is tilted left or right.

MDN Reference

isTrusted: boolean

The isTrusted read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

NONE: 0
returnValue: boolean

The Event property returnValue indicates whether the default action for this event has been prevented or not.

MDN Reference

srcElement: EventTarget | null

The deprecated Event.srcElement is an alias for the Event.target property.

MDN Reference

target: EventTarget | null

The read-only target property of the dispatched.

MDN Reference

timeStamp: number

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

type: string

The type read-only property of the Event interface returns a string containing the event's type.

MDN Reference

Methods

  • The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.

    MDN Reference

    Returns EventTarget[]

  • The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

    Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

    MDN Reference

  • The preventDefault() method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

    MDN Reference

    Returns void

  • The stopImmediatePropagation() method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.

    MDN Reference

    Returns void

  • The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

    MDN Reference

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods