azure-maps-control 2.3.5 → 2.3.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "azure-maps-control",
   "author": "Microsoft Corporation",
-  "version": "2.3.5",
+  "version": "2.3.6",
   "description": "Map SDK for Azure Maps",
   "keywords": [
     "azure",

package/typings/index.d.ts

@@ -673,6 +673,38 @@ declare namespace atlas {
             private constructPitchIncrementButton;
         }
 
+        /**
+         * A control to display a scale bar on the map.
+         */
+        export class ScaleControl extends ControlBase {
+            private map: Map | null;
+            private control;
+
+            /**
+            * Constructs a ScaleControl.
+            * @param options The options for the control.
+            */
+            constructor(options?: ScaleControlOptions);
+            /**
+             * Initialization method for the control which is called when added to the map.
+             * @param map The map that the control will be added to.
+             * @param options The ControlOptions for this control.
+             * @return An HTMLElement to be placed on the map for the control.
+             */
+            onAdd(map: Map, options?: ControlOptions): HTMLElement;
+            /**
+             * Method that is called when the control is removed from the map. Should perform any necessary cleanup for the
+             * control.
+             */
+            onRemove(): void;
+
+            /**
+             * Set the scale's unit of the distance
+             * @param unit - Unit of the distance (`'imperial'`, `'metric'` or `'nautical'`).
+             */
+            setUnit(unit: "imperial" | "metric" | "nautical"): void;
+        }
+
         /**
          * A control for changing the style of the map.
          */
@@ -3706,6 +3738,24 @@ declare namespace atlas {
         inverted?: boolean;
     }
 
+    /**
+     * The options for a ScaleControl object.
+     */
+    export interface ScaleControlOptions extends Options {
+        /**
+         * The maximum length of the scale control in pixels.
+         * Default `100`.
+         * @default 100
+         */
+        maxWidth?: number;
+        /**
+         * Unit of the distance (`'imperial'`, `'metric'` or `'nautical'`).
+         * Default `'metric'`.
+         * @default 'metric'
+         */
+        unit?: "imperial" | "metric" | "nautical";
+    }
+
     /**
      * The options for a StyleControl object.
      */
@@ -5459,6 +5509,29 @@ declare namespace atlas {
          * @param sourceLayer the layer where shapes and features are matched
          */
         getRenderedShapes(source: string | atlas.source.Source, filter?: Expression, sourceLayer?: string): Array<atlas.data.Feature<atlas.data.Geometry, any> | Shape>;
+        /**
+         * Gets the state of a feature
+         * @param feature the ID of the feature
+         * @param source the ID of the source
+         * @param sourceLayer the ID of the layer
+         */
+        getFeatureState(feature: string | Shape | atlas.data.Feature<atlas.data.Geometry, any>, source: string | atlas.source.Source, sourceLayer?: string): object;
+        /**
+         * Removes the state or a single key value of the state of a feature.
+         * @param feature the ID of the feature
+         * @param source the ID of the source
+         * @param sourceLayer the ID of the layer
+         * @param key the key in the feature state to update
+         */
+        removeFeatureState(feature: string | Shape | atlas.data.Feature<atlas.data.Geometry, any>, source: string | atlas.source.Source, sourceLayer?: string, key?: string): void;
+        /**
+         * Sets the state of the feature by passing in a key value pair object.
+         * @param feature the ID of the feature
+         * @param source the ID of the source
+         * @param sourceLayer the ID of the layer
+         * @param key the key in the feature state to update
+         */
+        setFeatureState(feature: string | Shape | atlas.data.Feature<atlas.data.Geometry, any>, source: string | atlas.source.Source, state: object, sourceLayer?: string): void;
         /**
          * Removes all sources from the map.
          */