Events: {
    on<K>(event: K, handler: GeoLeafEventHandler<K>): void;
    off<K>(event: K, handler: GeoLeafEventHandler<K>): void;
    once<K>(event: K, handler: GeoLeafEventHandler<K>): void;
} = ...

Public GeoLeaf Events API. Exposed as GeoLeaf.events.

Type declaration

  • on:function
    • Registers a listener for a GeoLeaf event. The listener is called every time the event fires until off() is called.

      Type Parameters

      • K extends keyof GeoLeafEventMap

      Parameters

      • event: K

        Event name (see module docs for full reference).

      • handler: GeoLeafEventHandler<K>

        Callback receiving the CustomEvent with typed detail.

      Returns void

  • off:function
    • Removes a previously registered listener. The exact same handler reference must be passed.

      Type Parameters

      • K extends keyof GeoLeafEventMap

      Parameters

      • event: K

        Event name.

      • handler: GeoLeafEventHandler<K>

        The handler reference originally passed to on().

      Returns void

  • once:function
    • Registers a listener that fires once then automatically removes itself. Uses the native {once: true} option — no wrapper function needed.

      Type Parameters

      • K extends keyof GeoLeafEventMap

      Parameters

      • event: K

        Event name.

      • handler: GeoLeafEventHandler<K>

        Callback called at most once.

      Returns void