@maplibre/maplibre-gl-directions/dist/src/directions/events.d.ts

A plugin to show routing directions on a MapLibre GL JS map. Supports any [OSRM](http://project-osrm.org/) or [Mapbox Directions API](https://docs.mapbox.com/api/navigation/directions/) compatible Routing-provider.

import type { Map, MapMouseEvent, MapTouchEvent } from "maplibre-gl";
import type { Directions } from "./types";
export declare class MapLibreGlDirectionsEvented {
    constructor(map: Map);
    protected readonly map: Map;
    private listeners;
    private oneTimeListeners;
    protected fire<T extends keyof MapLibreGlDirectionsEventType>(event: MapLibreGlDirectionsEventType[T]): void;
    /**
     * Registers an event listener.
     */
    on<T extends keyof MapLibreGlDirectionsEventType>(type: T, listener: MapLibreGlDirectionsEventListener<T>): void;
    /**
     * Un-registers an event listener.
     */
    off<T extends keyof MapLibreGlDirectionsEventType>(type: T, listener: (e: MapLibreGlDirectionsEventType[T]) => void): void;
    /**
     * Registers an event listener to be invoked only once.
     */
    once<T extends keyof MapLibreGlDirectionsEventType>(type: T, listener: MapLibreGlDirectionsEventListener<T>): void;
}
/**
 * Supported event types.
 */
export interface MapLibreGlDirectionsEventType {
    /**
     * Emitted after the waypoints are set using the {@link default.setWaypoints|`setWaypoints`} method.
     */
    setwaypoints: MapLibreGlDirectionsWaypointEvent;
    /**
     * Emitted after the waypoints' bearings values are changed using the
     * {@link default.waypointsBearings|`waypointsBearings`} setter.
     */
    rotatewaypoints: MapLibreGlDirectionsWaypointEvent;
    /**
     * Emitted when a waypoint is added.
     */
    addwaypoint: MapLibreGlDirectionsWaypointEvent;
    /**
     * Emitted when a waypoint is removed.
     */
    removewaypoint: MapLibreGlDirectionsWaypointEvent;
    /**
     * Emitted when a waypoint is moved. __Note__ that the event is not emitted if the waypoint has been dragged for an
     * amount of pixels less than specified by the {@link MapLibreGlDirectionsConfiguration.dragThreshold|`dragThreshold`}
     * configuration property.
     */
    movewaypoint: MapLibreGlDirectionsWaypointEvent;
    /**
     * Emitted when there appears an ongoing routing-request.
     */
    fetchroutesstart: MapLibreGlDirectionsRoutingEvent;
    /**
     * Emitted after the ongoing routing-request has finished.
     */
    fetchroutesend: MapLibreGlDirectionsRoutingEvent;
}
export type MapLibreGlDirectionsEventListener<T extends keyof MapLibreGlDirectionsEventType> = (event: MapLibreGlDirectionsEventType[T]) => void;
export interface MapLibreGlDirectionsEvent<TOrig, T extends keyof MapLibreGlDirectionsEventType> {
    type: T;
    target: Map;
    originalEvent: TOrig;
}
export interface MapLibreGlDirectionsWaypointEventData {
    /**
     * Index of the added/removed/moved waypoint.
     *
     * Never presents for {@link MapLibreGlDirectionsEventType.setwaypoints|`setwaypoints`} and
     * {@link MapLibreGlDirectionsEventType.rotatewaypoints|`rotatewaypoints`} events.
     */
    index: number;
    /**
     * Coordinates from which the waypoint has been moved.
     *
     * Only presents when it's the {@link MapLibreGlDirectionsEventType.movewaypoint|`movewaypoint`} event.
     */
    initialCoordinates: [number, number];
}
export declare class MapLibreGlDirectionsWaypointEvent implements MapLibreGlDirectionsEvent<MapMouseEvent | MapTouchEvent | undefined, "setwaypoints" | "rotatewaypoints" | "addwaypoint" | "removewaypoint" | "movewaypoint"> {
    /**
     * @private
     */
    constructor(type: "setwaypoints" | "rotatewaypoints" | "addwaypoint" | "removewaypoint" | "movewaypoint", originalEvent: MapMouseEvent | MapTouchEvent | undefined, data?: Partial<MapLibreGlDirectionsWaypointEventData>);
    type: "setwaypoints" | "rotatewaypoints" | "addwaypoint" | "removewaypoint" | "movewaypoint";
    target: Map;
    originalEvent: MapMouseEvent | MapTouchEvent | undefined;
    data?: Partial<MapLibreGlDirectionsWaypointEventData>;
}
export type MapLibreGlDirectionsRoutingEventData = Directions;
export declare class MapLibreGlDirectionsRoutingEvent implements MapLibreGlDirectionsEvent<MapLibreGlDirectionsWaypointEvent, "fetchroutesstart" | "fetchroutesend"> {
    /**
     * @private
     */
    constructor(type: "fetchroutesstart" | "fetchroutesend", originalEvent: MapLibreGlDirectionsWaypointEvent, data?: MapLibreGlDirectionsRoutingEventData);
    type: "fetchroutesstart" | "fetchroutesend";
    target: Map;
    originalEvent: MapLibreGlDirectionsWaypointEvent;
    /**
     * The server's response.
     *
     * Only presents when it's the {@link MapLibreGlDirectionsEventType.fetchroutesend|`fetchroutesend`} event, but might
     * be `undefined` in case the request to fetch directions failed.
     *
     * @see http://project-osrm.org/docs/v5.24.0/api/#responses
     */
    data?: MapLibreGlDirectionsRoutingEventData;
}