terra-draw 0.0.1-alpha.29 → 0.0.1-alpha.30

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.1-alpha.30](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.29...v0.0.1-alpha.30) (2023-05-21)
+
+
+### Bug Fixes
+
+* allow wait as a setCursor parameter ([839bb90](https://github.com/JamesLMilner/terra-draw/commit/839bb906999420931f3b2833be781688a2ec39be))
+* clear now removes all rendered layers ([fd7a208](https://github.com/JamesLMilner/terra-draw/commit/fd7a2081338b4d6ebfc3e93a6580a38b9649343a))
+* correctly name styling typings for rectangle mode ([a460a3a](https://github.com/JamesLMilner/terra-draw/commit/a460a3aa7411f275d72930f5d41bd76de107c1d9))
+
+
+### Chore
+
+* update docs ([ea4f52c](https://github.com/JamesLMilner/terra-draw/commit/ea4f52ca091772c8bed2c1b6c103db7b4734eb6e))
+
 ### [0.0.1-alpha.29](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.28...v0.0.1-alpha.29) (2023-05-14)
 
 

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

@@ -34,6 +34,7 @@ export declare abstract class TerraDrawBaseAdapter {
      * 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>;

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

@@ -71,10 +71,17 @@ export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
      * @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

@@ -20,6 +20,20 @@ export declare class TerraDrawLeafletAdapter extends TerraDrawBaseAdapter {
      * @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.
@@ -76,4 +90,9 @@ export declare class TerraDrawLeafletAdapter extends TerraDrawBaseAdapter {
      * @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

@@ -9,6 +9,11 @@ export declare class TerraDrawMapboxGLAdapter extends TerraDrawBaseAdapter {
     private _map;
     private _container;
     private _rendered;
+    /**
+     * Clears the map of rendered layers and sources
+     * @returns void
+     * */
+    private clearLayers;
     private _addGeoJSONSource;
     private _addFillLayer;
     private _addFillOutlineLayer;
@@ -72,4 +77,9 @@ export declare class TerraDrawMapboxGLAdapter extends TerraDrawBaseAdapter {
      * @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

@@ -1,4 +1,4 @@
-import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
 import { Map } from "maplibre-gl";
 import { TerraDrawBaseAdapter } from "./common/base.adapter";
 export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
@@ -7,6 +7,8 @@ export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
         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.
@@ -62,4 +64,9 @@ export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
      * @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

@@ -46,6 +46,11 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
      * @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;
     /**
@@ -103,5 +108,10 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
      * @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 {};

package/dist/common.d.ts

@@ -24,7 +24,7 @@ export interface TerraDrawMouseEvent {
 export interface TerraDrawKeyboardEvent {
     key: string;
 }
-export type SetCursor = (cursor: "unset" | "grab" | "grabbing" | "crosshair" | "pointer") => void;
+export type SetCursor = (cursor: "unset" | "grab" | "grabbing" | "crosshair" | "pointer" | "wait") => void;
 export type Project = (lng: number, lat: number) => {
     x: number;
     y: number;
@@ -58,6 +58,7 @@ export interface TerraDrawCallbacks {
     onDragStart: (event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void) => void;
     onDrag: (event: TerraDrawMouseEvent) => void;
     onDragEnd: (event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void) => void;
+    onClear: () => void;
 }
 export interface TerraDrawChanges {
     created: GeoJSONStoreFeatures[];
@@ -77,6 +78,7 @@ export interface TerraDrawAdapter {
     register(callbacks: TerraDrawCallbacks): void;
     unregister(): void;
     render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+    clear(): void;
 }
 export declare const SELECT_PROPERTIES: {
     readonly SELECTED: "selected";

package/dist/modes/base.mode.d.ts

@@ -31,6 +31,7 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     register(config: TerraDrawModeRegisterConfig): void;
     abstract start(): void;
     abstract stop(): void;
+    abstract cleanUp(): void;
     abstract styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
     onDeselect(deselectedId: string): void;
     onSelect(selectedId: string): void;

package/dist/modes/rectangle/rectangle.mode.d.ts

@@ -5,20 +5,20 @@ type TerraDrawRectangleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
 };
-type FreehandPolygonStyling = {
+type RectanglePolygonStyling = {
     fillColor: HexColor;
     outlineColor: HexColor;
     outlineWidth: number;
     fillOpacity: number;
 };
-export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<FreehandPolygonStyling> {
+export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<RectanglePolygonStyling> {
     mode: string;
     private center;
     private clickCount;
     private currentRectangleId;
     private keyEvents;
     constructor(options?: {
-        styles?: Partial<FreehandPolygonStyling>;
+        styles?: Partial<RectanglePolygonStyling>;
         keyEvents?: TerraDrawRectangleModeKeyEvents | null;
     });
     private close;

package/dist/modes/render/render.mode.d.ts

@@ -29,6 +29,8 @@ export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderMod
     /** @internal */
     onMouseMove(): void;
     /** @internal */
+    cleanUp(): void;
+    /** @internal */
     styleFeature(): TerraDrawAdapterStyling;
 }
 export {};

package/dist/modes/static/static.mode.d.ts

@@ -13,6 +13,7 @@ export declare class TerraDrawStaticMode extends TerraDrawBaseDrawMode<StaticMod
     onDrag(): void;
     onDragEnd(): void;
     onMouseMove(): void;
+    cleanUp(): void;
     styleFeature(): {
         pointColor: `#${string}`;
         pointWidth: number;