terra-draw 0.0.1-alpha.4 → 0.0.1-alpha.41

package/dist/adapters/google-maps.adapter.d.ts

@@ -1,38 +1,87 @@
-/// <reference types="google.maps" />
-import { TerraDrawCallbacks, TerraDrawAdapter, TerraDrawModeRegisterConfig, TerraDrawAdapterStyling, TerraDrawChanges } from "../common";
-export declare class TerraDrawGoogleMapsAdapter implements TerraDrawAdapter {
-    constructor(config: {
-        lib: typeof google.maps;
-        map: google.maps.Map;
-        coordinatePrecision?: number;
-    });
-    private _heldKeys;
-    private _cursor;
-    private _cursorStyleSheet;
-    private _coordinatePrecision;
-    private _lib;
-    private _map;
-    private _onMouseMoveListener;
-    private _onMouseMoveCallback;
-    private _onClickListener;
-    private _onRightClickListener;
-    private _onClickCallback;
-    private _onKeyUpListener;
-    private _onDragStartListener;
-    private _onDragListener;
-    private _onDragEndListener;
-    private _layers;
-    getMapContainer: () => HTMLElement;
-    unproject: (x: number, y: number) => {
-        lng: number;
-        lat: number;
-    };
-    project: TerraDrawModeRegisterConfig["project"];
-    setCursor: TerraDrawModeRegisterConfig["setCursor"];
-    private circlePath;
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    render(changes: TerraDrawChanges, styling: {
-        [mode: string]: TerraDrawAdapterStyling;
-    }): void;
-}
+/// <reference types="google.maps" />
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
+    constructor(config: {
+        lib: typeof google.maps;
+        map: google.maps.Map;
+        coordinatePrecision?: number;
+    });
+    private _cursor;
+    private _cursorStyleSheet;
+    private _lib;
+    private _map;
+    private _layers;
+    private _overlay;
+    /**
+     * Generates an SVG path string for a circle with the given center coordinates and radius.
+     * Based off this StackOverflow answer: https://stackoverflow.com/a/27905268/1363484
+     * @param cx The x-coordinate of the circle's center.
+     * @param cy The y-coordinate of the circle's center.
+     * @param r The radius of the circle.
+     * @returns The SVG path string representing the circle.
+     */
+    private circlePath;
+    /**
+     * 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.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    } | null;
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(cursor: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    private renderedFeatures;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+    private clearLayers;
+    /**
+     * Clears the map and store of all rendered data layers
+     * @returns void
+     * */
+    clear(): void;
+}

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

@@ -1,35 +1,98 @@
-import { TerraDrawCallbacks, TerraDrawAdapter, TerraDrawModeRegisterConfig, TerraDrawAdapterStyling, TerraDrawChanges } from "../common";
-import L from "leaflet";
-export declare class TerraDrawLeafletAdapter implements TerraDrawAdapter {
-    constructor(config: {
-        lib: typeof L;
-        map: L.Map;
-        coordinatePrecision?: number;
-    });
-    private _heldKeys;
-    private _lib;
-    private _coordinatePrecision;
-    private _map;
-    private _onMouseMoveListener;
-    private _onClickListener;
-    private _onKeyUpListener;
-    private _onKeyDownListener;
-    private _onDragStartListener;
-    private _onDragListener;
-    private _onDragEndListener;
-    private _layer;
-    private _midPointPaneZIndexStyleSheet;
-    private _midPointPane;
-    private _selectionPaneZIndexStyleSheet;
-    private _selectedPane;
-    project: TerraDrawModeRegisterConfig["project"];
-    unproject: TerraDrawModeRegisterConfig["unproject"];
-    setCursor: TerraDrawModeRegisterConfig["setCursor"];
-    getMapContainer: () => HTMLElement;
-    private createPaneStyleSheet;
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    render(changes: TerraDrawChanges, styling: {
-        [mode: string]: TerraDrawAdapterStyling;
-    }): void;
-}
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import L from "leaflet";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+export declare class TerraDrawLeafletAdapter extends TerraDrawBaseAdapter {
+    constructor(config: {
+        lib: typeof L;
+        map: L.Map;
+        coordinatePrecision?: number;
+        minPixelDragDistance?: number;
+    });
+    private _lib;
+    private _map;
+    private _panes;
+    private _container;
+    private _layers;
+    /**
+     * Creates a pane and its associated style sheet
+     * @param pane - The pane name
+     * @param zIndex - The zIndex value for the pane
+     * @returns The created style element
+     */
+    private createPaneStyleSheet;
+    /**
+     * Clears the panes created by the adapter
+     * @returns void
+     * */
+    private clearPanes;
+    /**
+     * Clears the leaflet layers created by the adapter
+     * @returns void
+     * */
+    private clearLayers;
+    /**
+     * Styles a GeoJSON layer based on the styling function
+     * @param styling - The styling function
+     * */
+    private styleGeoJSONLayer;
+    /**
+     * 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.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    } | null;
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(cursor: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+    /**
+     * Clears the map and store of all rendered data layers
+     * @returns void
+     * */
+    clear(): void;
+}

package/dist/adapters/mapbox-gl.adapter.d.ts

@@ -1,36 +1,89 @@
-import { TerraDrawCallbacks, TerraDrawAdapter, TerraDrawModeRegisterConfig, TerraDrawAdapterStyling, TerraDrawChanges } from "../common";
-import mapboxgl from "mapbox-gl";
-export declare class TerraDrawMapboxGLAdapter implements TerraDrawAdapter {
-    constructor(config: {
-        map: mapboxgl.Map;
-        coordinatePrecision: number;
-    });
-    unproject: TerraDrawModeRegisterConfig["unproject"];
-    project: TerraDrawModeRegisterConfig["project"];
-    setCursor: TerraDrawModeRegisterConfig["setCursor"];
-    getMapContainer: () => HTMLElement;
-    private _heldKeys;
-    private _coordinatePrecision;
-    private _map;
-    private _onMouseMoveListener;
-    private _onClickListener;
-    private _onDragStartListener;
-    private _onDragListener;
-    private _onDragEndListener;
-    private _onKeyDownListener;
-    private _onKeyUpListener;
-    private _rendered;
-    private _addGeoJSONSource;
-    private _addFillLayer;
-    private _addFillOutlineLayer;
-    private _addLineLayer;
-    private _addPointLayer;
-    private _addLayer;
-    private _addGeoJSONLayer;
-    private _setGeoJSONLayerData;
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    render(changes: TerraDrawChanges, styling: {
-        [mode: string]: TerraDrawAdapterStyling;
-    }): void;
-}
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import mapboxgl from "mapbox-gl";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+export declare class TerraDrawMapboxGLAdapter extends TerraDrawBaseAdapter {
+    constructor(config: {
+        map: mapboxgl.Map;
+        coordinatePrecision?: number;
+    });
+    private _nextRender;
+    private _map;
+    private _container;
+    private _rendered;
+    /**
+     * Clears the map of rendered layers and sources
+     * @returns void
+     * */
+    private clearLayers;
+    private _addGeoJSONSource;
+    private _addFillLayer;
+    private _addFillOutlineLayer;
+    private _addLineLayer;
+    private _addPointLayer;
+    private _addLayer;
+    private _addGeoJSONLayer;
+    private _setGeoJSONLayerData;
+    private getEmptyGeometries;
+    private changedIds;
+    private updateChangedIds;
+    /**
+     * 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.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(cursor: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+    /**
+     * Clears the map and store of all rendered data layers
+     * @returns void
+     * */
+    clear(): void;
+}

package/dist/adapters/maplibre-gl.adapter.d.ts

@@ -0,0 +1,72 @@
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
+import { Map } from "maplibre-gl";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
+    private mapboxglAdapter;
+    constructor(config: {
+        map: Map;
+        coordinatePrecision?: number;
+    });
+    register(callbacks: TerraDrawCallbacks): void;
+    unregister(): void;
+    /**
+     * 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.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(style: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+    /**
+     * Clears the map and store of all rendered data layers
+     * @returns void
+     * */
+    clear(): void;
+}

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

@@ -0,0 +1,117 @@
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import CircleGeom from "ol/geom/Circle";
+import Feature from "ol/Feature";
+import GeoJSON from "ol/format/GeoJSON";
+import Map from "ol/Map";
+import Circle from "ol/style/Circle";
+import Stroke from "ol/style/Stroke";
+import Style from "ol/style/Style";
+import VectorSource from "ol/source/Vector";
+import VectorLayer from "ol/layer/Vector";
+import { toLonLat } from "ol/proj";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+type InjectableOL = {
+    Circle: typeof CircleGeom;
+    Feature: typeof Feature;
+    GeoJSON: typeof GeoJSON;
+    Style: typeof Style;
+    CircleStyle: typeof Circle;
+    VectorLayer: typeof VectorLayer;
+    VectorSource: typeof VectorSource;
+    Stroke: typeof Stroke;
+    toLonLat: typeof toLonLat;
+};
+export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
+    constructor(config: {
+        map: Map;
+        lib: InjectableOL;
+        coordinatePrecision?: number;
+    });
+    private _lib;
+    private _map;
+    private _container;
+    private _projection;
+    private _vectorSource;
+    private _geoJSONReader;
+    /**
+     * Converts a hexideciaml color to RGB
+     * @param hex a string of the hexidecimal string
+     * @returns an object to red green and blue (RGB) color
+     */
+    private hexToRGB;
+    /**
+     * Converts a hexideciaml color to RGB
+     * @param feature
+     * @param styling
+     * @returns an object to red green and blue (RGB) color
+     */
+    private getStyles;
+    /**
+     * Clears the layers created by the adapter
+     * @returns void
+     * */
+    private clearLayers;
+    private addFeature;
+    private removeFeature;
+    /**
+     * 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.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    } | null;
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(cursor: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+    /**
+     * Clears the map and store of all rendered data layers
+     * @returns void
+     * */
+    clear(): void;
+}
+export {};