Class OverlaysPlugin

Readonlyconfig

addEventListener

• addEventListener<T, E>(type, callback, options?): void

• Type Parameters

  • T extends "overlay-click"

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

    the class of the event

  Parameters

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

  Returns void

dispatchEvent

• dispatchEvent(e): 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: OverlayClickEvent

  Returns boolean

removeEventListener

• removeEventListener<T, E>(type, callback, options?): void

• Type Parameters

  • T extends "overlay-click"

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

    the class of the event

  Parameters

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

  Returns void

setOption

• setOption<T>(option, value): void

• Update options

  Type Parameters

  • T extends "autoclear"

  Parameters

  • option: T
  • value: UpdatableOverlaysPluginConfig[T]

  Returns void

setOptions

• setOptions(options): void

• Update options

  Parameters

  • options: Partial<UpdatableOverlaysPluginConfig>

  Returns void