terra-draw 1.1.0 → 1.3.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,6 +53,9 @@ 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
@@ -59,12 +63,28 @@ declare class TerraDraw {
      * the same as the initialisation style schema
      */
     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
      */
     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.