terra-draw 0.0.1-alpha.5 → 0.0.1-alpha.50

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

@@ -1,30 +1,58 @@
-import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
-import { TerraDrawAdapterStyling, TerraDrawModeRegisterConfig, TerraDrawModeState } from "../common";
-import { GeoJSONStore } from "../store/store";
-export declare abstract class TerraDrawBaseDrawMode {
-    _state: TerraDrawModeState;
-    _styling: TerraDrawAdapterStyling;
-    get state(): TerraDrawModeState;
-    set state(_: TerraDrawModeState);
-    get styling(): TerraDrawAdapterStyling;
-    set styling(styling: TerraDrawAdapterStyling);
-    protected behaviors: TerraDrawModeBehavior[];
-    protected pointerDistance: number;
-    protected coordinatePrecision: number;
-    protected onStyleChange: any;
-    protected store: GeoJSONStore;
-    protected unproject: TerraDrawModeRegisterConfig["unproject"];
-    protected project: TerraDrawModeRegisterConfig["project"];
-    protected setCursor: TerraDrawModeRegisterConfig["setCursor"];
-    protected registerBehaviors(behaviorConfig: BehaviorConfig): void;
-    constructor(options?: {
-        styling?: Partial<TerraDrawAdapterStyling>;
-        pointerDistance?: number;
-        coordinatePrecision?: number;
-    });
-    protected setStarted(): void;
-    protected setStopped(): void;
-    register(config: TerraDrawModeRegisterConfig): void;
-    onDeselect(deselectedId: string): void;
-    onSelect(selectedId: string): void;
-}
+import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
+import { HexColor, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent } from "../common";
+import { GeoJSONStore, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
+type CustomStyling = Record<string, string | number | ((feature: GeoJSONStoreFeatures) => HexColor) | ((feature: GeoJSONStoreFeatures) => number)>;
+export declare enum ModeTypes {
+    Drawing = "drawing",
+    Select = "select",
+    Static = "static",
+    Render = "render"
+}
+export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
+    protected _state: TerraDrawModeState;
+    get state(): TerraDrawModeState;
+    set state(_: TerraDrawModeState);
+    protected _styles: Partial<T>;
+    get styles(): Partial<T>;
+    set styles(styling: Partial<T>);
+    protected behaviors: TerraDrawModeBehavior[];
+    protected pointerDistance: number;
+    protected coordinatePrecision: number;
+    protected onStyleChange: StoreChangeHandler;
+    protected store: GeoJSONStore;
+    protected setDoubleClickToZoom: TerraDrawModeRegisterConfig["setDoubleClickToZoom"];
+    protected unproject: TerraDrawModeRegisterConfig["unproject"];
+    protected project: TerraDrawModeRegisterConfig["project"];
+    protected setCursor: TerraDrawModeRegisterConfig["setCursor"];
+    protected registerBehaviors(behaviorConfig: BehaviorConfig): void;
+    constructor(options?: {
+        styles?: Partial<T>;
+        pointerDistance?: number;
+        coordinatePrecision?: number;
+    });
+    type: ModeTypes;
+    mode: string;
+    protected setDrawing(): void;
+    protected setStarted(): void;
+    protected setStopped(): void;
+    register(config: TerraDrawModeRegisterConfig): void;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    abstract start(): void;
+    abstract stop(): void;
+    abstract cleanUp(): void;
+    abstract styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    onFinish(finishedId: string): void;
+    onDeselect(deselectedId: string): void;
+    onSelect(selectedId: string): void;
+    onKeyDown(event: TerraDrawKeyboardEvent): void;
+    onKeyUp(event: TerraDrawKeyboardEvent): void;
+    onMouseMove(event: TerraDrawMouseEvent): void;
+    onClick(event: TerraDrawMouseEvent): void;
+    onDragStart(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    onDrag(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    onDragEnd(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    protected getHexColorStylingValue(value: HexColor | ((feature: GeoJSONStoreFeatures) => HexColor) | undefined, defaultValue: HexColor, feature: GeoJSONStoreFeatures): HexColor;
+    protected getNumericStylingValue(value: number | ((feature: GeoJSONStoreFeatures) => number) | undefined, defaultValue: number, feature: GeoJSONStoreFeatures): number;
+    private getStylingValue;
+}
+export {};

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

@@ -1,27 +1,54 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent } from "../../common";
-import { TerraDrawBaseDrawMode } from "../base.mode";
-declare type TerraDrawCircleModeKeyEvents = {
-    cancel: KeyboardEvent["key"];
-};
-export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode {
-    mode: string;
-    private center;
-    private clickCount;
-    private currentCircleId;
-    private keyEvents;
-    constructor(options?: {
-        styling?: Partial<TerraDrawAdapterStyling>;
-        keyEvents?: TerraDrawCircleModeKeyEvents;
-    });
-    start(): void;
-    stop(): void;
-    onClick(event: TerraDrawMouseEvent): void;
-    onMouseMove(event: TerraDrawMouseEvent): void;
-    onKeyDown(): void;
-    onKeyUp(event: TerraDrawKeyboardEvent): void;
-    onDragStart(): void;
-    onDrag(): void;
-    onDragEnd(): void;
-    cleanUp(): void;
-}
-export {};
+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 CirclePolygonStyling = {
+    fillColor: HexColorStyling;
+    outlineColor: HexColorStyling;
+    outlineWidth: NumericStyling;
+    fillOpacity: NumericStyling;
+};
+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<CirclePolygonStyling>;
+        keyEvents?: TerraDrawCircleModeKeyEvents | null;
+        cursors?: Cursors;
+    });
+    private close;
+    /** @internal */
+    start(): void;
+    /** @internal */
+    stop(): void;
+    /** @internal */
+    onClick(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onMouseMove(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onKeyDown(): void;
+    /** @internal */
+    onKeyUp(event: TerraDrawKeyboardEvent): void;
+    /** @internal */
+    onDragStart(): void;
+    /** @internal */
+    onDrag(): void;
+    /** @internal */
+    onDragEnd(): void;
+    /** @internal */
+    cleanUp(): void;
+    /** @internal */
+    styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+}
+export {};

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

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

@@ -1,29 +1,63 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent } from "../../common";
-import { TerraDrawBaseDrawMode } from "../base.mode";
-declare type TerraDrawFreehandModeKeyEvents = {
-    cancel: KeyboardEvent["key"];
-};
-export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode {
-    mode: string;
-    private startingClick;
-    private currentId;
-    private skip;
-    private everyNthMouseEvent;
-    private keyEvents;
-    constructor(options?: {
-        styling?: Partial<TerraDrawAdapterStyling>;
-        everyNthMouseEvent?: number;
-        keyEvents?: TerraDrawFreehandModeKeyEvents;
-    });
-    start(): void;
-    stop(): void;
-    onMouseMove(event: TerraDrawMouseEvent): void;
-    onClick(event: TerraDrawMouseEvent): void;
-    onKeyDown(): void;
-    onKeyUp(event: TerraDrawKeyboardEvent): void;
-    onDragStart(): void;
-    onDrag(): void;
-    onDragEnd(): void;
-    cleanUp(): void;
-}
-export {};
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { TerraDrawBaseDrawMode } from "../base.mode";
+import { GeoJSONStoreFeatures } from "../../store/store";
+type TerraDrawFreehandModeKeyEvents = {
+    cancel: KeyboardEvent["key"] | null;
+    finish: KeyboardEvent["key"] | null;
+};
+type FreehandPolygonStyling = {
+    fillColor: HexColorStyling;
+    outlineColor: HexColorStyling;
+    outlineWidth: NumericStyling;
+    fillOpacity: NumericStyling;
+    closingPointColor: HexColorStyling;
+    closingPointWidth: NumericStyling;
+    closingPointOutlineColor: HexColorStyling;
+    closingPointOutlineWidth: NumericStyling;
+};
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
+export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygonStyling> {
+    mode: string;
+    private startingClick;
+    private currentId;
+    private closingPointId;
+    private minDistance;
+    private keyEvents;
+    private cursors;
+    private preventPointsNearClose;
+    constructor(options?: {
+        styles?: Partial<FreehandPolygonStyling>;
+        minDistance?: number;
+        preventPointsNearClose?: boolean;
+        keyEvents?: TerraDrawFreehandModeKeyEvents | null;
+        cursors?: Cursors;
+    });
+    private close;
+    /** @internal */
+    start(): void;
+    /** @internal */
+    stop(): void;
+    /** @internal */
+    onMouseMove(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onClick(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onKeyDown(): void;
+    /** @internal */
+    onKeyUp(event: TerraDrawKeyboardEvent): void;
+    /** @internal */
+    onDragStart(): void;
+    /** @internal */
+    onDrag(): void;
+    /** @internal */
+    onDragEnd(): void;
+    /** @internal */
+    cleanUp(): void;
+    /** @internal */
+    styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+}
+export {};

package/dist/modes/great-circle-snapping.behavior.d.ts

@@ -0,0 +1,13 @@
+import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
+import { TerraDrawMouseEvent } from "../common";
+import { Position } from "geojson";
+import { ClickBoundingBoxBehavior } from "./click-bounding-box.behavior";
+import { PixelDistanceBehavior } from "./pixel-distance.behavior";
+export declare class GreatCircleSnappingBehavior extends TerraDrawModeBehavior {
+    readonly config: BehaviorConfig;
+    private readonly pixelDistance;
+    private readonly clickBoundingBox;
+    constructor(config: BehaviorConfig, pixelDistance: PixelDistanceBehavior, clickBoundingBox: ClickBoundingBoxBehavior);
+    getSnappableCoordinate: (event: TerraDrawMouseEvent, currentFeatureId?: string) => Position | undefined;
+    private getSnappableEnds;
+}

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

@@ -0,0 +1,64 @@
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { TerraDrawBaseDrawMode } from "../base.mode";
+import { BehaviorConfig } from "../base.behavior";
+import { GeoJSONStoreFeatures } from "../../store/store";
+type TerraDrawGreateCircleModeKeyEvents = {
+    cancel: KeyboardEvent["key"] | null;
+    finish: KeyboardEvent["key"] | null;
+};
+type GreateCircleStyling = {
+    lineStringWidth: NumericStyling;
+    lineStringColor: HexColorStyling;
+    closingPointColor: HexColorStyling;
+    closingPointWidth: NumericStyling;
+    closingPointOutlineColor: HexColorStyling;
+    closingPointOutlineWidth: NumericStyling;
+};
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
+export declare class TerraDrawGreatCircleMode extends TerraDrawBaseDrawMode<GreateCircleStyling> {
+    mode: string;
+    private currentCoordinate;
+    private currentId;
+    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 */
+    registerBehaviors(config: BehaviorConfig): void;
+    /** @internal */
+    start(): void;
+    /** @internal */
+    stop(): void;
+    /** @internal */
+    onMouseMove(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onClick(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onKeyDown(): void;
+    /** @internal */
+    onKeyUp(event: TerraDrawKeyboardEvent): void;
+    /** @internal */
+    onDragStart(): void;
+    /** @internal */
+    onDrag(): void;
+    /** @internal */
+    onDragEnd(): void;
+    /** @internal */
+    cleanUp(): void;
+    /** @internal */
+    styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+}
+export {};

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

@@ -1,34 +1,67 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent } from "../../common";
-import { TerraDrawBaseDrawMode } from "../base.mode";
-import { BehaviorConfig } from "../base.behavior";
-declare type TerraDrawLineStringModeKeyEvents = {
-    cancel: KeyboardEvent["key"];
-};
-export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode {
-    mode: string;
-    private currentCoordinate;
-    private currentId;
-    private allowSelfIntersections;
-    private keyEvents;
-    private snappingEnabled;
-    private snapping;
-    constructor(options?: {
-        snapping?: boolean;
-        allowSelfIntersections?: boolean;
-        pointerDistance?: number;
-        styling?: Partial<TerraDrawAdapterStyling>;
-        keyEvents?: TerraDrawLineStringModeKeyEvents;
-    });
-    registerBehaviors(config: BehaviorConfig): void;
-    start(): void;
-    stop(): void;
-    onMouseMove(event: TerraDrawMouseEvent): void;
-    onClick(event: TerraDrawMouseEvent): void;
-    onKeyDown(): void;
-    onKeyUp(event: TerraDrawKeyboardEvent): void;
-    onDragStart(): void;
-    onDrag(): void;
-    onDragEnd(): void;
-    cleanUp(): void;
-}
-export {};
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { TerraDrawBaseDrawMode } from "../base.mode";
+import { BehaviorConfig } from "../base.behavior";
+import { GeoJSONStoreFeatures } from "../../store/store";
+type TerraDrawLineStringModeKeyEvents = {
+    cancel: KeyboardEvent["key"] | null;
+    finish: KeyboardEvent["key"] | null;
+};
+type LineStringStyling = {
+    lineStringWidth: NumericStyling;
+    lineStringColor: HexColorStyling;
+    closingPointColor: HexColorStyling;
+    closingPointWidth: NumericStyling;
+    closingPointOutlineColor: HexColorStyling;
+    closingPointOutlineWidth: NumericStyling;
+};
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
+export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineStringStyling> {
+    mode: string;
+    private currentCoordinate;
+    private currentId;
+    private closingPointId;
+    private allowSelfIntersections;
+    private keyEvents;
+    private snappingEnabled;
+    private cursors;
+    private mouseMove;
+    private snapping;
+    constructor(options?: {
+        snapping?: boolean;
+        allowSelfIntersections?: boolean;
+        pointerDistance?: number;
+        styles?: Partial<LineStringStyling>;
+        keyEvents?: TerraDrawLineStringModeKeyEvents | null;
+        cursors?: Cursors;
+    });
+    private close;
+    /** @internal */
+    registerBehaviors(config: BehaviorConfig): void;
+    /** @internal */
+    start(): void;
+    /** @internal */
+    stop(): void;
+    /** @internal */
+    onMouseMove(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onClick(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onKeyDown(): void;
+    /** @internal */
+    onKeyUp(event: TerraDrawKeyboardEvent): void;
+    /** @internal */
+    onDragStart(): void;
+    /** @internal */
+    onDrag(): void;
+    /** @internal */
+    onDragEnd(): void;
+    /** @internal */
+    cleanUp(): void;
+    /** @internal */
+    styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+}
+export {};

package/dist/modes/pixel-distance.behavior.d.ts

@@ -1,7 +1,7 @@
-import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
-import { TerraDrawMouseEvent } from "../common";
-import { Position } from "geojson";
-export declare class PixelDistanceBehavior extends TerraDrawModeBehavior {
-    constructor(config: BehaviorConfig);
-    measure(clickEvent: TerraDrawMouseEvent, secondCoordinate: Position): number;
-}
+import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
+import { TerraDrawMouseEvent } from "../common";
+import { Position } from "geojson";
+export declare class PixelDistanceBehavior extends TerraDrawModeBehavior {
+    constructor(config: BehaviorConfig);
+    measure(clickEvent: TerraDrawMouseEvent, secondCoordinate: Position): number;
+}

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

@@ -1,18 +1,44 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling } from "../../common";
-import { TerraDrawBaseDrawMode } from "../base.mode";
-export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode {
-    mode: string;
-    constructor(options?: {
-        styling?: Partial<TerraDrawAdapterStyling>;
-    });
-    start(): void;
-    stop(): void;
-    onClick(event: TerraDrawMouseEvent): void;
-    onMouseMove(): void;
-    onKeyDown(): void;
-    onKeyUp(): void;
-    cleanUp(): void;
-    onDragStart(): void;
-    onDrag(): void;
-    onDragEnd(): void;
-}
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling, Cursor } from "../../common";
+import { GeoJSONStoreFeatures } from "../../store/store";
+import { TerraDrawBaseDrawMode } from "../base.mode";
+type PointModeStyling = {
+    pointWidth: NumericStyling;
+    pointColor: HexColorStyling;
+    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;
+    /** @internal */
+    stop(): void;
+    /** @internal */
+    onClick(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onMouseMove(): void;
+    /** @internal */
+    onKeyDown(): void;
+    /** @internal */
+    onKeyUp(): void;
+    /** @internal */
+    cleanUp(): void;
+    /** @internal */
+    onDragStart(): void;
+    /** @internal */
+    onDrag(): void;
+    /** @internal */
+    onDragEnd(): void;
+    /** @internal */
+    styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+}
+export {};

package/dist/modes/polygon/behaviors/closing-points.behavior.d.ts

@@ -0,0 +1,19 @@
+import { Position } from "geojson";
+import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
+import { TerraDrawMouseEvent } from "../../../common";
+import { PixelDistanceBehavior } from "../../pixel-distance.behavior";
+export declare class ClosingPointsBehavior extends TerraDrawModeBehavior {
+    readonly config: BehaviorConfig;
+    private readonly pixelDistance;
+    constructor(config: BehaviorConfig, pixelDistance: PixelDistanceBehavior);
+    private _startEndPoints;
+    get ids(): string[];
+    set ids(_: string[]);
+    create(selectedCoords: Position[], mode: string): void;
+    delete(): void;
+    update(updatedCoordinates: Position[]): void;
+    isClosingPoint(event: TerraDrawMouseEvent): {
+        isClosing: boolean;
+        isPreviousClosing: boolean;
+    };
+}