mapillary-js/src/viewer/interfaces/IViewerMouseEvent.ts

WebGL JavaScript library for displaying street level imagery from mapillary.com

import {ILatLon} from "../../API";
import {Viewer} from "../../Viewer";

/**
 * @interface IViewerMouseEvent
 *
 * Interface that represents a mouse event occuring in the viewer target element.
 */
export interface IViewerMouseEvent {
    /**
     * The basic coordinates in the current image of the mouse
     * event target.
     *
     * @description In some situations mouse events can occur outside of
     * the border of a image. In that case the basic coordinates will be
     * `null`.
     *
     * Basic coordinates are 2D coordinates on the [0, 1] interval
     * and has the origin point, (0, 0), at the top left corner and the
     * maximum value, (1, 1), at the bottom right corner of the original
     * image.
     */
    basicPoint: number[];

    /**
     * The geographic location in the viewer of the mouse event target.
     *
     * @description In some situations the viewer can not determine a valid
     * geographic location for the mouse event target. In that case the
     * geographic coordinates will be `null`.
     */
    latLon: ILatLon;

    /**
     * The pixel coordinates of the mouse event target, relative to
     * the viewer and measured from the top left corner.
     */
    pixelPoint: number[];

    /**
     * The original event that triggered the viewer event.
     */
    originalEvent: MouseEvent;

    /**
     * The viewer object that fired the event.
     */
    target: Viewer;

    /**
     * The event type.
     */
    type: string;
}

export default IViewerMouseEvent;