ScreenOrientation | @foxy.io/sdk

Hierarchy

EventTarget
- ScreenOrientation

Index

Properties

Methods

Properties

Readonly angle

angle: number

onchange

onchange: null | ((this: ScreenOrientation, ev: Event) => any)

Readonly type

type: OrientationType

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: ScreenOrientation, ev: ScreenOrientationEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14784
Type Parameters
- K extends "change"
Parameters
- type: K
- listener: ((this: ScreenOrientation, ev: ScreenOrientationEventMap[K]) => any)
  - - (this: ScreenOrientation, ev: ScreenOrientationEventMap[K]): any
    - Parameters
      - this: ScreenOrientation
      - ev: ScreenOrientationEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14785
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5428
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters
- event: Event
Returns boolean

lock

lock(orientation: OrientationLockType): Promise<void>

- Defined in node_modules/typescript/lib/lib.dom.d.ts:14782
Parameters
- orientation: OrientationLockType
Returns Promise<void>

removeEventListener

removeEventListener<K>(type: K, listener: ((this: ScreenOrientation, ev: ScreenOrientationEventMap[K]) => any), options?: boolean | EventListenerOptions): void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14786
Type Parameters
- K extends "change"
Parameters
- type: K
- listener: ((this: ScreenOrientation, ev: ScreenOrientationEventMap[K]) => any)
  - - (this: ScreenOrientation, ev: ScreenOrientationEventMap[K]): any
    - Parameters
      - this: ScreenOrientation
      - ev: ScreenOrientationEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:14787
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

unlock

unlock(): void

- Defined in node_modules/typescript/lib/lib.dom.d.ts:14783
Returns void

Hierarchy

Index

Properties

Methods

Properties

Readonly angle

onchange

Readonly type

Methods

addEventListener

Type Parameters

K extends "change"

Parameters

type: K

listener: ((this: ScreenOrientation, ev: ScreenOrientationEventMap[K]) => any)

Parameters

this: ScreenOrientation

ev: ScreenOrientationEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

lock

Parameters

orientation: OrientationLockType

Returns Promise<void>

removeEventListener

Type Parameters

K extends "change"

Parameters

type: K

listener: ((this: ScreenOrientation, ev: ScreenOrientationEventMap[K]) => any)

Parameters

this: ScreenOrientation

ev: ScreenOrientationEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void

unlock

Returns void