azure-maps-control 3.0.2 → 3.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "azure-maps-control",
   "author": "Microsoft Corporation",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Map SDK for Azure Maps",
   "keywords": [
     "azure",
@@ -40,31 +40,31 @@
   },
   "devDependencies": {
     "@mapbox/mapbox-gl-rtl-text": "^0.2.3",
-    "@microsoft/applicationinsights-web": "^3.0.0",
-    "@playwright/test": "^1.36.2",
-    "@rollup/plugin-commonjs": "^25.0.3",
+    "@microsoft/applicationinsights-web": "^3.0.2",
+    "@playwright/test": "^1.40.0",
+    "@rollup/plugin-commonjs": "^25.0.4",
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.1.0",
-    "@testing-library/dom": "^9.3.0",
+    "@testing-library/dom": "^9.3.1",
     "@turf/intersect": "^6.3.0",
-    "@types/jest": "^29.0.0",
+    "@types/jest": "^29.5.3",
     "@types/jwt-decode": "^3.0.0",
-    "@types/lodash": "4.14.197",
+    "@types/lodash": "4.14.202",
     "@typescript-eslint/eslint-plugin": "^6.4.0",
     "@typescript-eslint/parser": "^6.4.0",
     "atob": "^2.1.2",
-    "azuremaps-maplibre-gl": "^3.3.0",
+    "azuremaps-maplibre-gl": "^3.6.1",
     "canvas": "^2.10.2",
-    "es-abstract": "^1.20.1",
-    "eslint": "^8.39.0",
+    "es-abstract": "^1.22.1",
+    "eslint": "^8.47.0",
     "eslint-plugin-security": "^1.5.0",
     "estree-walker": "^3.0.0",
     "fs-extra": "^11.0.0",
     "gl": "^6.0.1",
     "glob": "^10.0.0",
     "grunt": "^1.6.1",
-    "jest": "^29.0.0",
-    "jest-environment-jsdom": "^29.6.1",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "jest-trx-results-processor": "^3.0.1",
     "jwt-decode": "^3.0.0",
     "less": "^4.2.0",
@@ -85,6 +85,7 @@
     "yargs": "^17.7.2"
   },
   "overrides": {
+    "@babel/core": "7.23.3",
     "rollup": "^3.28.0"
   },
   "license": "SEE LICENSE IN LICENSE.TXT",
@@ -94,5 +95,6 @@
     "thirdpartynotices.txt"
   ],
   "types": "./typings/index.d.ts",
-  "main": "./dist/atlas.min.js"
+  "main": "./dist/atlas.min.js",
+  "module": "./dist/atlas-esm.min.js"
 }

package/typings/index.d.ts

@@ -699,6 +699,38 @@ declare namespace atlas {
             protected constructPitchIncrementButton: (map: Map) => HTMLElement;
         }
 
+        /**
+         * 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.
          */
@@ -1127,6 +1159,8 @@ declare namespace atlas {
 
             /**
              * Sets the options of the polygon layer.
+             * When `fillPattern` is set, `fillColor` will be ignored.
+             * To set `fillColor`, make sure `fillPattern` is set to `undefined`.
              * @param newOptions The new options of the polygon layer.
              */
             setOptions(options: PolygonLayerOptions): void;
@@ -3772,6 +3806,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.
      */
@@ -4773,8 +4825,8 @@ declare namespace atlas {
          */
         styleAPIVersion?: string;
         /**
-         * Enable accessibility
-         * default: true
+         * Enable the accessibility feature to provide screen reader support for users who have difficulty visualizing the web application.
+         * This property is set to true by default.
          * @default true
          */
         enableAccessibility?: boolean;
@@ -5575,6 +5627,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.
          */