terra-draw 0.0.1-alpha.44 → 0.0.1-alpha.47

package/README.md

@@ -18,10 +18,11 @@ Terra Draw uses the concept of 'adapters' to allow it to work with a host of dif
 - [Mapbox GL JS](https://www.mapbox.com/mapbox-gljs) v2
 - [MapLibre](https://maplibre.org/projects/maplibre-gl-js/) v2/v3
 - [Google Maps JS API](https://developers.google.com/maps/documentation/javascript/overview) v3
+- [ArcGIS JavaScript SDK](https://developers.arcgis.com/javascript/latest/) v4 (MapView)
 
 ### Getting Started
 
-Please see the [the getting started guide](./guides/GETTING_STARTED.md)
+Please see the [the getting started guide](./guides/GETTING_STARTED.md) - this provides a host of information on how get up and running with Terra Draw. You may also find some useful pointers for things you may be finding yourself wanting to do in the [common patterns guide](./guides/COMMON_PATTERNS.md).
 
 ### Development
 

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

@@ -6,9 +6,13 @@ type BaseMouseListener = (event: MouseEvent) => void;
 export declare abstract class TerraDrawBaseAdapter {
     constructor(config: {
         coordinatePrecision?: number;
+        minPixelDragDistanceDrawing?: number;
         minPixelDragDistance?: number;
+        minPixelDragDistanceSelecting?: number;
     });
     protected _minPixelDragDistance: number;
+    protected _minPixelDragDistanceDrawing: number;
+    protected _minPixelDragDistanceSelecting: number;
     protected _lastDrawEvent: TerraDrawMouseEvent | undefined;
     protected _coordinatePrecision: number;
     protected _heldKeys: Set<string>;

package/dist/common.d.ts

@@ -28,7 +28,11 @@ export interface TerraDrawKeyboardEvent {
     heldKeys: string[];
     preventDefault: () => void;
 }
-export type SetCursor = (cursor: "unset" | "grab" | "grabbing" | "crosshair" | "pointer" | "wait") => void;
+export type Required<T> = {
+    [P in keyof T]-?: T[P];
+};
+export type Cursor = Parameters<SetCursor>[0];
+export type SetCursor = (cursor: "unset" | "grab" | "grabbing" | "crosshair" | "pointer" | "wait" | "move") => void;
 export type Project = (lng: number, lat: number) => {
     x: number;
     y: number;
@@ -53,7 +57,7 @@ export interface TerraDrawModeRegisterConfig {
     project: Project;
     unproject: Unproject;
 }
-export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selected" | "stopped";
+export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selecting" | "stopped";
 export interface TerraDrawCallbacks {
     getState: () => TerraDrawModeState;
     onKeyUp: (event: TerraDrawKeyboardEvent) => void;
@@ -78,6 +82,7 @@ export interface TerraDrawAdapter {
     project: Project;
     unproject: Unproject;
     setCursor: SetCursor;
+    getLngLatFromEvent: GetLngLatFromEvent;
     setDoubleClickToZoom: (enabled: boolean) => void;
     getMapContainer: () => HTMLElement;
     register(callbacks: TerraDrawCallbacks): void;

package/dist/geometry/shape/create-bbox.d.ts

@@ -0,0 +1,10 @@
+import { Feature, Polygon } from "geojson";
+import { Unproject } from "../../common";
+export declare function createBBoxFromPoint({ unproject, point, pointerDistance, }: {
+    point: {
+        x: number;
+        y: number;
+    };
+    unproject: Unproject;
+    pointerDistance: number;
+}): Feature<Polygon, import("geojson").GeoJsonProperties>;

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

@@ -1,25 +1,30 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawCircleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
 };
-type FreehandPolygonStyling = {
+type CirclePolygonStyling = {
     fillColor: HexColorStyling;
     outlineColor: HexColorStyling;
     outlineWidth: NumericStyling;
     fillOpacity: NumericStyling;
 };
-export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<FreehandPolygonStyling> {
+interface Cursors {
+    start?: Cursor;
+}
+export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePolygonStyling> {
     mode: string;
     private center;
     private clickCount;
     private currentCircleId;
     private keyEvents;
+    private cursors;
     constructor(options?: {
-        styles?: Partial<FreehandPolygonStyling>;
+        styles?: Partial<CirclePolygonStyling>;
         keyEvents?: TerraDrawCircleModeKeyEvents | null;
+        cursors?: Cursors;
     });
     private close;
     /** @internal */

package/dist/modes/click-bounding-box.behavior.d.ts

@@ -1,7 +1,6 @@
-import { Feature, Polygon } from "geojson";
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
 import { TerraDrawMouseEvent } from "../common";
 export declare class ClickBoundingBoxBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig);
-    create(event: TerraDrawMouseEvent): Feature<Polygon, import("geojson").GeoJsonProperties>;
+    create(event: TerraDrawMouseEvent): import("geojson").Feature<import("geojson").Polygon, import("geojson").GeoJsonProperties>;
 }

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { GeoJSONStoreFeatures } from "../../store/store";
 type TerraDrawFreehandModeKeyEvents = {
@@ -15,6 +15,10 @@ type FreehandPolygonStyling = {
     closingPointOutlineColor: HexColorStyling;
     closingPointOutlineWidth: NumericStyling;
 };
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
 export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygonStyling> {
     mode: string;
     private startingClick;
@@ -22,10 +26,12 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     private closingPointId;
     private minDistance;
     private keyEvents;
+    private cursors;
     constructor(options?: {
         styles?: Partial<FreehandPolygonStyling>;
         minDistance?: number;
         keyEvents?: TerraDrawFreehandModeKeyEvents | null;
+        cursors?: Cursors;
     });
     private close;
     /** @internal */

package/dist/modes/greatcircle/great-circle.mode.d.ts

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -14,6 +14,10 @@ type GreateCircleStyling = {
     closingPointOutlineColor: HexColorStyling;
     closingPointOutlineWidth: NumericStyling;
 };
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
 export declare class TerraDrawGreatCircleMode extends TerraDrawBaseDrawMode<GreateCircleStyling> {
     mode: string;
     private currentCoordinate;
@@ -21,12 +25,14 @@ export declare class TerraDrawGreatCircleMode extends TerraDrawBaseDrawMode<Grea
     private closingPointId;
     private keyEvents;
     private snappingEnabled;
+    private cursors;
     private snapping;
     constructor(options?: {
         snapping?: boolean;
         pointerDistance?: number;
         styles?: Partial<GreateCircleStyling>;
         keyEvents?: TerraDrawGreateCircleModeKeyEvents | null;
+        cursors?: Cursors;
     });
     private close;
     /** @internal */

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -14,6 +14,10 @@ type LineStringStyling = {
     closingPointOutlineColor: HexColorStyling;
     closingPointOutlineWidth: NumericStyling;
 };
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
 export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineStringStyling> {
     mode: string;
     private currentCoordinate;
@@ -22,6 +26,7 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     private allowSelfIntersections;
     private keyEvents;
     private snappingEnabled;
+    private cursors;
     private mouseMove;
     private snapping;
     constructor(options?: {
@@ -30,6 +35,7 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
         pointerDistance?: number;
         styles?: Partial<LineStringStyling>;
         keyEvents?: TerraDrawLineStringModeKeyEvents | null;
+        cursors?: Cursors;
     });
     private close;
     /** @internal */

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 type PointModeStyling = {
@@ -7,10 +7,15 @@ type PointModeStyling = {
     pointOutlineColor: HexColorStyling;
     pointOutlineWidth: NumericStyling;
 };
+interface Cursors {
+    create?: Cursor;
+}
 export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeStyling> {
     mode: string;
+    private cursors;
     constructor(options?: {
         styles?: Partial<PointModeStyling>;
+        cursors?: Cursors;
     });
     /** @internal */
     start(): void;

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -16,6 +16,10 @@ type PolygonStyling = {
     closingPointOutlineWidth: NumericStyling;
     closingPointOutlineColor: HexColorStyling;
 };
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
 export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonStyling> {
     mode: string;
     private currentCoordinate;
@@ -26,6 +30,7 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     private snapping;
     private pixelDistance;
     private closingPoints;
+    private cursors;
     private mouseMove;
     constructor(options?: {
         allowSelfIntersections?: boolean;
@@ -33,6 +38,7 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
         pointerDistance?: number;
         styles?: Partial<PolygonStyling>;
         keyEvents?: TerraDrawPolygonModeKeyEvents | null;
+        cursors?: Cursors;
     });
     private close;
     /** @internal */

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawRectangleModeKeyEvents = {
@@ -11,15 +11,20 @@ type RectanglePolygonStyling = {
     outlineWidth: NumericStyling;
     fillOpacity: NumericStyling;
 };
+interface Cursors {
+    start?: Cursor;
+}
 export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<RectanglePolygonStyling> {
     mode: string;
     private center;
     private clickCount;
     private currentRectangleId;
     private keyEvents;
+    private cursors;
     constructor(options?: {
         styles?: Partial<RectanglePolygonStyling>;
         keyEvents?: TerraDrawRectangleModeKeyEvents | null;
+        cursors?: Cursors;
     });
     private updateRectangle;
     private close;

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

@@ -19,6 +19,7 @@ export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderMod
     type: ModeTypes;
     mode: string;
     constructor(options: {
+        modeName: string;
         styles: Partial<RenderModeStyling>;
     });
     /** @internal */

package/dist/modes/select/behaviors/drag-coordinate.behavior.d.ts

@@ -12,7 +12,7 @@ export declare class DragCoordinateBehavior extends TerraDrawModeBehavior {
     private draggedCoordinate;
     private getClosestCoordinate;
     getDraggableIndex(event: TerraDrawMouseEvent, selectedId: string): number;
-    drag(event: TerraDrawMouseEvent): boolean;
+    drag(event: TerraDrawMouseEvent, allowSelfIntersection: boolean): boolean;
     isDragging(): boolean;
     startDragging(id: string, index: number): void;
     stopDragging(): void;

package/dist/modes/select/behaviors/drag-feature.behavior.d.ts

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
-import { FeaturesAtMouseEventBehavior } from "./features-at-mouse-event.behavior";
+import { FeatureAtPointerEventBehavior } from "./feature-at-pointer-event.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
 export declare class DragFeatureBehavior extends TerraDrawModeBehavior {
@@ -8,7 +8,7 @@ export declare class DragFeatureBehavior extends TerraDrawModeBehavior {
     private readonly featuresAtMouseEvent;
     private readonly selectionPoints;
     private readonly midPoints;
-    constructor(config: BehaviorConfig, featuresAtMouseEvent: FeaturesAtMouseEventBehavior, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
+    constructor(config: BehaviorConfig, featuresAtMouseEvent: FeatureAtPointerEventBehavior, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
     private draggedFeatureId;
     private dragPosition;
     startDragging(event: TerraDrawMouseEvent, id: string): void;

package/dist/modes/select/behaviors/feature-at-pointer-event.behavior.d.ts

@@ -0,0 +1,15 @@
+import { TerraDrawMouseEvent } from "../../../common";
+import { GeoJSONStoreFeatures } from "../../../store/store";
+import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
+import { ClickBoundingBoxBehavior } from "../../click-bounding-box.behavior";
+import { PixelDistanceBehavior } from "../../pixel-distance.behavior";
+export declare class FeatureAtPointerEventBehavior extends TerraDrawModeBehavior {
+    readonly config: BehaviorConfig;
+    private readonly createClickBoundingBox;
+    private readonly pixelDistance;
+    constructor(config: BehaviorConfig, createClickBoundingBox: ClickBoundingBoxBehavior, pixelDistance: PixelDistanceBehavior);
+    find(event: TerraDrawMouseEvent, hasSelection: boolean): {
+        clickedFeature: GeoJSONStoreFeatures | undefined;
+        clickedMidPoint: GeoJSONStoreFeatures | undefined;
+    };
+}

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -13,6 +13,7 @@ type ModeFlags = {
         draggable?: boolean;
         rotateable?: boolean;
         scaleable?: boolean;
+        selfIntersectable?: boolean;
         coordinates?: {
             midpoints?: boolean;
             draggable?: boolean;
@@ -40,6 +41,12 @@ type SelectionStyling = {
     midPointWidth: NumericStyling;
     midPointOutlineWidth: NumericStyling;
 };
+interface Cursors {
+    pointerOver?: Cursor;
+    dragStart?: Cursor;
+    dragEnd?: Cursor;
+    insertMidpoint?: Cursor;
+}
 export declare class TerraDrawSelectMode extends TerraDrawBaseDrawMode<SelectionStyling> {
     type: ModeTypes;
     mode: string;
@@ -57,6 +64,7 @@ export declare class TerraDrawSelectMode extends TerraDrawBaseDrawMode<Selection
     private dragCoordinate;
     private rotateFeature;
     private scaleFeature;
+    private cursors;
     constructor(options?: {
         styles?: Partial<SelectionStyling>;
         pointerDistance?: number;
@@ -65,7 +73,9 @@ export declare class TerraDrawSelectMode extends TerraDrawBaseDrawMode<Selection
         };
         keyEvents?: TerraDrawSelectModeKeyEvents | null;
         dragEventThrottle?: number;
+        cursors?: Cursors;
     });
+    setSelecting(): void;
     registerBehaviors(config: BehaviorConfig): void;
     private deselect;
     private deleteSelected;

package/dist/modes/snapping.behavior.d.ts

@@ -8,6 +8,8 @@ export declare class SnappingBehavior extends TerraDrawModeBehavior {
     private readonly pixelDistance;
     private readonly clickBoundingBox;
     constructor(config: BehaviorConfig, pixelDistance: PixelDistanceBehavior, clickBoundingBox: ClickBoundingBoxBehavior);
+    /** Returns the nearest snappable coordinate - on first click there is no currentId so no need to provide */
+    getSnappableCoordinateFirstClick: (event: TerraDrawMouseEvent) => Position | undefined;
     getSnappableCoordinate: (event: TerraDrawMouseEvent, currentFeatureId: string) => Position | undefined;
     private getSnappable;
 }