terra-draw 1.18.0 → 1.19.0

package/dist/common.d.ts

@@ -129,6 +129,7 @@ export interface TerraDrawAdapter {
     clear(): void;
     getCoordinatePrecision(): number;
 }
+export declare const MARKER_URL_DEFAULT = "https://raw.githubusercontent.com/JamesLMilner/terra-draw/refs/heads/main/assets/markers/marker-blue.png";
 export declare const SELECT_PROPERTIES: {
     readonly SELECTED: "selected";
     readonly MID_POINT: "midPoint";
@@ -146,6 +147,7 @@ export declare const COMMON_PROPERTIES: {
     readonly COORDINATE_POINT_IDS: "coordinatePointIds";
     readonly PROVISIONAL_COORDINATE_COUNT: "provisionalCoordinateCount";
     readonly COMMITTED_COORDINATE_COUNT: "committedCoordinateCount";
+    readonly MARKER: "marker";
 };
 /**
  * Lower z-index represents layers that are lower in the stack

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
+import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling, ModeUpdateOptions } from "../base.mode";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawPolygonModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
@@ -15,20 +15,20 @@ interface Cursors {
     start?: Cursor;
     close?: Cursor;
 }
-interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+interface TerraDrawAngledRectangleModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     pointerDistance?: number;
     keyEvents?: TerraDrawPolygonModeKeyEvents | null;
     cursors?: Cursors;
 }
 export declare class TerraDrawAngledRectangleMode extends TerraDrawBaseDrawMode<PolygonStyling> {
-    mode: "angled-rectangle";
+    mode: string;
     private currentCoordinate;
     private currentId;
     private keyEvents;
     private cursors;
     private mouseMove;
-    constructor(options?: TerraDrawPolygonModeOptions<PolygonStyling>);
-    updateOptions(options?: TerraDrawPolygonModeOptions<PolygonStyling>): void;
+    constructor(options?: TerraDrawAngledRectangleModeOptions<PolygonStyling>);
+    updateOptions(options?: ModeUpdateOptions<TerraDrawAngledRectangleModeOptions<PolygonStyling>>): void;
     private close;
     /** @internal */
     start(): void;

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

@@ -17,6 +17,7 @@ export declare const DefaultPointerEvents: {
     readonly onDragEnd: true;
 };
 type AllowPointerEvent = boolean | ((event: TerraDrawMouseEvent) => boolean);
+export type ModeUpdateOptions<Mode> = Omit<Mode, "modeName">;
 export interface PointerEvents {
     leftClick: AllowPointerEvent;
     rightClick: AllowPointerEvent;
@@ -26,6 +27,7 @@ export interface PointerEvents {
     onDragEnd: AllowPointerEvent;
 }
 export type BaseModeOptions<Styling extends CustomStyling> = {
+    modeName?: string;
     styles?: Partial<Styling>;
     pointerDistance?: number;
     validation?: Validation;
@@ -52,6 +54,7 @@ export declare abstract class TerraDrawBaseDrawMode<Styling extends CustomStylin
     protected project: TerraDrawModeRegisterConfig["project"];
     protected setCursor: TerraDrawModeRegisterConfig["setCursor"];
     protected registerBehaviors(behaviorConfig: BehaviorConfig): void;
+    private isInitialUpdate;
     constructor(options?: BaseModeOptions<Styling>, willCallUpdateOptionsInParentClass?: boolean);
     updateOptions(options?: BaseModeOptions<Styling>): void;
     protected allowPointerEvent(pointerEvent: AllowPointerEvent, event: TerraDrawMouseEvent): boolean;

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Projection } from "../../common";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
-import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeUpdateOptions, TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawCircleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
@@ -21,7 +21,7 @@ interface TerraDrawCircleModeOptions<T extends CustomStyling> extends BaseModeOp
     projection?: Projection;
 }
 export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePolygonStyling> {
-    mode: "circle";
+    mode: string;
     private center;
     private clickCount;
     private currentCircleId;
@@ -38,7 +38,7 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
      * @param options.pointerDistance - Distance in pixels to consider a pointer close to a vertex
      */
     constructor(options?: TerraDrawCircleModeOptions<CirclePolygonStyling>);
-    updateOptions(options?: TerraDrawCircleModeOptions<CirclePolygonStyling>): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawCircleModeOptions<CirclePolygonStyling>>): void;
     private close;
     /** @internal */
     start(): void;

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeUpdateOptions, TerraDrawBaseDrawMode } from "../base.mode";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawFreehandModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
@@ -28,7 +28,7 @@ interface TerraDrawFreehandModeOptions<T extends CustomStyling> extends BaseMode
     cursors?: Cursors;
 }
 export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygonStyling> {
-    mode: "freehand";
+    mode: string;
     private startingClick;
     private currentId;
     private closingPointId;
@@ -41,7 +41,7 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     private hasLeftStartingPoint;
     private preventNewFeature;
     constructor(options?: TerraDrawFreehandModeOptions<FreehandPolygonStyling>);
-    updateOptions(options?: TerraDrawFreehandModeOptions<FreehandPolygonStyling> | undefined): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawFreehandModeOptions<FreehandPolygonStyling>>): void;
     private close;
     /** @internal */
     start(): void;

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeUpdateOptions, TerraDrawBaseDrawMode } from "../base.mode";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawFreehandLineStringModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
@@ -23,7 +23,7 @@ interface TerraDrawFreehandLineStringModeOptions<T extends CustomStyling> extend
     cursors?: Cursors;
 }
 export declare class TerraDrawFreehandLineStringMode extends TerraDrawBaseDrawMode<FreehandLineStringStyling> {
-    mode: "freehand-linestring";
+    mode: string;
     private startingClick;
     private currentId;
     private closingPointId;
@@ -32,7 +32,7 @@ export declare class TerraDrawFreehandLineStringMode extends TerraDrawBaseDrawMo
     private cursors;
     private preventNewFeature;
     constructor(options?: TerraDrawFreehandLineStringModeOptions<FreehandLineStringStyling>);
-    updateOptions(options?: TerraDrawFreehandLineStringModeOptions<FreehandLineStringStyling> | undefined): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawFreehandLineStringModeOptions<FreehandLineStringStyling>>): void;
     private close;
     /** @internal */
     start(): void;

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Snapping } from "../../common";
-import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeUpdateOptions, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawLineStringModeKeyEvents = {
@@ -37,7 +37,7 @@ interface TerraDrawLineStringModeOptions<T extends CustomStyling> extends BaseMo
     editable?: boolean;
 }
 export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineStringStyling> {
-    mode: "linestring";
+    mode: string;
     private currentCoordinate;
     private currentId;
     private closingPointId;
@@ -61,7 +61,7 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     private pixelDistance;
     private clickBoundingBox;
     constructor(options?: TerraDrawLineStringModeOptions<LineStringStyling>);
-    updateOptions(options?: TerraDrawLineStringModeOptions<LineStringStyling> | undefined): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawLineStringModeOptions<LineStringStyling>>): void;
     private updateSnappedCoordinate;
     private close;
     private updateGeometries;

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

@@ -1,8 +1,9 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, Cursor, UrlStyling } from "../../common";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
-import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeUpdateOptions, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 type MarkerModeStyling = {
+    /** Marker must be a PNG or JPG  */
     markerUrl: UrlStyling;
     markerHeight: NumericStyling;
     markerWidth: NumericStyling;
@@ -27,7 +28,7 @@ export declare class TerraDrawMarkerMode extends TerraDrawBaseDrawMode<MarkerMod
     private pixelDistance;
     private clickBoundingBox;
     constructor(options?: TerraDrawMarkerModeOptions<MarkerModeStyling>);
-    updateOptions(options?: TerraDrawMarkerModeOptions<MarkerModeStyling> | undefined): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawMarkerModeOptions<MarkerModeStyling>>): void;
     /** @internal */
     start(): void;
     /** @internal */

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
-import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeUpdateOptions, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 type PointModeStyling = {
     pointWidth: NumericStyling;
@@ -22,14 +22,14 @@ interface TerraDrawPointModeOptions<T extends CustomStyling> extends BaseModeOpt
     editable?: boolean;
 }
 export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeStyling> {
-    mode: "point";
+    mode: string;
     private cursors;
     private editable;
     private editedFeatureId;
     private pixelDistance;
     private clickBoundingBox;
     constructor(options?: TerraDrawPointModeOptions<PointModeStyling>);
-    updateOptions(options?: TerraDrawPointModeOptions<PointModeStyling> | undefined): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawPointModeOptions<PointModeStyling>>): void;
     /** @internal */
     start(): void;
     /** @internal */

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Snapping } from "../../common";
-import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling, PointerEvents } from "../base.mode";
+import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling, PointerEvents, ModeUpdateOptions } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawPolygonModeKeyEvents = {
@@ -44,7 +44,7 @@ interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeO
     showCoordinatePoints?: boolean;
 }
 export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonStyling> {
-    mode: "polygon";
+    mode: string;
     private currentCoordinate;
     private currentId;
     private keyEvents;
@@ -67,7 +67,7 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     private closingPoints;
     private clickBoundingBox;
     constructor(options?: TerraDrawPolygonModeOptions<PolygonStyling>);
-    updateOptions(options?: TerraDrawPolygonModeOptions<PolygonStyling>): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawPolygonModeOptions<PolygonStyling>>): void;
     private close;
     /** @internal */
     registerBehaviors(config: BehaviorConfig): void;

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
-import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeUpdateOptions, TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawRectangleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
@@ -19,14 +19,14 @@ interface TerraDrawRectangleModeOptions<T extends CustomStyling> extends BaseMod
     cursors?: Cursors;
 }
 export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<RectanglePolygonStyling> {
-    mode: "rectangle";
+    mode: string;
     private center;
     private clickCount;
     private currentRectangleId;
     private keyEvents;
     private cursors;
     constructor(options?: TerraDrawRectangleModeOptions<RectanglePolygonStyling>);
-    updateOptions(options?: TerraDrawRectangleModeOptions<RectanglePolygonStyling>): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawRectangleModeOptions<RectanglePolygonStyling>>): void;
     private updateRectangle;
     private close;
     /** @internal */

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

@@ -1,5 +1,5 @@
 import { HexColorStyling, NumericStyling, TerraDrawAdapterStyling } from "../../common";
-import { BaseModeOptions, CustomStyling, ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeTypes, ModeUpdateOptions, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../terra-draw";
 import { StoreValidation } from "../../store/store";
@@ -17,14 +17,13 @@ type RenderModeStyling = {
     zIndex: NumericStyling;
 };
 interface TerraDrawRenderModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
-    modeName?: string;
     styles: Partial<T>;
 }
 export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderModeStyling> {
     type: ModeTypes;
     mode: string;
     constructor(options: TerraDrawRenderModeOptions<RenderModeStyling>);
-    updateOptions(options?: TerraDrawRenderModeOptions<RenderModeStyling> | undefined): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawRenderModeOptions<RenderModeStyling>>): void;
     /** @internal */
     registerBehaviors(behaviorConfig: BehaviorConfig): void;
     /** @internal */

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
+import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling, ModeUpdateOptions } from "../base.mode";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawSectorModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
@@ -22,7 +22,7 @@ interface TerraDrawSectorModeOptions<T extends CustomStyling> extends BaseModeOp
     cursors?: Cursors;
 }
 export declare class TerraDrawSectorMode extends TerraDrawBaseDrawMode<SectorPolygonStyling> {
-    mode: "sector";
+    mode: string;
     private currentCoordinate;
     private currentId;
     private keyEvents;
@@ -31,7 +31,7 @@ export declare class TerraDrawSectorMode extends TerraDrawBaseDrawMode<SectorPol
     private cursors;
     private mouseMove;
     constructor(options?: TerraDrawSectorModeOptions<SectorPolygonStyling>);
-    updateOptions(options?: TerraDrawSectorModeOptions<SectorPolygonStyling>): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawSectorModeOptions<SectorPolygonStyling>>): void;
     private close;
     /** @internal */
     start(): void;

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

@@ -1,5 +1,5 @@
-import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling, Cursor, Validation, Snapping } from "../../common";
-import { BaseModeOptions, CustomStyling, TerraDrawBaseSelectMode } from "../base.mode";
+import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling, Cursor, Validation, Snapping, UrlStyling } from "../../common";
+import { BaseModeOptions, CustomStyling, ModeUpdateOptions, TerraDrawBaseSelectMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { FeatureId, GeoJSONStoreFeatures } from "../../store/store";
 import { ResizeOptions } from "./behaviors/drag-coordinate-resize.behavior";
@@ -32,6 +32,9 @@ type SelectionStyling = {
     selectedPointWidth: NumericStyling;
     selectedPointOutlineColor: HexColorStyling;
     selectedPointOutlineWidth: NumericStyling;
+    selectedMarkerUrl: UrlStyling;
+    selectedMarkerHeight: NumericStyling;
+    selectedMarkerWidth: NumericStyling;
     selectedLineStringColor: HexColorStyling;
     selectedLineStringWidth: NumericStyling;
     selectedPolygonColor: HexColorStyling;
@@ -64,7 +67,7 @@ interface TerraDrawSelectModeOptions<T extends CustomStyling> extends BaseModeOp
     allowManualDeselection?: boolean;
 }
 export declare class TerraDrawSelectMode extends TerraDrawBaseSelectMode<SelectionStyling> {
-    mode: "select";
+    mode: string;
     private allowManualDeselection;
     private dragEventThrottle;
     private dragEventCount;
@@ -87,7 +90,7 @@ export declare class TerraDrawSelectMode extends TerraDrawBaseSelectMode<Selecti
     private coordinatePoints;
     private lineSnap;
     constructor(options?: TerraDrawSelectModeOptions<SelectionStyling>);
-    updateOptions(options?: TerraDrawSelectModeOptions<SelectionStyling>): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawSelectModeOptions<SelectionStyling>>): void;
     selectFeature(featureId: FeatureId): void;
     setSelecting(): void;
     registerBehaviors(config: BehaviorConfig): void;

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
+import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling, ModeUpdateOptions } from "../base.mode";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawSensorModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
@@ -26,7 +26,7 @@ interface TerraDrawSensorModeOptions<T extends CustomStyling> extends BaseModeOp
     cursors?: Cursors;
 }
 export declare class TerraDrawSensorMode extends TerraDrawBaseDrawMode<SensorPolygonStyling> {
-    mode: "sensor";
+    mode: string;
     private currentCoordinate;
     private currentId;
     private currentInitialArcId;
@@ -37,7 +37,7 @@ export declare class TerraDrawSensorMode extends TerraDrawBaseDrawMode<SensorPol
     private cursors;
     private mouseMove;
     constructor(options?: TerraDrawSensorModeOptions<SensorPolygonStyling>);
-    updateOptions(options?: TerraDrawSensorModeOptions<SensorPolygonStyling>): void;
+    updateOptions(options?: ModeUpdateOptions<TerraDrawSensorModeOptions<SensorPolygonStyling>>): void;
     private close;
     /** @internal */
     start(): void;