Class AutorotatePlugin

Readonlyconfig

addEventListener

• addEventListener<
      T extends "autorotate",
      E extends AutorotateEvent & { type: T },
  >(
      type: T,
      callback: EventListenerObject | (e: E) => void,
      options?: boolean | AddEventListenerOptions,
  ): void

• Type Parameters

  • T extends "autorotate"

    the name of event
  • E extends AutorotateEvent & { type: T }

    the class of the event

  Parameters

  • type: T
  • callback: EventListenerObject | (e: E) => void
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

dispatchEvent

• dispatchEvent(e: AutorotateEvent): boolean

• 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.

  MDN Reference

  Parameters

  • e: AutorotateEvent

  Returns boolean

removeEventListener

• removeEventListener<
      T extends "autorotate",
      E extends AutorotateEvent & { type: T },
  >(
      type: "autorotate",
      callback: EventListenerObject | (e: E) => void,
      options?: boolean | EventListenerOptions,
  ): void

• Type Parameters

  • T extends "autorotate"

    the name of event
  • E extends AutorotateEvent & { type: T }

    the class of the event

  Parameters

  • type: "autorotate"
  • callback: EventListenerObject | (e: E) => void
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

setOption

• setOption<
      T extends
          | "autorotateSpeed"
          | "autorotatePitch"
          | "autostartDelay"
          | "autostartOnIdle"
          | "autorotateZoomLvl"
          | "startFromClosest",
  >(
      option: T,
      value: UpdatableAutorotatePluginConfig[T],
  ): void

• Update options

  Type Parameters

  • T extends
        | "autorotateSpeed"
        | "autorotatePitch"
        | "autostartDelay"
        | "autostartOnIdle"
        | "autorotateZoomLvl"
        | "startFromClosest"

  Parameters

  • option: T
  • value: UpdatableAutorotatePluginConfig[T]

  Returns void

setOptions

• setOptions(options: Partial<UpdatableAutorotatePluginConfig>): void

• Update options

  Parameters

  • options: Partial<UpdatableAutorotatePluginConfig>

  Returns void