PointerInputEvent

Defines custom event types used throughout the ngDiagram library for handling user input.

The main type, PointerInputEvent, extends the native PointerEvent with additional flags that indicate whether specific diagram interactions (such as selection, zooming, linking, rotation) have already been handled. These flags are used by input event directives and handlers to coordinate and prevent duplicate processing of the same pointer event.

This type is used as the event parameter in input event handlers and services across the public API and internal logic.

Example usage:

onPointerDown(event: PointerInputEvent) {
  if (!event.linkingHandled) {
    // handle linking logic
    event.linkingHandled = true;
  }
}

Extends

• PointerEvent

Properties

altitudeAngle

readonly altitudeAngle: number

MDN Reference

Inherited from

PointerEvent.altitudeAngle

---

altKey

readonly altKey: boolean

MDN Reference

Inherited from

PointerEvent.altKey

---

azimuthAngle

readonly azimuthAngle: number

MDN Reference

Inherited from

PointerEvent.azimuthAngle

---

bubbles

readonly bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target’s ancestors in reverse tree order, and false otherwise.

MDN Reference

Inherited from

PointerEvent.bubbles

---

button

readonly button: number

MDN Reference

Inherited from

PointerEvent.button

---

buttons

readonly buttons: number

MDN Reference

Inherited from

PointerEvent.buttons

---

cancelable

readonly cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

MDN Reference

Inherited from

PointerEvent.cancelable

---

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

Inherited from

PointerEvent.cancelBubble

---

clientX

readonly clientX: number

MDN Reference

Inherited from

PointerEvent.clientX

---

clientY

readonly clientY: number

MDN Reference

Inherited from

PointerEvent.clientY

---

composed

readonly composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

MDN Reference

Inherited from

PointerEvent.composed

---

ctrlKey

readonly ctrlKey: boolean

MDN Reference

Inherited from

PointerEvent.ctrlKey

---

currentTarget

readonly currentTarget: null | EventTarget

Returns the object whose event listener’s callback is currently being invoked.

MDN Reference

Inherited from

PointerInputEvent.currentTarget

---

defaultPrevented

readonly defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

Inherited from

PointerEvent.defaultPrevented

---

detail

readonly detail: number

MDN Reference

Inherited from

PointerEvent.detail

---

eventPhase

readonly eventPhase: number

Returns the event’s phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

Inherited from

PointerEvent.eventPhase

---

height

readonly height: number

MDN Reference

Inherited from

PointerEvent.height

---

isPrimary

readonly isPrimary: boolean

MDN Reference

Inherited from

PointerEvent.isPrimary

---

isTrusted

readonly isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

Inherited from

PointerEvent.isTrusted

---

layerX

readonly layerX: number

MDN Reference

Inherited from

PointerEvent.layerX

---

layerY

readonly layerY: number

MDN Reference

Inherited from

PointerEvent.layerY

---

metaKey

readonly metaKey: boolean

MDN Reference

Inherited from

PointerEvent.metaKey

---

movementX

readonly movementX: number

MDN Reference

Inherited from

PointerEvent.movementX

---

movementY

readonly movementY: number

MDN Reference

Inherited from

PointerEvent.movementY

---

offsetX

readonly offsetX: number

MDN Reference

Inherited from

PointerEvent.offsetX

---

offsetY

readonly offsetY: number

MDN Reference

Inherited from

PointerEvent.offsetY

---

pageX

readonly pageX: number

MDN Reference

Inherited from

PointerEvent.pageX

---

pageY

readonly pageY: number

MDN Reference

Inherited from

PointerEvent.pageY

---

pointerId

readonly pointerId: number

MDN Reference

Inherited from

PointerEvent.pointerId

---

pointerType

readonly pointerType: string

MDN Reference

Inherited from

PointerEvent.pointerType

---

pressure

readonly pressure: number

MDN Reference

Inherited from

PointerEvent.pressure

---

relatedTarget

readonly relatedTarget: null | EventTarget

MDN Reference

Inherited from

PointerEvent.relatedTarget

---

returnValue

returnValue: boolean

Deprecated

MDN Reference

Inherited from

PointerEvent.returnValue

---

screenX

readonly screenX: number

MDN Reference

Inherited from

PointerEvent.screenX

---

screenY

readonly screenY: number

MDN Reference

Inherited from

PointerEvent.screenY

---

shiftKey

readonly shiftKey: boolean

MDN Reference

Inherited from

PointerEvent.shiftKey

---

srcElement

readonly srcElement: null | EventTarget

Deprecated

MDN Reference

Inherited from

PointerInputEvent.srcElement

---

tangentialPressure

readonly tangentialPressure: number

MDN Reference

Inherited from

PointerEvent.tangentialPressure

---

target

readonly target: null | EventTarget

Returns the object to which event is dispatched (its target).

MDN Reference

Inherited from

PointerInputEvent.target

---

tiltX

readonly tiltX: number

MDN Reference

Inherited from

PointerEvent.tiltX

---

tiltY

readonly tiltY: number

MDN Reference

Inherited from

PointerEvent.tiltY

---

timeStamp

readonly timeStamp: number

Returns the event’s timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

Inherited from

PointerEvent.timeStamp

---

twist

readonly twist: number

MDN Reference

Inherited from

PointerEvent.twist

---

type

readonly type: string

Returns the type of event, e.g. “click”, “hashchange”, or “submit”.

MDN Reference

Inherited from

PointerEvent.type

---

view

readonly view: null | Window

MDN Reference

Inherited from

PointerEvent.view

---

which

readonly which: number

Deprecated

MDN Reference

Inherited from

PointerEvent.which

---

width

readonly width: number

MDN Reference

Inherited from

PointerEvent.width

---

x

readonly x: number

MDN Reference

Inherited from

PointerEvent.x

---

y

readonly y: number

MDN Reference

Inherited from

PointerEvent.y

Methods

composedPath()

composedPath(): EventTarget[]

Returns the invocation target objects of event’s path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root’s mode is “closed” that are not reachable from event’s currentTarget.

MDN Reference

Returns

EventTarget[]

Inherited from

PointerEvent.composedPath

---

getCoalescedEvents()

getCoalescedEvents(): PointerEvent[]

Available only in secure contexts.

MDN Reference

Returns

PointerEvent[]

Inherited from

PointerEvent.getCoalescedEvents

---

getModifierState()

getModifierState(keyArg): boolean

MDN Reference

Parameters

keyArg

string

Returns

boolean

Inherited from

PointerEvent.getModifierState

---

getPredictedEvents()

getPredictedEvents(): PointerEvent[]

MDN Reference

Returns

PointerEvent[]

Inherited from

PointerEvent.getPredictedEvents

---

initEvent()

initEvent(type, bubbles?, cancelable?): void

Deprecated

MDN Reference

Parameters

type

string

bubbles?

boolean

cancelable?

boolean

Returns

void

Inherited from

PointerEvent.initEvent

---

initMouseEvent()

initMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg): void

Deprecated

MDN Reference

Parameters

typeArg

string

canBubbleArg

boolean

cancelableArg

boolean

viewArg

Window

detailArg

number

screenXArg

number

screenYArg

number

clientXArg

number

clientYArg

number

ctrlKeyArg

boolean

altKeyArg

boolean

shiftKeyArg

boolean

metaKeyArg

boolean

buttonArg

number

relatedTargetArg

null | EventTarget

Returns

void

Inherited from

PointerEvent.initMouseEvent

---

initUIEvent()

initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void

Deprecated

MDN Reference

Parameters

typeArg

string

bubblesArg?

boolean

cancelableArg?

boolean

viewArg?

null | Window

detailArg?

number

Returns

void

Inherited from

PointerEvent.initUIEvent

---

preventDefault()

preventDefault(): void

If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

MDN Reference

Returns

void

Inherited from

PointerEvent.preventDefault

---

stopImmediatePropagation()

stopImmediatePropagation(): void

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

MDN Reference

Returns

void

Inherited from

PointerEvent.stopImmediatePropagation

---

stopPropagation()

stopPropagation(): void

When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

MDN Reference

Returns

void

Inherited from

PointerEvent.stopPropagation