terra-draw 0.0.1-alpha.69 → 0.0.1-alpha.70

package/dist/terra-draw.d.ts

@@ -57,7 +57,7 @@ declare class TerraDraw {
      * @param styles - The styles you wish to set for the mode - this is
      * the same as the initialisation style schema
      *
-     * @alpha
+     * @beta
      */
     setModeStyles<Styling extends Record<string, number | HexColor>>(mode: string, styles: Styling): void;
     /**
@@ -65,14 +65,14 @@ declare class TerraDraw {
      *
      * @returns An array of all given Feature Geometries in the instances store
      *
-     * @alpha
+     * @beta
      */
     getSnapshot(): GeoJSONStoreFeatures[];
     /**
      * Removes all data from the current store and removes any rendered layers
      * via the registering the adapter.
      *
-     * @alpha
+     * @beta
      */
     clear(): void;
     /**
@@ -82,13 +82,13 @@ declare class TerraDraw {
      *
      * @return true or false depending on if the instance is stopped or started
      * @readonly
-     * @alpha
+     * @beta
      */
     get enabled(): boolean;
     /**
      * enabled is a read only property and will throw and error if you try and set it.
      *
-     * @alpha
+     * @beta
      */
     set enabled(_: boolean);
     /**
@@ -96,7 +96,7 @@ declare class TerraDraw {
      *
      * @return the current mode name
      *
-     * @alpha
+     * @beta
      */
     getMode(): string;
     /**
@@ -104,7 +104,7 @@ declare class TerraDraw {
      * the previous mode and start the new one.
      * @param mode - The mode name you wish to start
      *
-     * @alpha
+     * @beta
      */
     setMode(mode: string): void;
     /**
@@ -112,7 +112,7 @@ declare class TerraDraw {
      * @param ids
      * @returns
      *
-     * @alpha
+     * @beta
      */
     removeFeatures(ids: FeatureId[]): void;
     /**
@@ -120,7 +120,7 @@ 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
-     * @alpha
+     * @beta
      */
     selectFeature(id: FeatureId): void;
     /**
@@ -128,7 +128,7 @@ 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
-     * @alpha
+     * @beta
      */
     deselectFeature(id: FeatureId): void;
     /**
@@ -137,14 +137,14 @@ 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
      *
-     * @alpha
+     * @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
      *
-     * @alpha
+     * @beta
      */
     hasFeature(id: FeatureId): boolean;
     /**
@@ -154,14 +154,14 @@ declare class TerraDraw {
      * @param features
      * @returns
      *
-     * @alpha
+     * @beta
      */
     addFeatures(features: GeoJSONStoreFeatures[]): void;
     /**
      * 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.
      *
-     * @alpha
+     * @beta
      */
     start(): void;
     /**
@@ -169,7 +169,7 @@ declare class TerraDraw {
      * Will return point and linestrings that are a given pixel distance
      * away from the lng/lat and any polygons which contain it.
      *
-     * @alpha
+     * @beta
      */
     getFeaturesAtLngLat(lngLat: {
         lng: number;
@@ -183,7 +183,7 @@ declare class TerraDraw {
      * Will return point and linestrings that are a given pixel distance
      * away from the lng/lat and any polygons which contain it.
      *
-     * @alpha
+     * @beta
      */
     getFeaturesAtPointerEvent(event: PointerEvent | MouseEvent, options?: {
         pointerDistance: number;
@@ -193,7 +193,7 @@ declare class TerraDraw {
      * A method for stopping Terra Draw. Will clear the store, deregister the adapter and
      * remove any rendered layers in the process.
      *
-     * @alpha
+     * @beta
      */
     stop(): void;
     /**
@@ -202,7 +202,7 @@ 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
      *
-     * @alpha
+     * @beta
      */
     on<T extends TerraDrawEvents>(event: T, callback: TerraDrawEventListeners[T]): void;
     /**
@@ -211,7 +211,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
      *
-     * @alpha
+     * @beta
      */
     off<T extends TerraDrawEvents>(event: TerraDrawEvents, callback: TerraDrawEventListeners[T]): void;
 }