Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

addDomListener

  • addDomListener(instance: object, eventName: string, handler: (event: Event) => void, capture?: boolean): MapsEventListener
  • Cross browser event handler registration. This listener is removed by calling removeListener(handle) for the handle that is returned by this function.

    Parameters

    • instance: object
    • eventName: string
    • handler: (event: Event) => void
        • Parameters

          Returns void

    • Optional capture: boolean

    Returns MapsEventListener

addDomListenerOnce

  • addDomListenerOnce(instance: object, eventName: string, handler: (event: Event) => void, capture?: boolean): MapsEventListener
  • Wrapper around addDomListener that removes the listener after the first event.

    Parameters

    • instance: object
    • eventName: string
    • handler: (event: Event) => void
        • Parameters

          Returns void

    • Optional capture: boolean

    Returns MapsEventListener

addListener

  • addListener(instance: object, eventName: string, handler: (...args: any[]) => void): MapsEventListener
  • Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().

    Parameters

    • instance: object
    • eventName: string
    • handler: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MapsEventListener

addListenerOnce

  • addListenerOnce(instance: object, eventName: string, handler: (...args: any[]) => void): MapsEventListener
  • Like addListener, but the handler removes itself after handling the first event.

    Parameters

    • instance: object
    • eventName: string
    • handler: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MapsEventListener

clearInstanceListeners

  • clearInstanceListeners(instance: object): void
  • Removes all listeners for all events for the given instance.

    Parameters

    • instance: object

    Returns void

clearListeners

  • clearListeners(instance: object, eventName: string): void
  • Removes all listeners for the given event for the given instance.

    Parameters

    • instance: object
    • eventName: string

    Returns void

removeListener

  • Removes the given listener, which should have been returned by addListener above. Equivalent to calling listener.remove().

    Parameters

    Returns void

trigger

  • trigger(instance: any, eventName: string, ...args: any[]): void
  • Triggers the given event. All arguments after eventName are passed as arguments to the listeners.

    Parameters

    • instance: any
    • eventName: string
    • Rest ...args: any[]

    Returns void

Generated using TypeDoc