Interface EventObject

Events passed to handler callbacks are similar to jQuery event objects in that they wrap native event objects, mimicking their API.

http://js.cytoscape.org/#events

interface EventObject {
    cy: cytoscape.Core;
    isDefaultPrevented: (() => boolean);
    isImmediatePropagationStopped: (() => boolean);
    isPropagationStopped: (() => boolean);
    layout: any;
    namespace: string;
    originalEvent: MouseEvent;
    position: Position;
    preventDefault: (() => void);
    renderedPosition: Position;
    stopImmediatePropagation: (() => void);
    stopPropagation: (() => void);
    target: any;
    timeStamp: number;
    type: UserInputDeviceEventName | UserInputDeviceEventNameExt;
}

Hierarchy (view full)

Properties

cy isDefaultPrevented isImmediatePropagationStopped isPropagationStopped layout namespace originalEvent position preventDefault renderedPosition stopImmediatePropagation stopPropagation target timeStamp type

Properties

cy

cy: cytoscape.Core

a reference to the corresponding core Core

isDefaultPrevented

isDefaultPrevented: (() => boolean)

isImmediatePropagationStopped

isImmediatePropagationStopped: (() => boolean)

isPropagationStopped

isPropagationStopped: (() => boolean)

layout

layout: any

layout : indicates the corresponding layout that triggered the event (useful if running multiple layouts simultaneously)

namespace

namespace: string

the event namespace string (e.g. "foo" for "foo.tap")

originalEvent

originalEvent: MouseEvent

originalEvent : the original user input device event object

position

position: Position

position : indicates the model position of the event

preventDefault

preventDefault: (() => void)

renderedPosition

renderedPosition: Position

renderedPosition : indicates the rendered position of the event

stopImmediatePropagation

stopImmediatePropagation: (() => void)

stopPropagation

stopPropagation: (() => void)

target

target: any

indicates the element or core that first caused the event

timeStamp

timeStamp: number

Unix epoch time of event in milliseconds

type

type: UserInputDeviceEventName | UserInputDeviceEventNameExt

the event type string (e.g. "tap")

Settings

Member Visibility

On This Page

Properties