Events

See also: Create Custom Events

Standard Events

The following events are parts of Pointeract standard schema:

Event Name	Description (often appears when intending to)
drag	move a single element
pan	move the viewport in a canvas APP
zoom	change the scale of elements / an element
trueClick	perform a simple click on an element

Obtain Event Types

Pointeract has an interface export StdEvents, which contains all standard event types, access them as follows:

import { StdEvents } from 'pointeract';
function hook(event: StdEvents['drag']) {
    console.log(event.detail);
}

You may also have noticed that Pointeract class has an events property, which contains all event types available in a specific instance. This can be helpful if you are using a module that emits custom events. Use them as type hints with typeof:

function hook(event: typeof pointeract.events.drag) {
    console.log(event.detail);
}

WARNING

Do not use pointeract.events.<eventName> directly as real events, they contain only event types.