Class Events

Handles user input events (mouse, touch, keyboard, wheel, gestures) for the Micrio viewer. Translates browser events into camera movements (pan, zoom), dispatches custom Micrio events, and manages interaction states like panning, pinching, and enabled/disabled states. Accessed via micrio.events.

Author

Marcel Duin marcel@micr.io

Properties

enabled pinchFactor

Accessors

$enabled isNavigating

Methods

hook hookDrag hookKeys hookPinch hookScroll hookZoom unhook unhookDrag unhookKeys unhookPinch unhookScroll unhookZoom

Properties

enabled

enabled: Writable<boolean> = ...

Writable Svelte store indicating if event handling is currently enabled. Set to false during tours or animations.

pinchFactor

pinchFactor: number

Current pinch zoom factor relative to the start of the pinch. Undefined when not pinching.

Accessors

$enabled

  • get $enabled(): boolean

  • Getter for the current value of the enabled store.

    Returns boolean

isNavigating

  • get isNavigating(): boolean

  • Checks if the user is currently interacting with the map via panning, pinching, or wheeling.

    Returns boolean

    True if the user is actively navigating.

Methods

hook

  • hook(): void

  • Hooks all necessary event listeners based on current settings.

    Returns void

hookDrag

  • hookDrag(): void

  • Hooks pointer down/move/up listeners for drag panning.

    Returns void

hookKeys

  • hookKeys(): void

  • Hooks keyboard event listeners.

    Returns void

hookPinch

  • hookPinch(): void

  • Hooks touch pinch and macOS gesture event listeners.

    Returns void

hookScroll

  • hookScroll(): void

  • Hooks mouse wheel/scroll event listeners.

    Returns void

hookZoom

  • hookZoom(): void

  • Hooks zoom-related event listeners (pinch, scroll, double-tap/click).

    Returns void

unhook

  • unhook(): void

  • Unhooks all attached event listeners.

    Returns void

unhookDrag

  • unhookDrag(): void

  • Unhooks pointer listeners for drag panning.

    Returns void

unhookKeys

  • unhookKeys(): void

  • Unhooks keyboard event listeners.

    Returns void

unhookPinch

  • unhookPinch(): void

  • Unhooks touch pinch and macOS gesture event listeners.

    Returns void

unhookScroll

  • unhookScroll(): void

  • Unhooks mouse wheel/scroll event listeners.

    Returns void

unhookZoom

  • unhookZoom(): void

  • Unhooks zoom-related event listeners.

    Returns void

Settings

Member Visibility

On This Page

Properties
Accessors
Methods