Interface CoreEvents

The principle events from the graph model. http://js.cytoscape.org/#core/events

interface CoreEvents {
    addListener(events: string, handler: EventHandler): this;
    addListener(events: string, selector: string, handler: EventHandler): this;
    addListener(events: string, selector: string, data: any, handler: EventHandler): this;
    addListener(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string, data?: any): this;
    bind(events: string, handler: EventHandler): this;
    bind(events: string, selector: string, handler: EventHandler): this;
    bind(events: string, selector: string, data: any, handler: EventHandler): this;
    bind(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string, data?: any): this;
    emit(events: string, extraParams?: any[]): this;
    listen(events: string, handler: EventHandler): this;
    listen(events: string, selector: string, handler: EventHandler): this;
    listen(events: string, selector: string, data: any, handler: EventHandler): this;
    listen(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string, data?: any): this;
    off(events: string, handler?: EventHandler): this;
    off(events: string, selector: string, handler?: EventHandler): this;
    off(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string): this;
    on(events: string, handler: EventHandler): this;
    on(events: string, selector: string, handler: EventHandler): this;
    on(events: string, selector: string, data: any, handler: EventHandler): this;
    on(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string, data?: any): this;
    one(events: string, handler: EventHandler): this;
    one(events: string, selector: string, handler: EventHandler): this;
    one(events: string, selector: string, data: any, handler: EventHandler): this;
    one(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string, data?: any): this;
    pon(events: string, selector?: string): Promise<EventHandler>;
    promiseOn(events: string, selector?: string): Promise<EventHandler>;
    ready(fn: EventHandler): this;
    removeAllListeners(): this;
    removeListener(events: string, handler?: EventHandler): this;
    removeListener(events: string, selector: string, handler?: EventHandler): this;
    removeListener(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string): this;
    trigger(events: string, extraParams?: any[]): this;
    unbind(events: string, handler?: EventHandler): this;
    unbind(events: string, selector: string, handler?: EventHandler): this;
    unbind(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string): this;
    unlisten(events: string, handler?: EventHandler): this;
    unlisten(events: string, selector: string, handler?: EventHandler): this;
    unlisten(eventsMap: {
        [value: string]: EventHandler;
    }, selector?: string): this;
}

Hierarchy (view full)

Methods

addListener bind emit listen off on one pon promiseOn ready removeAllListeners removeListener trigger unbind unlisten

Methods

addListener

bind

emit

listen

off

on

one

  • one(events, handler): this

  • Bind to events that occur in the graph, and trigger the handler only once.

    Parameters

    • events: string

      A space separated list of event names.

    • handler: EventHandler

      The handler function that is called when one of the specified events occurs.

    Returns this

  • one(events, selector, handler): this

  • Bind to events that occur in the graph, and trigger the handler only once.

    Parameters

    • events: string

      A space separated list of event names.

    • selector: string

      A selector to specify elements for which the handler is triggered.

    • handler: EventHandler

      The handler function that is called when one of the specified events occurs.

    Returns this

  • one(events, selector, data, handler): this

  • Bind to events that occur in the graph, and trigger the handler only once.

    Parameters

    • events: string

      A space separated list of event names.

    • selector: string

      A selector to specify elements for which the handler is triggered.

    • data: any

      A plain object which is passed to the handler in the event object argument.

    • handler: EventHandler

      The handler function that is called when one of the specified events occurs.

    Returns this

  • one(eventsMap, selector?, data?): this

  • Bind to events that occur in the graph, and trigger the handler only once.

    Parameters

    • eventsMap: {
          [value: string]: EventHandler;
      }

      A map of event names to handler functions.

    • Optionalselector: string

      A selector to specify elements for which the handler is triggered.

    • Optionaldata: any

      A plain object which is passed to the handler in the event object argument.

    Returns this

pon

promiseOn

ready

removeAllListeners

removeListener

trigger

  • trigger(events, extraParams?): this

  • Trigger one or more events.

    Parameters

    • events: string

      A space separated list of event names to trigger.

    • OptionalextraParams: any[]

      [optional] An array of additional parameters to pass to the handler.

    Returns this

unbind

unlisten

Settings

Member Visibility

On This Page

Methods