azure-maps-control 2.1.3 → 2.1.8

package/package.json

@@ -1,78 +1,97 @@
-{
-  "name": "azure-maps-control",
-  "author": "Microsoft Corporation",
-  "version": "2.1.3",
-  "description": "Map SDK for Azure Maps",
-  "keywords": [
-    "azure",
-    "maps",
-    "ui",
-    "map",
-    "control",
-    "lbs",
-    "microsoft"
-  ],
-  "scripts": {
-    "build": "node ./bin/build.js",
-    "docs": "(if exist \"./docs/\" rmdir \"./docs/\" /S /Q) && tsc --declaration --declarationDir ./docs --emitDeclarationOnly --stripInternal",
-    "lessc": "node_modules/.bin/lessc",
-    "test": "set \"TS_NODE_PROJECT=./test/tsconfig.json\" && mocha-parallel-tests --exit  --timeout 60000 --require ts-node/register test/**/*.ts",
-    "test-filter": "set \"TS_NODE_PROJECT=./test/tsconfig.json\" && mocha-parallel-tests --exit --timeout 30000 --require ts-node/register",
-    "thirdPartyNotices": "node ./bin/thirdPartyNotices.js",
-    "tslint": "node_modules/.bin/tslint --project ./tsconfig.json",
-    "updateEnvVariables": "node ./bin/updateEnvVariables.js",
-    "updateExampleKeys": "node ./bin/updateExampleKeys.js",
-    "updateTestSecrets": "node ./bin/updateTestSecrets.js"
-  },
-  "dependencies": {
-    "@types/adal-angular": "^1.0.1"
-  },
-  "devDependencies": {
-    "@mapbox/mapbox-gl-rtl-text": "^0.2.3",
-    "@microsoft/applicationinsights-web": "^2.5.9",
-    "@turf/intersect": "^6.3.0",
-    "@types/jwt-decode": "^2.2.0",
-    "@types/lodash": "4.14.136",
-    "@types/mapbox-gl": "^1.13.0",
-    "@types/mocha": "^5.2.7",
-    "@types/puppeteer": "^1.20.7",
-    "adal-angular": "^1.0.18",
-    "atob": "^2.1.2",
-    "azuremaps-maplibre-gl": "1.14.0-rc2",
-    "es-abstract": "^1.17.1",
-    "estree-walker": "^1.0.1",
-    "fs-extra": "^8.1.0",
-    "glob": "^7.1.6",
-    "grunt": "^1.3.0",
-    "jwt-decode": "^2.2.0",
-    "less": "^3.12.2",
-    "less-plugin-clean-css": "^1.5.1",
-    "lodash": "4.17.15",
-    "mocha": "^7.2.0",
-    "mocha-parallel-tests": "^2.3.0",
-    "node-fetch": "^2.6.1",
-    "puppeteer": "^2.1.1",
-    "rollup": "^1.32.1",
-    "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-json": "^4.0.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-sourcemaps": "^0.6.3",
-    "rollup-plugin-uglify": "^6.0.4",
-    "simplify-ts": "^1.0.2",
-    "ts-node": "^8.10.2",
-    "tslint": "^5.20.1",
-    "tslint-microsoft-contrib": "^6.2.0",
-    "typescript": "^3.7.2",
-    "utf-8-validate": "^5.0.2",
-    "uuid-random": "^1.3.2",
-    "yargs": "^13.3.2"
-  },
-  "license": "SEE LICENSE IN LICENSE.TXT",
-  "files": [
-    "typings/**/*",
-    "dist/**/*",
-    "thirdpartynotices.txt"
-  ],
-  "types": "./typings/index.d.ts",
-  "main": "./dist/atlas.min.js"
-}
+{
+  "name": "azure-maps-control",
+  "author": "Microsoft Corporation",
+  "version": "2.1.8",
+  "description": "Map SDK for Azure Maps",
+  "keywords": [
+    "azure",
+    "maps",
+    "ui",
+    "map",
+    "control",
+    "lbs",
+    "microsoft"
+  ],
+  "scripts": {
+    "build": "node ./bin/build.js",
+    "docs": "(if exist \"./docs/\" rmdir \"./docs/\" /S /Q) && tsc --declaration --declarationDir ./docs --emitDeclarationOnly --stripInternal",
+    "lessc": "node_modules/.bin/lessc",
+    "pretest": "npm run updatePackageVersionForTests -- --isPreTest true",
+    "posttest": "npm run updatePackageVersionForTests -- --isPreTest false",
+    "test": "set \"TS_NODE_PROJECT=./test/tsconfig.json\" && mocha --reporter cypress-multi-reporters --reporter-options configFile=mochaReporters.json --parallel --exit --timeout 30000 --require ts-node/register test/**/*.ts",
+    "coverage": "nyc --reporter cobertura --reporter text -t coverage npm run test",
+    "pretest-filter": "npm run updatePackageVersionForTests -- --isPreTest true",
+    "posttest-filter": "npm run updatePackageVersionForTests -- --isPreTest false",
+    "test-filter": "set \"TS_NODE_PROJECT=./test/tsconfig.json\" && mocha --parallel --exit --timeout 30000 --require ts-node/register",
+    "thirdPartyNotices": "node ./bin/thirdPartyNotices.js",
+    "tslint": "node_modules/.bin/tslint --project ./tsconfig.json",
+    "updateEnvVariables": "node ./bin/updateEnvVariables.js",
+    "updateExampleKeys": "node ./bin/updateExampleKeys.js",
+    "updateTestSecrets": "node ./bin/updateTestSecrets.js",
+    "updatePackageVersionForTests": "node ./bin/updatePackageVersionForTests.js"
+  },
+  "dependencies": {
+    "@types/adal-angular": "^1.0.1"
+  },
+  "devDependencies": {
+    "@mapbox/mapbox-gl-rtl-text": "^0.2.3",
+    "@microsoft/applicationinsights-web": "^2.5.9",
+    "@turf/intersect": "^6.3.0",
+    "@types/jwt-decode": "^2.2.0",
+    "@types/lodash": "4.14.136",
+    "@types/mapbox-gl": "^1.13.0",
+    "@types/mocha": "^5.2.7",
+    "@types/puppeteer": "^1.20.7",
+    "adal-angular": "^1.0.18",
+    "atob": "^2.1.2",
+    "azuremaps-maplibre-gl": "^1.14.0-rc4",
+    "cypress-multi-reporters": "^1.5.0",
+    "es-abstract": "^1.17.1",
+    "estree-walker": "^1.0.1",
+    "fs-extra": "^8.1.0",
+    "glob": "^7.1.6",
+    "grunt": "^1.3.0",
+    "jwt-decode": "^2.2.0",
+    "less": "^3.12.2",
+    "less-plugin-clean-css": "^1.5.1",
+    "lodash": "4.17.15",
+    "mocha": "^9.0.3",
+    "mocha-trx-reporter": "^3.3.1",
+    "node-fetch": "^2.6.1",
+    "nyc": "^15.1.0",
+    "puppeteer": "^10.2.0",
+    "rollup": "^1.32.1",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-node-resolve": "^5.2.0",
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "rollup-plugin-uglify": "^6.0.4",
+    "simplify-ts": "^1.0.2",
+    "ts-node": "^8.10.2",
+    "tslint": "^5.20.1",
+    "tslint-microsoft-contrib": "^6.2.0",
+    "typescript": "^3.7.2",
+    "utf-8-validate": "^5.0.2",
+    "uuid-random": "^1.3.2",
+    "yargs": "^13.3.2"
+  },
+  "license": "SEE LICENSE IN LICENSE.TXT",
+  "files": [
+    "typings/**/*",
+    "dist/**/*",
+    "thirdpartynotices.txt"
+  ],
+  "types": "./typings/index.d.ts",
+  "main": "./dist/atlas.min.js",
+  "nyc": {
+    "all": true,
+    "exclude": [
+      "bin",
+      "dist",
+      "test",
+      "examples"
+    ],
+    "check-coverage": false,
+    "exclude-after-remap": false
+  }
+}

package/typings/index.d.ts

@@ -638,12 +638,12 @@ declare namespace atlas {
              * Set style in a disabled state
              * @param styleName Style to be disabled
              */
-            disableStyle(styleName: string);
+            disableStyle(styleName: string): void;
             /**
              * Enabled style that was previously disabled
              * @param styleName Style to be disabled
              */
-            enableStyle(styleName: string);
+            enableStyle(styleName: string): void;
             private buildSelectStyleBtn;
             private buildCurrStyleBtn;
             private buildStyleOpsGrid;
@@ -681,12 +681,28 @@ declare namespace atlas {
             private hasMouse;
             private hasFocus;
             private options;
+            private initIsActive;
+            private style;
+            private container;
+            private trafficButton;
+            private map;
+
             /**
             * Constructs a TrafficControl
             * @param options The options for the control.
             */
             constructor(options?: TrafficControlOptions);
 
+            /**
+             * Current control state (is traffic information displayed?)
+             */
+            get isActive(): boolean;
+
+            /**
+             * Sets the control state
+             */
+            set isActive(newValue: boolean);
+        
             /**
              * Initialization method for the control which is called when added to the map.
              * @param map The map that the control will be added to.
@@ -695,6 +711,17 @@ declare namespace atlas {
              */
             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;
+
+            /**
+             * Updates the button state according to current traffic state
+             */
+            updateButtonState(): void;
+
             /**
              * Get the TrafficControlOptions
              */
@@ -1466,9 +1493,16 @@ declare namespace atlas {
          * Takes an array of positions objects and fills in the space between them with accurately positioned positions to form an approximated Geodesic path.
          * @param path Array of position objects that form a path to fill in.
          * @param nodeSize Number of nodes to insert between each position. Default: 15
-         * @returns An array of position objects that form a geodesic paths.
+         * @returns An array of position objects that form a geodesic paths, geodesic path crossing antimeridian will contain longitude outside of -180 to 180 range. See getGeodesicPaths() when this is undesired.
          */
         export function getGeodesicPath(path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[];
+        /**
+         * Takes an array of positions objects and fills in the space between them with accurately positioned positions to form an approximated Geodesic path broken by antimeridian into multiple sub-paths.
+         * @param path Array of position objects that form a path to fill in.
+         * @param nodeSize Number of nodes to insert between each position. Default: 15
+         * @returns An array of paths that form geodesic paths, Comparing to getGeodesicPath, sub-paths will always contain longitude in -180 to 180 range
+         */
+        export function getGeodesicPaths(path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[][]
         /**
          * Calculates the heading from one position object to another.
          * @param origin Point of origin.
@@ -4327,6 +4361,23 @@ declare namespace atlas {
          * @default true
          */
         enableAccessibility?: boolean;
+        /**
+         * Controls the duration of the fade-in/fade-out animation for label collisions, in milliseconds.
+         * This setting affects all symbol layers.
+         * This setting does not affect the duration of runtime styling transitions or raster tile cross-fading.
+         * @default 300
+         */
+        fadeDuration?: number;
+        /**
+         * Defines a CSS font-family for locally overriding generation of glyphs in the 
+         * 'CJK Unified Ideographs', 'Hiragana', 'Katakana' and 'Hangul Syllables' ranges.
+         * In these ranges, font settings from the map's style will be ignored,
+         * except for font-weight keywords (light/regular/medium/bold). Set to false,
+         * to enable font settings from the map's style for these glyph ranges.
+         * The purpose of this option is to avoid bandwidth-intensive glyph server requests.
+         * @default 'sans-serif'
+         */
+        localIdeographFontFamily?: string;
         /**
          * Maximum number of images (raster tiles, sprites, icons) to load in parallel, 
          * which affects performance in raster-heavy maps. 16 by default.
@@ -4406,7 +4457,7 @@ declare namespace atlas {
         /**
          * Returns the access token with an audience URI of https://atlas.microsoft.com.
          */
-        getToken(): string;
+        getToken(): string | null;
         /**
          * Adds the necessary authentication query parameters or headers to a RequestParameters.
          * Returns the updated RequestParameters.