On this page
Properties
Methods

Interface MouseRollHandler

Will be removed from public API in MapTiler SDK v4

interface MouseRollHandler {
    contextmenu?: (e: MouseEvent) => void | HandlerResult;
    dblclick?: (e: MouseEvent, point: Point) => void | HandlerResult;
    dragEnd: (e: MouseEvent) => void;
    dragMove: (e: MouseEvent, point: Point) => void | DragRollResult;
    dragStart: (e: MouseEvent, point: Point) => void;
    keydown?: (e: KeyboardEvent) => void | HandlerResult;
    keyup?: (e: KeyboardEvent) => void | HandlerResult;
    mousedown?: (e: MouseEvent, point: Point) => void | HandlerResult;
    mousemove?: (e: MouseEvent, point: Point) => void | HandlerResult;
    mousemoveWindow?: (e: MouseEvent, point: Point) => void | HandlerResult;
    mouseup?: (e: MouseEvent, point: Point) => void | HandlerResult;
    mouseupWindow?: (e: MouseEvent, point: Point) => void | HandlerResult;
    renderFrame?: () => void | HandlerResult;
    touchcancel?: (
        e: TouchEvent,
        points: Point[],
        mapTouches: Touch[],
    ) => void | HandlerResult;
    touchend?: (
        e: TouchEvent,
        points: Point[],
        mapTouches: Touch[],
    ) => void | HandlerResult;
    touchmove?: (
        e: TouchEvent,
        points: Point[],
        mapTouches: Touch[],
    ) => void | HandlerResult;
    touchmoveWindow?: (
        e: TouchEvent,
        points: Point[],
        mapTouches: Touch[],
    ) => void | HandlerResult;
    touchstart?: (
        e: TouchEvent,
        points: Point[],
        mapTouches: Touch[],
    ) => void | HandlerResult;
    wheel?: (e: WheelEvent, point: Point) => void | HandlerResult;
    disable(): void;
    enable(): void;
    isActive(): boolean;
    isEnabled(): boolean;
    reset(): void;
}

Hierarchy (View Summary)

Index

Properties

contextmenu? dblclick? dragEnd dragMove dragStart keydown? keyup? mousedown? mousemove? mousemoveWindow? mouseup? mouseupWindow? renderFrame? touchcancel? touchend? touchmove? touchmoveWindow? touchstart? wheel?

Methods

disable enable isActive isEnabled reset

Properties

contextmenu?: (e: MouseEvent) => void | HandlerResult
dblclick?: (e: MouseEvent, point: Point) => void | HandlerResult
dragEnd: (e: MouseEvent) => void
dragMove: (e: MouseEvent, point: Point) => void | DragRollResult
dragStart: (e: MouseEvent, point: Point) => void
keydown?: (e: KeyboardEvent) => void | HandlerResult
keyup?: (e: KeyboardEvent) => void | HandlerResult
mousedown?: (e: MouseEvent, point: Point) => void | HandlerResult
mousemove?: (e: MouseEvent, point: Point) => void | HandlerResult
mousemoveWindow?: (e: MouseEvent, point: Point) => void | HandlerResult
mouseup?: (e: MouseEvent, point: Point) => void | HandlerResult
mouseupWindow?: (e: MouseEvent, point: Point) => void | HandlerResult
renderFrame?: () => void | HandlerResult

renderFrame is the only non-dom event. It is called during render frames and can be used to smooth camera changes (see scroll handler).

touchcancel?: (
    e: TouchEvent,
    points: Point[],
    mapTouches: Touch[],
) => void | HandlerResult
touchend?: (
    e: TouchEvent,
    points: Point[],
    mapTouches: Touch[],
) => void | HandlerResult
touchmove?: (
    e: TouchEvent,
    points: Point[],
    mapTouches: Touch[],
) => void | HandlerResult
touchmoveWindow?: (
    e: TouchEvent,
    points: Point[],
    mapTouches: Touch[],
) => void | HandlerResult
touchstart?: (
    e: TouchEvent,
    points: Point[],
    mapTouches: Touch[],
) => void | HandlerResult
wheel?: (e: WheelEvent, point: Point) => void | HandlerResult

Methods

  • This is used to indicate if the handler is currently active or not. In case a handler is active, it will block other handlers from getting the relevant events. There is an allow list of handlers that can be active at the same time, which is configured when adding a handler.

    Returns boolean

  • reset can be called by the manager at any time and must reset everything to it's original state

    Returns void

Was this helpful?
SDK JS
Reference
MouseRollHandler