azure-maps-control 3.4.0 → 3.6.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "azure-maps-control",
     "author": "Microsoft Corporation",
-    "version": "3.4.0",
+    "version": "3.6.0",
     "description": "Map SDK for Azure Maps",
     "keywords": [
         "azure",
@@ -42,15 +42,15 @@
     "devDependencies": {
         "@mapbox/mapbox-gl-rtl-text": "^0.2.3",
         "@microsoft/applicationinsights-web": "^3.3.0",
-        "@playwright/test": "^1.42.1",
-        "@rollup/plugin-commonjs": "^25.0.4",
+        "@playwright/test": "^1.49.1",
+        "@rollup/plugin-commonjs": "^25.0.7",
         "@rollup/plugin-json": "^6.0.0",
         "@rollup/plugin-node-resolve": "^15.1.0",
         "@testing-library/dom": "^9.3.3",
         "@turf/intersect": "^6.3.0",
         "@types/jest": "^29.5.3",
         "@types/jwt-decode": "^3.0.0",
-        "@types/lodash": "4.17.0",
+        "@types/lodash": "4.17.15",
         "@typescript-eslint/eslint-plugin": "^6.4.0",
         "@typescript-eslint/parser": "^6.4.0",
         "atob": "^2.1.2",
@@ -69,7 +69,7 @@
         "jest-trx-results-processor": "^3.0.1",
         "jwt-decode": "^3.0.0",
         "less": "^4.2.0",
-        "less-plugin-clean-css": "^1.5.1",
+        "less-plugin-clean-css": "^1.6.0",
         "lodash": "4.17.21",
         "node-fetch": "^2.6.8",
         "playwright-trx-reporter": "^1.0.6",
@@ -78,15 +78,15 @@
         "rollup-plugin-sourcemaps": "^0.6.3",
         "rollup-plugin-uglify": "^6.0.4",
         "simplify-ts": "^1.0.2",
-        "ts-jest": "^29.1.1",
+        "ts-jest": "^29.2.2",
         "ts-node": "^10.0.0",
         "typescript": "^5.0.0",
-        "utf-8-validate": "^6.0.0",
+        "utf-8-validate": "^6.0.4",
         "uuid-random": "^1.3.2",
         "yargs": "^17.7.2"
     },
     "overrides": {
-        "@babel/core": "7.24.4",
+        "@babel/core": "7.26.7",
         "rollup": "^3.28.0"
     },
     "license": "SEE LICENSE.TXT",

package/typings/index.d.ts

@@ -889,6 +889,47 @@ declare namespace atlas {
             onAdd (map: Map): HTMLElement;
             private buildTrafficLegendDiv;
         }
+
+        /**
+         * A control to make the map or a specified element fullscreen.
+         */
+        export class FullscreenControl extends ControlBase {
+            private map: Map | null;
+            private options: FullscreenControlOptions;
+            private control;
+            private isFullscreenState: boolean;
+        
+            /**
+             * A control to make the map or a specified element fullscreen.
+             * @param options Options for defining how the control is rendered and the container to be made fullscreen.
+             */
+            constructor (options?: FullscreenControlOptions);
+        
+            /**
+             * 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): HTMLElement;
+        
+            /**
+             * Method that is called when the control is removed from the map. Should perform any necessary cleanup for the control.
+             */
+            onRemove (): void;
+        
+            /**
+             * Gets the current fullscreen state of the map.
+             * @returns A boolean indicating if the container is in fullscreen mode.
+             */
+            isFullscreen (): boolean;
+        
+            /**
+             * Checks to see if the browser supports going into fullscreen mode.
+             * @returns A boolean indicating if the browser supports fullscreen mode.
+             */
+            static isSupported (): boolean;
+        }
     }
 
     //internal classes
@@ -2826,7 +2867,7 @@ declare namespace atlas {
      * language is explicitly specified when using those parts of the API.
      * If a Map is initialized with the language explicitly defined and
      * setLanguage hasn't previously been called it will automatically be called by the Map constructor.
-     * @param language The new default language.
+     * @param language The new default language. If set to "auto", the browser's preferred language will be used.
      */
     export function setLanguage (language: string): void;
     /**
@@ -3397,7 +3438,7 @@ declare namespace atlas {
          * Name of image in sprite to use for drawing image fills.
          * For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512).
          */
-        fillPattern?: string;
+        fillPattern?: string | DataDrivenPropertyValueSpecification<string>;
         /**
          * The polygons' pixel offset.
          * Values are [x, y] where negatives indicate left and up, respectively.
@@ -3938,6 +3979,31 @@ declare namespace atlas {
         style?: ControlStyle;
     }
 
+    /**
+     * The options for a FullscreenControl object.
+     */
+    export interface FullscreenControlOptions extends Options {
+        /**
+         * The style of the control.
+         * Default `ControlStyle.light`
+         * @default ControlStyle.light
+         */
+        style?: ControlStyle;
+
+        /**
+         * Indicates if the control should be hidden if the browser does not support fullscreen mode.
+         * Default `false`
+         * @default false
+         */
+        hideIfUnsupported?: boolean;
+
+        /**
+         * The HTML element which should be made full screen.
+         * If not specified, the map container element will be used.
+         */
+        container?: HTMLElement;
+    }
+
     /**
      * The options for animating changes to the map control's camera.
      */
@@ -4449,6 +4515,7 @@ declare namespace atlas {
          * The language of the map labels.
          * [Supported language]{@link https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages}.
          * Default `atlas.getLanguage()`.
+         * If set to "auto", the browser's preferred language will be used.
          * @default atlas.getLanguage()
          */
         language?: string;
@@ -4536,6 +4603,12 @@ declare namespace atlas {
          * @deprecated use `view` instead.
          */
         userRegion?: string;
+        /**
+         * Override the default styles for the map elements.​
+         * Default `undefined`
+         * @default undefined
+         */
+        styleOverrides?: StyleOverrides;
     }
 
     /**
@@ -4827,8 +4900,8 @@ declare namespace atlas {
         /**
          * Disable telemetry collection
          * This option may only be set when initializing the map.
-         * default: false (true for the Azure Government cloud)
-         * @default false
+         * default: true
+         * @default true
          */
         disableTelemetry?: boolean;
         /**
@@ -5945,6 +6018,52 @@ declare namespace atlas {
          */
         point_count_abbreviated: string;
     }
+
+    /**
+     * Override the default styles for the map elements.​
+     */
+    export interface StyleOverrides {
+        /**​
+         * Country or regions. Supported by map styles "road", "satellite_road_labels", "grayscale_light", "grayscale_dark", "night", "road_shaded_relief", "high_contrast_dark", "high_contrast_light".​
+         */
+        countryRegion?: BorderedMapElementStyles;
+        /**​
+         * First administrative level within the country/region level, such as a state or a province. Supported by map styles "road", "satellite_road_labels", "grayscale_light", "grayscale_dark", "night", "road_shaded_relief", "high_contrast_dark", "high_contrast_light"​.
+         */
+        adminDistrict?: BorderedMapElementStyles;
+        /**​
+         * Second administrative level within the country/region level, such as a county.​ Supported by map styles "road", "satellite_road_labels", "night", "road_shaded_relief", "high_contrast_dark", "high_contrast_light".
+         */
+        adminDistrict2?: BorderedMapElementStyles;
+        /**​
+         * Building footprints along with their address numbers.​ Supported by map styles "road", "grayscale_light", "grayscale_dark", "night", "road_shaded_relief", "high_contrast_dark", "high_contrast_light".
+         */
+        buildingFootprint?: MapElementStyles;
+        /**​
+         * Street blocks in the populated places​. Supported by map styles "road", "grayscale_light", "grayscale_dark", "night", "road_shaded_relief", "high_contrast_dark", "high_contrast_light".
+         */
+        roadDetails?: MapElementStyles;
+    }
+
+    /**
+     * The style of the map element.​
+     */
+    export interface MapElementStyles {
+        /**
+         * Specifies the visibility of the element.​
+         */
+        visible?: boolean;
+    }
+
+    /**
+     * The style of the bordered map element.
+     */
+    export interface BorderedMapElementStyles {
+        /**
+         * Specifies the visibility of the border.​
+         */
+        borderVisible?: boolean;
+    }
 }
 
 export = atlas;