@maxgraph/core
    Preparing search index...

    Class SelectionCellsHandler

    An event handler that manages cell handlers and invokes their mouse event processing functions.

    Fires if a cell has been added to the selection. The state property contains the CellState that has been added.

    Fires if a cell has been remove from the selection. The state property contains the CellState that has been removed.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    enabled eventListeners eventsEnabled eventSource graph handlers maxHandlers refreshHandler pluginId

    Methods

    addListener fireEvent getEventSource getHandledSelectionCells getHandler isEnabled isEventsEnabled isHandled isHandlerActive mouseDown mouseMove mouseUp onDestroy refresh removeListener reset setEnabled setEventsEnabled setEventSource updateHandler

    Constructors

    Properties

    enabled: boolean = true

    Specifies if events are handled. Default is true.

    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.

    graph: Graph

    Reference to the enclosing Graph.

    handlers: Dictionary<Cell, Handler>

    Dictionary that maps from cells to handlers.

    maxHandlers: number = 100

    Defines the maximum number of handlers to paint individually. Default is 100.

    refreshHandler: (sender: EventSource, evt: EventObject) => void

    Keeps a reference to an event listener for later removal.

    pluginId: string = 'SelectionCellsHandler'

    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

    • Returns true if the given handler is active and should not be redrawn.

      Parameters

      • handler: Handler

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Events
    Constructors
    Properties
    Methods