terra-draw 1.0.0 → 1.2.0

package/dist/terra-draw.d.ts

@@ -21,6 +21,7 @@ import { TerraDrawSectorMode } from "./modes/sector/sector.mode";
 import { TerraDrawSensorMode } from "./modes/sensor/sensor.mode";
 import * as TerraDrawExtend from "./extend";
 import { ValidationReasons } from "./validation-reasons";
+type InstanceType<T extends new (...args: any[]) => any> = T extends new (...args: any[]) => infer R ? R : never;
 type FinishListener = (id: FeatureId, context: OnFinishContext) => void;
 type ChangeListener = (ids: FeatureId[], type: string) => void;
 type SelectListener = (id: FeatureId) => void;
@@ -52,28 +53,41 @@ declare class TerraDraw {
     private featuresAtLocation;
     private getSelectMode;
     /**
+     * @deprecated This method is scheduled for removal in the next major version. Instead use the 'updateModeOptions' method passing the
+     * styles property in the options object, and this will dynamically update the styles for the mode.
+     *
      * Allows the setting of a style for a given mode
      *
      * @param mode - The mode you wish to set a style for
      * @param styles - The styles you wish to set for the mode - this is
      * the same as the initialisation style schema
-     *
-     * @beta
      */
     setModeStyles<Styling extends Record<string, number | HexColor>>(mode: string, styles: Styling): void;
+    /**
+     * Allow updating of the current options passed to the mode dynamically
+     * after the mode has been started. You can also use this method to update styles
+     * as these are passed from the options object.
+     * @param mode - the mode name you wish to update (the mode name is the public 'mode' property of the mode class)
+     * @param options - the options object - this allows _partial_ updating of the modes options (i.e. you do not need to pass the whole options object)
+     */
+    updateModeOptions<Mode extends {
+        new (...args: any[]): any;
+    }>(mode: InstanceType<Mode>["mode"], options: ConstructorParameters<Mode>[0]): void;
     /**
      * Allows the user to get a snapshot (copy) of all given features
      *
      * @returns An array of all given Feature Geometries in the instances store
-     *
-     * @beta
      */
     getSnapshot(): GeoJSONStoreFeatures[];
+    /**
+     * Allows the user to get a snapshot (copy) of a given feature by id
+     *
+     * @returns A copy of the feature geometry in the instances store
+     */
+    getSnapshotFeature(id: FeatureId): GeoJSONStoreFeatures | undefined;
     /**
      * Removes all data from the current store and removes any rendered layers
      * via the registering the adapter.
-     *
-     * @beta
      */
     clear(): void;
     /**
@@ -83,37 +97,27 @@ declare class TerraDraw {
      *
      * @return true or false depending on if the instance is stopped or started
      * @readonly
-     * @beta
      */
     get enabled(): boolean;
     /**
      * enabled is a read only property and will throw and error if you try and set it.
-     *
-     * @beta
      */
     set enabled(_: boolean);
     /**
      * A method for getting the current mode name
-     *
      * @return the current mode name
-     *
-     * @beta
      */
     getMode(): string;
     /**
      * A method for setting the current mode by name. Under the hood this will stop
      * the previous mode and start the new one.
      * @param mode - The mode name you wish to start
-     *
-     * @beta
      */
     setMode(mode: string): void;
     /**
      * A method for removing features to the store
      * @param ids
      * @returns
-     *
-     * @beta
      */
     removeFeatures(ids: FeatureId[]): void;
     /**
@@ -121,7 +125,6 @@ declare class TerraDraw {
      * If not select mode is provided in the instance, an error will be thrown. If the instance is not currently
      * in the select mode, it will switch to it.
      * @param id - the id of the feature to select
-     * @beta
      */
     selectFeature(id: FeatureId): void;
     /**
@@ -129,7 +132,6 @@ declare class TerraDraw {
      * If not select mode is provided in the instance, an error will be thrown. If the instance is not currently
      * in the select mode, it will switch to it.
      * @param id  - the id of the feature to deselect
-     * @beta
      */
     deselectFeature(id: FeatureId): void;
     /**
@@ -138,14 +140,11 @@ declare class TerraDraw {
      * outside of the Terra Draw instance but want to add them in to the store.
      * @returns a id, either number of string based on whatever the configured idStrategy is
      *
-     * @beta
      */
     getFeatureId(): FeatureId;
     /**
      * Returns true or false depending on if the Terra Draw instance has a feature with a given id
      * @returns a boolean determining if the instance has a feature with the given id
-     *
-     * @beta
      */
     hasFeature(id: FeatureId): boolean;
     /**
@@ -154,23 +153,17 @@ declare class TerraDraw {
      * in the instance.
      * @param features - an array of GeoJSON features
      * @returns an array of validation results
-     *
-     * @beta
      */
     addFeatures(features: GeoJSONStoreFeatures[]): StoreValidation[];
     /**
      * A method starting Terra Draw. It put the instance into a started state, and
      * in registers the passed adapter giving it all the callbacks required to operate.
-     *
-     * @beta
      */
     start(): void;
     /**
      * Gets the features at a given longitude and latitude.
      * Will return point and linestrings that are a given pixel distance
      * away from the lng/lat and any polygons which contain it.
-     *
-     * @beta
      */
     getFeaturesAtLngLat(lngLat: {
         lng: number;
@@ -180,21 +173,16 @@ declare class TerraDraw {
         ignoreSelectFeatures: boolean;
     }): GeoJSONStoreFeatures[];
     /**
-     * Takes a given pointer event and
-     * Will return point and linestrings that are a given pixel distance
-     * away from the lng/lat and any polygons which contain it.
-     *
-     * @beta
+     * Takes a given pointer event and will return point and linestrings that are
+     * a given pixel distance away from the longitude/latitude, and any polygons which contain it.
      */
     getFeaturesAtPointerEvent(event: PointerEvent | MouseEvent, options?: {
-        pointerDistance: number;
-        ignoreSelectFeatures: boolean;
+        pointerDistance?: number;
+        ignoreSelectFeatures?: boolean;
     }): GeoJSONStoreFeatures[];
     /**
      * A method for stopping Terra Draw. Will clear the store, deregister the adapter and
      * remove any rendered layers in the process.
-     *
-     * @beta
      */
     stop(): void;
     /**
@@ -203,7 +191,6 @@ declare class TerraDraw {
      * @param event - The name of the event you wish to listen for
      * @param callback - The callback with you wish to be called when this event occurs
      *
-     * @beta
      */
     on<T extends TerraDrawEvents>(event: T, callback: TerraDrawEventListeners[T]): void;
     /**
@@ -212,9 +199,7 @@ declare class TerraDraw {
      * @param event - The name of the event you wish to unregister
      * @param callback - The callback you originally provided to the 'on' method
      *
-     * @beta
      */
     off<T extends TerraDrawEvents>(event: TerraDrawEvents, callback: TerraDrawEventListeners[T]): void;
 }
-declare const HELLO = "HELLO";
-export { TerraDraw, HELLO, TerraDrawSelectMode, TerraDrawPointMode, TerraDrawLineStringMode, TerraDrawPolygonMode, TerraDrawCircleMode, TerraDrawFreehandMode, TerraDrawRenderMode, TerraDrawRectangleMode, TerraDrawAngledRectangleMode, TerraDrawSectorMode, TerraDrawSensorMode, TerraDrawExtend, BehaviorConfig, GeoJSONStoreFeatures, GeoJSONStoreGeometries, HexColor, TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawChanges, TerraDrawStylingFunction, Project, Unproject, SetCursor, GetLngLatFromEvent, ValidateMinAreaSquareMeters, ValidateMaxAreaSquareMeters, ValidateNotSelfIntersecting, ValidationReasons, };
+export { TerraDraw, TerraDrawSelectMode, TerraDrawPointMode, TerraDrawLineStringMode, TerraDrawPolygonMode, TerraDrawCircleMode, TerraDrawFreehandMode, TerraDrawRenderMode, TerraDrawRectangleMode, TerraDrawAngledRectangleMode, TerraDrawSectorMode, TerraDrawSensorMode, TerraDrawExtend, BehaviorConfig, GeoJSONStoreFeatures, GeoJSONStoreGeometries, HexColor, TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawChanges, TerraDrawStylingFunction, Project, Unproject, SetCursor, GetLngLatFromEvent, ValidateMinAreaSquareMeters, ValidateMaxAreaSquareMeters, ValidateNotSelfIntersecting, ValidationReasons, };