terra-draw 1.0.0-beta.6 → 1.0.0-beta.8

package/dist/adapters/common/adapter-listener.d.ts

@@ -0,0 +1,22 @@
+export declare class AdapterListener<Callback extends (...args: any[]) => any> {
+    name: string;
+    callback: (...args: any[]) => any;
+    registered: boolean;
+    register: any;
+    unregister: any;
+    /**
+     * Creates a new AdapterListener instance with the provided configuration.
+     *
+     * @param {Object} config - The configuration object for the listener.
+     * @param {string} config.name - The name of the event listener.
+     * @param {Function} config.callback - The callback function to be called when the event is triggered.
+     * @param {Function} config.unregister - The function to unregister the event listeners.
+     * @param {Function} config.register - The function to register the event listeners.
+     */
+    constructor({ name, callback, unregister, register, }: {
+        name: string;
+        callback: Callback;
+        unregister: (callbacks: Callback) => void;
+        register: (callback: Callback) => void;
+    });
+}

package/dist/adapters/common/base.adapter.d.ts

@@ -0,0 +1,59 @@
+import { Project, Unproject, TerraDrawCallbacks, TerraDrawChanges, TerraDrawMouseEvent, SetCursor, TerraDrawStylingFunction, GetLngLatFromEvent, TerraDrawAdapter } from "../../common";
+import { AdapterListener } from "./adapter-listener";
+type BasePointerListener = (event: PointerEvent) => void;
+type BaseKeyboardListener = (event: KeyboardEvent) => void;
+type BaseMouseListener = (event: MouseEvent) => void;
+export type BaseAdapterConfig = {
+    coordinatePrecision?: number;
+    minPixelDragDistanceDrawing?: number;
+    minPixelDragDistance?: number;
+    minPixelDragDistanceSelecting?: number;
+};
+export declare abstract class TerraDrawBaseAdapter implements TerraDrawAdapter {
+    constructor(config: BaseAdapterConfig);
+    protected _minPixelDragDistance: number;
+    protected _minPixelDragDistanceDrawing: number;
+    protected _minPixelDragDistanceSelecting: number;
+    protected _lastDrawEvent: TerraDrawMouseEvent | undefined;
+    protected _coordinatePrecision: number;
+    protected _heldKeys: Set<string>;
+    protected _listeners: AdapterListener<BasePointerListener | BaseKeyboardListener | BaseMouseListener>[];
+    protected _dragState: "not-dragging" | "pre-dragging" | "dragging";
+    protected _currentModeCallbacks: TerraDrawCallbacks | undefined;
+    abstract getMapEventElement(): HTMLElement;
+    protected getButton(event: PointerEvent | MouseEvent): "neither" | "left" | "middle" | "right";
+    protected getMapElementXYPosition(event: PointerEvent | MouseEvent): {
+        containerX: number;
+        containerY: number;
+    };
+    protected getDrawEventFromEvent(event: PointerEvent | MouseEvent): TerraDrawMouseEvent | null;
+    /**
+     * Registers the provided callbacks for the current drawing mode and attaches
+     * the necessary event listeners.
+     * @param {TerraDrawCallbacks} callbacks - An object containing callback functions
+     * for handling various drawing events in the current mode.
+     */
+    register(callbacks: TerraDrawCallbacks): void;
+    /**
+     * Gets the coordinate precision. The coordinate precision is the number of decimal places in geometry
+     * coordinates stored in the store.
+     * @returns {number} The coordinate precision.
+     */
+    getCoordinatePrecision(): number;
+    protected getAdapterListeners(): AdapterListener<BasePointerListener>[];
+    /**
+     * Unregisters the event listeners for the current drawing mode.
+     * This is typically called when switching between drawing modes or
+     * stopping the drawing process.
+     */
+    unregister(): void;
+    abstract clear(): void;
+    abstract project(...args: Parameters<Project>): ReturnType<Project>;
+    abstract unproject(...args: Parameters<Unproject>): ReturnType<Unproject>;
+    abstract setCursor(...args: Parameters<SetCursor>): ReturnType<SetCursor>;
+    abstract getLngLatFromEvent(...event: Parameters<GetLngLatFromEvent>): ReturnType<GetLngLatFromEvent>;
+    abstract setDraggability(enabled: boolean): void;
+    abstract setDoubleClickToZoom(enabled: boolean): void;
+    abstract render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+}
+export {};

package/dist/adapters/openlayers.adapter.d.ts

@@ -25,6 +25,7 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
     constructor(config: {
         map: Map;
         lib: InjectableOL;
+        zIndex?: number;
     } & BaseAdapterConfig);
     private stylingFunction;
     private _lib;
@@ -47,6 +48,12 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
     private clearLayers;
     private addFeature;
     private removeFeature;
+    /**
+     * Sorts an array of DOM elements based on their order in the document, from earliest to latest.
+     * @param elements - An array of `HTMLElement` objects to be sorted.
+     * @returns A new array of `HTMLElement` objects sorted by their document order.
+     */
+    private sortElementsByDOMOrder;
     /**
      * Returns the longitude and latitude coordinates from a given PointerEvent on the map.
      * @param event The PointerEvent or MouseEvent  containing the screen coordinates of the pointer.
@@ -107,6 +114,7 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
      * @returns void
      * */
     clear(): void;
+    private registeredLayerHandlers;
     register(callbacks: TerraDrawCallbacks): void;
     getCoordinatePrecision(): number;
     unregister(): void;