@maxgraph/core
    Preparing search index...

    Class EventSource

    Base class for objects that dispatch named events.

    To create a subclass that inherits from EventSource, the following code is used:

    class MyClass extends EventSource {
      // implement the logic here
    };

    Known Subclasses:

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    eventListeners eventsEnabled eventSource

    Methods

    addListener fireEvent getEventSource isEventsEnabled removeListener setEventsEnabled setEventSource

    Constructors

    Properties

    eventListeners: EventListenerObject[] = []

    Holds the event names and associated listeners in an array. The array contains the event name followed by the respective listener for each registered listener.

    eventsEnabled: boolean = true

    Specifies if events can be fired. Default is true.

    eventSource: null | EventTarget = null

    Optional source for events. Default is null.

    Methods

    • Binds the specified function to the given event name. If no event name is given, then the listener is registered for all events.

      The parameters of the listener are the sender and an EventObject.

      Parameters

      • name: string
      • funct: Function

      Returns void

    • Dispatches the given event to the listeners which are registered for the event. The sender argument is optional. The current execution scope ("this") is used for the listener invocation (see Utils#bind).

      Example:

      fireEvent(new mxEventObject("eventName", key1, val1, .., keyN, valN))

      Parameters

      • evt: EventObject

        EventObject that represents the event.

      • sender: null | EventTarget = null

        Optional sender to be passed to the listener. Default value is the return value of .

      Returns void

    • Removes all occurrences of the given listener from .

      Parameters

      • funct: Function

      Returns void

    • Sets .

      Parameters

      • value: null | EventTarget

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods