azure-maps-control 2.1.8 → 2.1.11

package/package.json

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

package/typings/index.d.ts

@@ -629,9 +629,9 @@ declare namespace atlas {
              */
             onRemove(): void;
             /**
-             * Set the style that need to be displayed as currently selected. 
+             * Set the style that need to be displayed as currently selected.
              * Style will automatically get selected if `StyleControlOptions.autoSelectionMode` is `true`
-             * @param styleName - Style name that need to be disabled as currently selected 
+             * @param styleName - Style name that need to be disabled as currently selected
              */
             setSelectedStyle(styleName: string): void;
             /**
@@ -702,7 +702,7 @@ declare namespace atlas {
              * 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.
@@ -1536,6 +1536,16 @@ declare namespace atlas {
          * @returns An array of position objects that form a regular polygon.
          */
         export function getRegularPolygonPath(origin: atlas.data.Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): atlas.data.Position[];
+        /**
+         * Calculates an array of position objects that are an equal distance away from a central point to create a regular polygon broken by antimeridian into multiple sub-paths.
+         * @param origin Center of the regular polygon.
+         * @param radius Radius of the regular polygon.
+         * @param numberOfPositions Number of positions the polygon should have.
+         * @param units Unit of distance measurement. Default is meters.
+         * @param offset An offset to rotate the polygon. When 0 the first position will align with North.
+         * @returns An array of paths that form a regular polygon. Comparing to getRegularPolygonPath, sub-paths will always contain longitude in -180 to 180 range
+         */
+        export function getRegularPolygonPaths(origin: Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): Position[][]
         /**
          * Calculates a position object that is a fractional distance between two position objects.
          * @param origin First position to calculate mid-point between.
@@ -1807,10 +1817,26 @@ declare namespace atlas {
         /**
          * Perform a Douglas-Peucker simplification on an array of positions or pixels.
          * @param points The position or pixel points to simplify.
-         * @param tolerance A tolerance to use in the simplification. 
-         * @returns A new array of the simplified set of points. 
+         * @param tolerance A tolerance to use in the simplification.
+         * @returns A new array of the simplified set of points.
          */
         export function simplify(points: (Position | Pixel)[], tolerance: number): (Position | Pixel)[];
+
+        /**
+         * Denormalizes path on antimeridian, this makes lines with coordinates on the opposite side of the antimeridian to always cross it. Note that the path crossing antimeridian will contain longitude outside of -180 to 180 range.
+         * See getPathSplitByAntimeridian when this is not desired.
+         * @param path Array of position objects or linestring to denormalize
+         * @returns A denormalized array of position objects, path crossing antimeridian will contain longitude outside of -180 to 180 range.
+         */
+        export function getPathDenormalizedAtAntimerian(path: atlas.data.LineString | Position[]): Position[];
+
+        /**
+         * Split path on antimeridian into multiple paths.
+         * See getPathDenormalizedAtAntimerian when this is not desired.
+         * @param path Array of position objects or linestring to split
+         * @returns A path split into multiple paths by antimeridian.
+         */
+        export function getPathSplitByAntimeridian(path: atlas.data.LineString | Position[]): Position[][];
     }
 
     /**
@@ -1818,7 +1844,6 @@ declare namespace atlas {
      */
     export class Map {
         private readonly styleLayerIds;
-        private readonly styleSourceIds;
         private readonly map;
         private localizedStringsPromise;
         private insights;
@@ -2587,7 +2612,7 @@ declare namespace atlas {
      */
     export function setLanguage(language: string): void;
     /**
-     * Sets Maximum number of images (raster tiles, sprites, icons) to load in parallel, 
+     * Sets Maximum number of images (raster tiles, sprites, icons) to load in parallel,
      * which affects performance in raster-heavy maps. 16 by default.
      * @param maxParallelImageRequests Maximum number of images to load in parallel.
      */
@@ -2795,6 +2820,12 @@ declare namespace atlas {
          * @default false
          */
         optional?: boolean;
+        /**
+         * Size of the additional area around the icon bounding box used for detecting symbol collisions.
+         * Default `2`.
+         * @default 2
+         */
+        padding?: number | Expression;
         /**
          * Specifies the orientation of the icon when the map is pitched.
          * <p>`"auto"`: Automatically matches the value of `rotationAlignment`.</p>
@@ -2885,15 +2916,15 @@ declare namespace atlas {
         sourceLayer?: string;
 
         /**
-         * Specifies the color gradient used to colorize the pixels in the heatmap. 
-         * This is defined using an expression that uses `["heatmap-density"]` as input. 
+         * Specifies the color gradient used to colorize the pixels in the heatmap.
+         * This is defined using an expression that uses `["heatmap-density"]` as input.
          * Default `["interpolate",["linear"],["heatmap-density"],0,"rgba(0,0, 255,0)",0.1,"royalblue",0.3,"cyan",0.5,"lime",0.7,"yellow",1,"red"]`
          * @default `["interpolate",["linear"],["heatmap-density"],0,"rgba(0,0, 255,0)",0.1,"royalblue",0.3,"cyan",0.5,"lime",0.7,"yellow",1,"red"]`
          */
         color?: Expression;
 
         /**
-         * Similar to `heatmap-weight` but specifies the global heatmap intensity. 
+         * Similar to `heatmap-weight` but specifies the global heatmap intensity.
          * The higher this value is, the more ‘weight’ each point will contribute to the appearance.
          * Default `1`
          * @default 1
@@ -2908,7 +2939,7 @@ declare namespace atlas {
         opacity?: number | Expression;
 
         /**
-         * The radius in pixels used to render a data point on the heatmap. 
+         * The radius in pixels used to render a data point on the heatmap.
          * The radius must be a number greater or equal to 1.
          * Default `30`.
          * @default 30
@@ -2916,9 +2947,9 @@ declare namespace atlas {
         radius?: number | Expression;
 
         /**
-         * Specifies how much an individual data point contributes to the heatmap. 
-         * Must be a number greater than 0. A value of 5 would be equivalent to having 5 points of weight 1 in the same spot. 
-         * This is useful when clustering points to allow heatmap rendering or large datasets. 
+         * Specifies how much an individual data point contributes to the heatmap.
+         * Must be a number greater than 0. A value of 5 would be equivalent to having 5 points of weight 1 in the same spot.
+         * This is useful when clustering points to allow heatmap rendering or large datasets.
          * Default `1`
          * @default 1
          */
@@ -3228,6 +3259,26 @@ declare namespace atlas {
          * @default "point"
          */
         placement?: "point" | "line" | "line-center";
+        /**
+         * Sorts features in ascending order based on this value. Features with
+         * lower sort keys are drawn and placed first.
+         * Default `undefined`.
+         * @default undefined
+         */
+        sortKey?: number | Expression;
+        /**
+         * Determines whether overlapping symbols in the same layer are rendered in the order
+         * that they appear in the data source, or by their y position relative to the viewport.
+         * To control the order and prioritization of symbols otherwise, use `sortKey`.
+         * <p>`"auto"`: Sorts symbols by `sortKey` if set. Otherwise behaves like `"viewport-y"`.
+         * <p>`"viewport-y"`: Sorts symbols by their y position if `allowOverlap` is `true` or
+         * if `ignorePlacement` is `false`.
+         * <p>`"source"`: Sorts symbols by `sortKey` if set. Otherwise, symbols are rendered in the
+         * same order as the source data.
+         * Default `"auto"`
+         * @default "auto"
+         */
+        zOrder?: "auto" | "viewport-y" | "source";
         /**
          * Distance in pixels between two symbol anchors along a line. Must be greater or equal to 1.
          * Default `250`.
@@ -3286,6 +3337,16 @@ declare namespace atlas {
          * @default false
          */
         ignorePlacement?: boolean;
+        /**
+         * Text justification options.
+         * <p>`"auto"`: The text is aligned towards the anchor position.
+         * <p>`"left"`: The text is aligned to the left.
+         * <p>`"center"`: The text is centered.
+         * <p>`"right"`: The text is aligned to the right.
+         * Default `"center"`.
+         * @default "center"
+         */
+        justify?: "auto" | "left" | "center" | "right";
         /**
          * Specifies an offset distance of the icon from its anchor in ems.
          * Positive values indicate right and down, while negative values indicate left and up.
@@ -3301,6 +3362,13 @@ declare namespace atlas {
          * @default false
          */
         optional?: boolean;
+        /**
+         * Size of the additional area around the text bounding box used for detecting
+         * symbol collisions.
+         * Default `2`.
+         * @default 2
+         */
+        padding?: number | Expression;
         /**
          * Specifies the orientation of the text when the map is pitched.
          * <p>`"auto"`: Automatically matches the value of `rotationAlignment`.</p>
@@ -3310,6 +3378,13 @@ declare namespace atlas {
          * @default "auto"
          */
         pitchAlignment?: "auto" | "map" | "viewport";
+        /**
+         * Radial offset of text, in the direction of the symbol's anchor. Useful in combination
+         * with `variableAnchor`, which defaults to using the two-dimensional `offset` if present.
+         * Default: `0`
+         * @default 0
+         */
+        radialOffset?: number | Expression;
         /**
          * The amount to rotate the text clockwise in degrees.
          * Default `0`
@@ -3329,6 +3404,25 @@ declare namespace atlas {
          * @default "auto"
          */
         rotationAlignment?: "auto" | "map" | "viewport";
+        /**
+         * List of potential anchor locations, to increase the chance of placing high-priority
+         * labels on the map. The renderer will attempt to place the label at each location,
+         * in order, before moving onto the next label. Use `justify: "auto"` to choose text
+         * justification based on anchor position. To apply an offset use the `radialOffset` or
+         * two-dimensional `offset` options.
+         * <p>`"center"`: The center of the icon is placed closest to the anchor.</p>
+         * <p>`"left"`: The left side of the icon is placed closest to the anchor.</p>
+         * <p>`"right"`: The right side of the icon is placed closest to the anchor.</p>
+         * <p>`"top"`: The top of the icon is placed closest to the anchor.</p>
+         * <p>`"bottom"`: The bottom of the icon is placed closest to the anchor.</p>
+         * <p>`"top-left"`: The top left corner of the icon is placed closest to the anchor.</p>
+         * <p>`"top-right"`: The top right corner of the icon is placed closest to the anchor.</p>
+         * <p>`"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.</p>
+         * <p>`"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.</p>
+         * Default: `undefined`
+         * @default undefined
+         */
+        variableAnchor?: ("center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right")[];
         /**
          * The size of the font in pixels.
          * Must be a number greater or equal to 0.
@@ -3463,6 +3557,11 @@ declare namespace atlas {
          * @default ControlStyle.light
          */
         style: ControlStyle;
+        /**
+         * Inverts the direction of map rotation controls.
+         * @default false
+         */
+        inverted?: boolean;
     }
 
     /**
@@ -3481,6 +3580,11 @@ declare namespace atlas {
          * @default ControlStyle.light
          */
         style: ControlStyle;
+        /**
+         * Inverts the direction of map pitch controls.
+         * @default false
+         */
+        inverted?: boolean;
     }
 
     /**
@@ -3518,6 +3622,11 @@ declare namespace atlas {
          * Default `true`
          */
         autoSelectionMode?: boolean;
+        /**
+         * theme
+         * when unset - all styles are selectable
+         */
+        theme?: "auto" | string;
     }
 
     /**
@@ -3656,7 +3765,7 @@ declare namespace atlas {
          */
         centerOffset?: atlas.Pixel;
         /**
-         * The bearing of the map (rotation) in degrees. 
+         * The bearing of the map (rotation) in degrees.
          * When the bearing is 0, 90, 180, or 270 the top of the map container will be north, east, south or west respectively.
          * `default 0`
          * @default 0
@@ -4193,6 +4302,12 @@ declare namespace atlas {
          * @default true
          */
         touchInteraction?: boolean;
+        /**
+         * Whether touch rotation is enabled for touch devices. This option is not applied if touchInteraction is disabled.
+         * default `true`
+         * @default true
+         */
+        touchRotate?: boolean;
         /**
          * Sets the zoom rate of the mouse wheel
          * default `1/450`
@@ -4329,7 +4444,34 @@ declare namespace atlas {
         | 'SpriteJSON'
         | 'Image'
         | 'StyleDefinitions'
-        | 'Attribution';
+        | 'Attribution'
+        | 'Thumbnail';
+
+    /**
+     * Represents the contents of the style set.
+     */
+    export interface StyleSet {
+        created?: string;
+        defaultStyle: string;
+        description?: string;
+        id?: string;
+        styles: StyleSetStyle[];
+        version?: number;
+    }
+
+    /**
+     * Represents the info for a single style.
+     */
+    export interface StyleSetStyle {
+        copyright?: string;
+        displayName?: string;
+        name: string;
+        shortcutKey?: string;
+        style?: object;
+        theme: string;
+        thumbnail?: string;
+        url?: string;
+    }
 
     /**
      * Global properties used in all atlas service requests.
@@ -4355,12 +4497,24 @@ declare namespace atlas {
          * @default "atlas.microsoft.com"
          */
         domain?: string;
+        /**
+         * The style set of the map. Determines which styles are available to be picked
+         * and what do they consist of (style names, thumbnails, URLs, etc).
+         */
+        styleSet?: StyleSet;
         /**
          * Enable accessibility
          * default: true
          * @default true
          */
         enableAccessibility?: boolean;
+        /**
+         * Enable fallback to geocoder for accessibility location, if failed to extract location from vector data.
+         * default: true
+         * @default true
+         * @internal
+         */
+        enableAccessibilityLocationFallback?: boolean;
         /**
          * Controls the duration of the fade-in/fade-out animation for label collisions, in milliseconds.
          * This setting affects all symbol layers.
@@ -4369,7 +4523,7 @@ declare namespace atlas {
          */
         fadeDuration?: number;
         /**
-         * Defines a CSS font-family for locally overriding generation of glyphs in the 
+         * 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,
@@ -4379,7 +4533,7 @@ declare namespace atlas {
          */
         localIdeographFontFamily?: string;
         /**
-         * Maximum number of images (raster tiles, sprites, icons) to load in parallel, 
+         * Maximum number of images (raster tiles, sprites, icons) to load in parallel,
          * which affects performance in raster-heavy maps. 16 by default.
          */
         maxParallelImageRequests?: number;
@@ -4533,6 +4687,12 @@ declare namespace atlas {
          * @param callback The event handler callback.
          */
         add(eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
+        /**
+         * Adds a styleset change event to the map.
+         * @param eventType A styleset changed event name
+         * @param callback The event handler callback
+         */
+        add(eventType: "stylesetchanged", callback: (e: StyleSet) => void): void;
         /**
          * Adds a wheel event to the map.
          * @param eventType The wheel event name.
@@ -4809,7 +4969,7 @@ declare namespace atlas {
          * @param eventType The event name.
          * @param callback The event handler callback.
          */
-        remove(eventType: string, callback: (e: void | atlas.layer.Layer | MapEvent | MapDataEvent | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.source.Source | string) => void): void;
+        remove(eventType: string, callback: (e: void | atlas.layer.Layer | MapEvent | MapDataEvent | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.source.Source | string | StyleSet) => void): void;
         /**
          * Removes an event listener from the DataSource(s).
          * @param eventType The event name.
@@ -4893,6 +5053,26 @@ declare namespace atlas {
         clear(): void;
     }
 
+    /**
+     * Signature for the `options` parameter passed to `ImageSpriteManager.add`.
+     */
+    export type StyleImageMetadata = {
+        /** Ratio of pixels in the image to physical pixels on the screen (default: 1) */
+        pixelRatio?: number;
+
+        /** Whether the image should be interpreted as an SDF image (default: false) */
+        sdf?: boolean;
+
+        /** [[x1, x2], ...] if icon-text-fit is used in a layer with this image, defines the part(s) that can be stretched horizontally */
+        stretchX?: number[][];
+
+        /** [[y1, y2], ...] if icon-text-fit is used in a layer with this image, defines the part(s) that can be stretched vertically */
+        stretchY?: number[][];
+
+        /** [x1, y1, x2, y2] if icon-text-fit is used in a layer with this image, defines the part of the image that can be covered by the content in text-field */
+        content?: number[];
+    };
+
     /**
      * A manager for the map control's image sprite.
      * Exposed through the imageSprite property of the atlas.Map class.
@@ -4904,8 +5084,9 @@ declare namespace atlas {
          * @param id The image's id.
          * If the specified id matches the id of a previously added image the new image will be ignored.
          * @param icon The image to add to the map's sprite. Can be a data URI, inline SVG, or image URL.
+         * @param meta Additional options that describe the image
          */
-        add(id: string, icon: string | HTMLImageElement | ImageData): Promise<void>;
+        add(id: string, icon: string | HTMLImageElement | ImageData, meta?: StyleImageMetadata): Promise<void>;
         /**
          * Removes all images added by the user.
          */