mobility-toolbox-js 2.0.0-beta.52 → 2.0.0-beta.54

package/ol/controls/RoutingControl.d.ts

@@ -1,4 +1,34 @@
-export default RoutingControl;
+import { Feature } from 'ol';
+import type { Map, MapBrowserEvent } from 'ol';
+import { Geometry, LineString, Point } from 'ol/geom';
+import { Modify } from 'ol/interaction';
+import { GeoJSON } from 'ol/format';
+import type { Coordinate } from 'ol/coordinate';
+import type { StyleLike } from 'ol/style/Style';
+import { EventsKey } from 'ol/events';
+import { ModifyEvent } from 'ol/interaction/Modify';
+import { RoutingAPI } from '../../api';
+import ControlCommon from '../../common/controls/ControlCommon';
+import type { ControlCommonOptions } from '../../common/controls/ControlCommon';
+import RoutingLayer from '../layers/RoutingLayer';
+import type { RoutingGraph, RoutingMot, RoutingParameters, RoutingViaPoint } from '../../types';
+export declare type RoutingControlOptions = ControlCommonOptions & {
+    apiKey?: string;
+    stopsApiKey?: string;
+    stopsApiUrl?: string;
+    routingLayer?: RoutingLayer;
+    graphs?: RoutingGraph[];
+    mot?: string;
+    modify?: boolean;
+    routingApiParams?: RoutingParameters;
+    useRawViaPoints?: boolean;
+    snapToClosestStation?: boolean;
+    style?: StyleLike;
+    onRouteError?: () => void;
+};
+export declare type AbotControllersByGraph = {
+    [key: string]: AbortController;
+};
 /**
  * Display a route of a specified mean of transport.
  *
@@ -30,70 +60,45 @@ export default RoutingControl;
  * @extends {Control}
  * @implements {RoutingInterface}
  */
-declare class RoutingControl implements RoutingInterface {
-    /**
-     * Calculate at which resolutions corresponds each generalizations.
-     *
-     * @private
-     */
-    private static getGraphsResolutions;
-    constructor(options?: {});
-    /** True if the control is requesting the backend. */
+declare class RoutingControl extends ControlCommon {
+    map?: Map;
+    viaPoints: RoutingViaPoint[];
+    routingLayer?: RoutingLayer;
     loading: boolean;
-    /** @ignore */
-    graphs: any;
-    /** @ignore */
-    mot: any;
-    /** @ignore */
+    graphs: RoutingGraph[];
+    mot?: RoutingMot;
     modify: boolean;
-    /** @ignore */
-    routingApiParams: any;
-    /** @ignore */
-    useRawViaPoints: any;
-    /** @ignore */
-    snapToClosestStation: any;
-    /** @ignore */
-    cacheStationData: {};
-    /** @ignore */
-    abortControllers: any[];
-    /** @ignore */
-    apiKey: any;
-    /** @ignore */
-    stopsApiKey: any;
-    /** @ignore */
-    segments: any[];
-    /** @ignore */
-    stopsApiUrl: any;
-    /** @ignore */
-    api: RoutingAPI;
-    /** @ignore */
-    routingLayer: any;
-    /** @ignore */
-    onRouteError: any;
-    /** @ignore */
-    viaPoints: any[];
-    /**
-     * Used on click on map while control is active:
-     *   By default adds a viaPoint to the end of array.
-     *   If an existing viaPoint is clicked removes the clicked viaPoint.
-     * @private
-     */
-    private onMapClick;
+    routingApiParams?: RoutingParameters;
+    useRawViaPoints: boolean;
+    snapToClosestStation: boolean;
+    cacheStationData: {
+        [key: string]: Coordinate;
+    };
+    abortControllers: {
+        [key: string]: AbortController;
+    };
+    apiKey?: string;
+    stopsApiKey?: string;
+    segments: Feature<LineString>[];
+    stopsApiUrl?: string;
+    api?: RoutingAPI;
+    format: GeoJSON;
+    graphsResolutions?: [number, number][];
+    onRouteError: (error?: Error, control?: RoutingControl) => void;
+    onMapClickKey?: EventsKey;
+    modifyInteraction?: Modify;
+    initialRouteDrag?: {
+        viaPoint?: Feature<Point>;
+        oldRoute?: Feature<LineString>;
+        segmentIndex?: number;
+    };
+    constructor(options?: RoutingControlOptions);
     /**
-     * Used on end of the modify interaction. Resolves feature modification:
-     *   Line drag creates new viaPoint at the final coordinate of drag.
-     *   Point drag replaces old viaPoint.
-     * @private
-     */
-    private onModifyEnd;
-    /**
-     * Used on start of the modify interaction. Stores relevant data
-     * in this.initialRouteDrag object
+     * Calculate at which resolutions corresponds each generalizations.
+     *
      * @private
      */
-    private onModifyStart;
-    /** @ignore */
-    apiChangeListener: () => Promise<void | Feature<import("ol/geom/Geometry").default>> | Promise<Feature<import("ol/geom/Geometry").default> | null> | Promise<any[]> | null;
+    static getGraphsResolutions(graphs: RoutingGraph[], map: Map): [number, number][];
     /**
      * Adds/Replaces a viaPoint to the viaPoints array and redraws route:
      *   Adds a viaPoint at end of array by default.
@@ -104,7 +109,7 @@ declare class RoutingControl implements RoutingInterface {
      * @param {number} [index=-1] Integer representing the index of the added viaPoint. If not specified, the viaPoint is added at the end of the array.
      * @param {number} [overwrite=0] Marks the number of viaPoints that are removed at the specified index on add.
      */
-    addViaPoint(coordinatesOrString: any, index?: number | undefined, overwrite?: number | undefined): void;
+    addViaPoint(coordinatesOrString: RoutingViaPoint, index?: number, overwrite?: number): void;
     /**
      * Removes a viaPoint at the passed array index and redraws route
      * By default the last viaPoint is removed.
@@ -115,7 +120,7 @@ declare class RoutingControl implements RoutingInterface {
      * Replaces the current viaPoints with a new coordinate array.
      * @param {Array<Array<number>>} coordinateArray Array of nested coordinates
      */
-    setViaPoints(coordinateArray: Array<Array<number>>): void;
+    setViaPoints(coordinateArray: Coordinate[]): void;
     /**
      * Removes all viaPoints, clears the source and triggers a change event
      */
@@ -124,7 +129,7 @@ declare class RoutingControl implements RoutingInterface {
      * Aborts viapoint and route requests
      * @private
      */
-    private abortRequests;
+    abortRequests(): void;
     /**
      * Draws route on map using an array of coordinates:
      *   If a single coordinate is passed a single point feature is added to map.
@@ -132,58 +137,57 @@ declare class RoutingControl implements RoutingInterface {
      *       the route using the passed coordinates and the current mot.
      * @private
      */
-    private drawRoute;
+    drawRoute(): Promise<void | Feature<Geometry>> | Promise<Feature<Geometry> | null> | Promise<(void | never[])[]> | null;
     /**
      * Draw a via point. This function can parse all the possibilitiies
      *
      * @private
      */
-    private drawViaPoint;
-    /** @ignore */
-    initialRouteDrag: {
-        viaPoint: any;
-        oldRoute: any;
-        segmentIndex: number;
-    } | undefined;
+    drawViaPoint(viaPoint: RoutingViaPoint, idx: number, abortController: AbortController): Promise<void | Feature<Geometry>> | Promise<Feature<Geometry> | null>;
     /**
-     * Define a default element.
-     *
+     * Used on click on map while control is active:
+     *   By default adds a viaPoint to the end of array.
+     *   If an existing viaPoint is clicked removes the clicked viaPoint.
      * @private
      */
-    private createDefaultElement;
-    /** @ignore */
-    element: HTMLButtonElement | undefined;
+    onMapClick(evt: MapBrowserEvent<MouseEvent>): void;
     /**
-     * Create the interaction used to modify vertexes of features.
+     * Used on start of the modify interaction. Stores relevant data
+     * in this.initialRouteDrag object
      * @private
      */
-    private createModifyInteraction;
+    onModifyStart(evt: ModifyEvent): void;
     /**
-     * @type {ol.interaction.Modify}
+     * Used on end of the modify interaction. Resolves feature modification:
+     *   Line drag creates new viaPoint at the final coordinate of drag.
+     *   Point drag replaces old viaPoint.
      * @private
      */
-    private modifyInteraction;
+    onModifyEnd(evt: ModifyEvent): void | Promise<never>;
+    /**
+     * Define a default element.
+     *
+     * @private
+     */
+    createDefaultElement(): void;
+    /**
+     * Create the interaction used to modify vertexes of features.
+     * @private
+     */
+    createModifyInteraction(): void;
     /**
      * Add click listener to map.
      * @private
      */
-    private addListeners;
-    /** @ignore */
-    onMapClickKey: any;
+    addListeners(): void;
     /**
      * Remove click listener from map.
      * @private
      */
-    private removeListeners;
+    removeListeners(): void;
     activate(): void;
-    /** @ignore */
-    format: GeoJSON | undefined;
-    /** @ignore */
-    graphsResolutions: any;
     deactivate(): void;
     render(): void;
 }
-import { RoutingAPI } from "../../api";
-import { Feature } from "ol";
-import { GeoJSON } from "ol/format";
+export default RoutingControl;
 //# sourceMappingURL=RoutingControl.d.ts.map

package/ol/controls/RoutingControl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RoutingControl.d.ts","sourceRoot":"","sources":["../../../src/ol/controls/RoutingControl.js"],"names":[],"mappings":";AAiDA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wCAFgB,gBAAgB;IAoH9B;;;;OAIG;IACH,oCAMC;IA5HD,0BA+GC;IAlFC,qDAAqD;IACrD,iBAAoB;IAEpB,cAAc;IACd,YAAgD;IAEhD,cAAc;IACd,SAA+B;IAE/B,cAAc;IACd,gBAAsC;IAEtC,cAAc;IACd,sBAAsD;IAEtD,cAAc;IACd,qBAAuD;IAEvD,cAAc;IACd,0BAAiE;IAEjE,cAAc;IACd,qBAA0B;IAE1B,cAAc;IACd,wBAA0B;IAE1B,cAAc;IACd,YAA4B;IAE5B,cAAc;IACd,iBAAqD;IAErD,cAAc;IACd,gBAAkB;IAElB,cAAc;IACd,iBAA0E;IAE1E,cAAc;IACd,gBAEE;IAEF,cAAc;IACd,kBAKI;IAEJ,cAAc;IACd,kBAUI;IAEJ,cAAc;IACd,iBAAmB;IAoXrB;;;;;OAKG;IACH,mBAeC;IA4CD;;;;;OAKG;IACH,oBAqBC;IArED;;;;OAIG;IACH,sBAmCC;IAxaC,cAAc;IACd,2KAA+C;IAmBjD;;;;;;;;;OASG;IACH,wGAYC;IAED;;;;OAIG;IACH,uBAFW,MAAM,QAYhB;IAED;;;OAGG;IACH,8BAFW,MAAM,MAAM,MAAM,CAAC,CAAC,QAS9B;IAED;;OAEG;IACH,cASC;IAED;;;OAGG;IACH,sBAeC;IAED;;;;;;OAMG;IACH,kBA0HC;IAED;;;;OAIG;IACH,qBAkHC;IA2DC,cAAc;IACd;;;;kBAIC;IAgCH;;;;OAIG;IACH,6BAYC;IAXC,cAAc;IACd,uCAA+C;IAYjD;;;OAGG;IACH,gCA8BC;IA7BC;;;OAGG;IAEH,0BAoBE;IAMJ;;;OAGG;IACH,qBAOC;IAFC,cAAc;IACd,mBAAgE;IAGlE;;;OAGG;IACH,wBAEC;IAED,iBA2BC;IAxBG,cAAc;IACd,4BAEE;IAEF,cAAc;IACd,uBAGC;IAiBL,mBAQC;IAED,eAAW;CACZ"}
+{"version":3,"file":"RoutingControl.d.ts","sourceRoot":"","sources":["../../../src/ol/controls/RoutingControl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAC7B,OAAO,KAAK,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,IAAI,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAGxC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAIpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,aAAa,MAAM,qCAAqC,CAAC;AAChE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,YAAY,MAAM,wBAAwB,CAAC;AAClD,OAAO,KAAK,EACV,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,eAAe,EAChB,MAAM,aAAa,CAAC;AAErB,oBAAY,qBAAqB,GAAG,oBAAoB,GAAG;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IAExB,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IAErC,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B,CAAC;AAEF,oBAAY,sBAAsB,GAAG;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;CAChC,CAAC;AA4CF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,cAAM,cAAe,SAAQ,aAAa;IACxC,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,SAAS,EAAE,eAAe,EAAE,CAAM;IAElC,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,OAAO,EAAE,OAAO,CAAS;IAEzB,MAAM,EAAE,YAAY,EAAE,CAAM;IAE5B,GAAG,CAAC,EAAE,UAAU,CAAC;IAEjB,MAAM,EAAE,OAAO,CAAQ;IAEvB,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;IAErC,eAAe,EAAE,OAAO,CAAS;IAEjC,oBAAoB,EAAE,OAAO,CAAS;IAEtC,gBAAgB,EAAE;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;KAC3B,CAAM;IAEP,gBAAgB,EAAE;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;KAChC,CAAM;IAEP,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,CAAM;IAErC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,GAAG,CAAC,EAAE,UAAU,CAAC;IAEjB,MAAM,EAAE,OAAO,CAAmD;IAElE,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAEvC,YAAY,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAEhE,aAAa,CAAC,EAAE,SAAS,CAAC;IAE1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAM;gBAEK,OAAO,GAAE,qBAA0B;IA+F/C;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CACzB,MAAM,EAAE,YAAY,EAAE,EACtB,GAAG,EAAE,GAAG,GACP,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;IAQrB;;;;;;;;;OASG;IACH,WAAW,CACT,mBAAmB,EAAE,eAAe,EACpC,KAAK,GAAE,MAAW,EAClB,SAAS,GAAE,MAAU;IAYvB;;;;OAIG;IACH,cAAc,CAAC,KAAK,SAAoC;IASxD;;;OAGG;IACH,YAAY,CAAC,eAAe,EAAE,UAAU,EAAE;IAM1C;;OAEG;IACH,KAAK;IAQL;;;OAGG;IACH,aAAa;IAkBb;;;;;;OAMG;IACH,SAAS;IA4IT;;;;OAIG;IACH,YAAY,CACV,QAAQ,EAAE,eAAe,EACzB,GAAG,EAAE,MAAM,EACX,eAAe,EAAE,eAAe;IAiHlC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,eAAe,CAAC,UAAU,CAAC;IAmB3C;;;;OAIG;IACH,aAAa,CAAC,GAAG,EAAE,WAAW;IAwC9B;;;;;OAKG;IACH,WAAW,CAAC,GAAG,EAAE,WAAW;IAuB5B;;;;OAIG;IACH,oBAAoB;IAcpB;;;OAGG;IACH,uBAAuB;IAgCvB;;;OAGG;IACH,YAAY;IASZ;;;OAGG;IACH,eAAe;IAMf,QAAQ;IA6BR,UAAU;IAYV,MAAM;CACP;AAED,eAAe,cAAc,CAAC"}