Azure Maps Control

https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/
Admin
A JavaScript library for controlling and interacting with Azure Maps, providing classes and...
Tokens:19,534
Snippets:317
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### JavaScript Array sort Example

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Provides an example of using the sort method with a compare function to sort an array of numbers in ascending order.

```TypeScript
[11,2,22,1].sort((a, b) => a - b)
```

--------------------------------

### Get WebGLLayer Options

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Retrieves the current options configured for the WebGL layer.

```typescript
function getOptions(): WebGLLayerOptions
```

--------------------------------

### unshift

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Inserts new elements at the start of an array.

```APIDOC
## unshift(number[])

### Description
Inserts new elements at the start of an array.

### Parameters 

items
    
number[]
Elements to insert at the start of the Array.

### Returns
number
**Inherited From** Array.unshift
```

--------------------------------

### Get VectorTileSource Options

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.source.vectortilesource

Retrieves the configuration options for a VectorTileSource instance.

```typescript
function getOptions(): VectorTileSourceOptions
```

--------------------------------

### Reduce Array to Single Value (With Initial Value)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Applies a callback function against an accumulator and each element in the array (from left to right) to reduce it to a single value, starting with a specified initial value. Use when you need to define a starting point for the accumulation.

```TypeScript
function reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number
```

--------------------------------

### Reduce Array Right to Single Value (With Initial Value)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Applies a callback function against an accumulator and each element in the array (from right to left) to reduce it to a single value, starting with a specified initial value. Use when processing from the end of the array with a defined starting point.

```TypeScript
function reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number
```

--------------------------------

### Get Map Instance

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Retrieves the map instance to which the layer is currently added. Returns null if the layer is not yet added to a map.

```typescript
function getMap(): Map
```

--------------------------------

### getOptions()

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Retrieves the current configuration options set for the WebGL layer.

```APIDOC
## getOptions()

### Description
Gets the options of the WebGL layer.

### Returns
- **WebGLLayerOptions**: The current options of the WebGL layer.

### TypeScript Signature
```typescript
function getOptions(): WebGLLayerOptions
```
```

--------------------------------

### getOptions()

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.source.vectortilesource

Retrieves the current configuration options for the VectorTileSource.

```APIDOC
## getOptions()

### Description
Gets the options of the VectorTileSource.

### Returns
VectorTileSourceOptions - An object containing the current options of the VectorTileSource.
```

--------------------------------

### Options

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

General options interface.

```APIDOC
## Interface: Options

### Description
General options interface.
```

--------------------------------

### setOptions(options)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Updates the configuration options for the WebGL layer with new values.

```APIDOC
## setOptions(options)

### Description
Sets the options of the WebGL layer.

### Parameters

- **options** (WebGLLayerOptions, Required) - The new options to apply to the WebGL layer.

### TypeScript Signature
```typescript
function setOptions(options: WebGLLayerOptions)
```
```

--------------------------------

### Get Layer ID

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Retrieves the unique identifier of the layer.

```typescript
function getId(): string
```

--------------------------------

### LightOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for the map's lighting.

```APIDOC
## Interface: LightOptions

### Description
The options for the map's lighting.
```

--------------------------------

### FullscreenControlOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for a FullscreenControl object.

```APIDOC
## Interface: FullscreenControlOptions

### Description
The options for a FullscreenControl object.
```

--------------------------------

### IconOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options used to customize the icons in a SymbolLayer.

```APIDOC
## Interface: IconOptions

### Description
Options used to customize the icons in a SymbolLayer.
```

--------------------------------

### Get the length of an array

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Retrieves the length of an array, which is one higher than the highest element index.

```TypeScript
length: number
```

--------------------------------

### VectorTileSource Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.source.vectortilesource

Initializes a new instance of the VectorTileSource class.

```APIDOC
## VectorTileSource Constructor

### Description
Initializes a new instance of the VectorTileSource class.

### Parameters
#### Path Parameters
- **id** (string) - Optional - The ID of the VectorTileSource.
- **options** (VectorTileSourceOptions) - Optional - Options for configuring the VectorTileSource.
```

--------------------------------

### CameraOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for setting the map control's camera.

```APIDOC
## Interface: CameraOptions

### Description
The options for setting the map control's camera.
```

--------------------------------

### LayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

A base class from which all other layer options inherit.

```APIDOC
## Interface: LayerOptions

### Description
A base class which all other layer options inherit from.
```

--------------------------------

### Find First Index of Array Element

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Returns the index of the first occurrence of a value in an array. Optionally starts search from a specified index. Inherited from Array.indexOf.

```typescript
function indexOf(searchElement: number, fromIndex?: number): number
```

--------------------------------

### Find Last Index of Array Element

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Returns the index of the last occurrence of a specified value in an array. Optionally starts search from a specified index. Inherited from Array.lastIndexOf.

```typescript
function lastIndexOf(searchElement: number, fromIndex?: number): number
```

--------------------------------

### WebGLLayer Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Constructs a new WebGLLayer instance. An optional ID can be provided, otherwise, a random one is generated. Options for the layer can also be specified.

```APIDOC
## WebGLLayer Constructor

### Description
Constructs a new WebGLLayer.

### Parameters

- **id** (string, Optional) - The id of the layer. If not specified a random one will be generated.
- **options** (WebGLLayerOptions, Optional) - The options of the WebGL layer.

### TypeScript Signature
```typescript
new WebGLLayer(id?: string, options?: WebGLLayerOptions)
```
```

--------------------------------

### PopupOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for a popup.

```APIDOC
## Interface: PopupOptions

### Description
The options for a popup.
```

--------------------------------

### JavaScript Array slice Method Signature

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Defines the signature for the slice method, which returns a shallow copy of a portion of an array into a new array object selected from start to end (end not included).

```TypeScript
function slice(start?: number, end?: number): number[]
```

--------------------------------

### HtmlMarkerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options for rendering an HtmlMarker object.

```APIDOC
## Interface: HtmlMarkerOptions

### Description
Options for rendering an HtmlMarker object.
```

--------------------------------

### Get GeoJSON Features from VectorTileSource

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.source.vectortilesource

Queries a VectorTileSource for GeoJSON features within a specified source layer, optionally filtered by an Expression. This is useful for retrieving data from a specific layer of a vector tile source.

```typescript
function getShape(sourceLayer: string, filter?: Expression): Array<Feature<atlas.data.Geometry, any>>
```

--------------------------------

### Utility and Geometry Classes

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Classes for geometric transformations, pixel coordinates, popups, and shape management.

```APIDOC
## Utility and Geometry Classes

### Description
Classes for geometric transformations, pixel coordinates, popups, and shape management.

### Classes
- **AffineTransform**: An Affine Transform class generated from a set of reference points.
- **Pixel**: Represent a pixel coordinate or offset. Extends an array of [x, y].
- **Popup**: An information window anchored at a specified position on a map.
- **PopupTemplate**: A layout template for a popup.
- **Shape**: A helper class that wraps a Geometry or Feature and makes it easy to update and maintain.
```

--------------------------------

### Generic Reduce Array to Single Value (With Initial Value)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Applies a callback function against an accumulator and each element in the array (from left to right) to reduce it to a single value of a potentially different type, starting with a specified initial value. Use for flexible accumulation where the result type may differ from the array element type.

```TypeScript
function reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U
```

--------------------------------

### StyleOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

The options for the map's style.

```APIDOC
## Interface: StyleOptions

### Description
Specifies the various options that can be set to configure the overall visual style of the map, including base styles and custom layers.

### Usage
These options are typically provided during map initialization or when updating the map's style.
```

--------------------------------

### forEach

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Performs the specified action for each element in an array. This method is inherited from the Array.forEach method.

```APIDOC
## forEach((value: number, index: number, array: number[]) => void, any)

### Description
Performs the specified action for each element in an array.

### Parameters
#### Path Parameters
* **callbackfn** (value: number, index: number, array: number[]) => void - A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
* **thisArg** (any) - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

**Inherited From** Array.forEach
```

--------------------------------

### onAdd Method

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.control.zoomcontrol

The initialization method for the ZoomControl, called when the control is added to the map. It returns an HTMLElement to be placed on the map.

```APIDOC
## onAdd(map: Map)

### Description
Initialization method for the control which is called when added to the map.

### Parameters
#### Parameters
- **map** (Map) - The map that the control will be added to.

### Returns
HTMLElement - An HTMLElement to be placed on the map for the control.
```

--------------------------------

### fromLatLng (number, number, number)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Generates a Position object from latitude, longitude, and an optional elevation.

```APIDOC
## fromLatLng(lat, lng, elv?)

### Description
Generates a Position object from latitude and longitude values.

### Parameters

- **lat** (number) - Required - The latitude value.
- **lng** (number) - Required - A longitude value.
- **elv** (number) - Optional - An elevation value in meters.

### Returns
Position - A Position object that represents the provided LatLng information.
```

--------------------------------

### fromPosition

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Creates a clone of a given Position object.

```APIDOC
## fromPosition(position)

### Description
Clones a position.

### Parameters

- **position** (Position) - Required - The position to clone.

### Returns
Position - A new Position object that is a clone of the input position.
```

--------------------------------

### ControlBase

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Implements control interface and provides support for automatic styling based on the map style.

```APIDOC
## ControlBase

### Description
Implements control interface and provides support for automatic styling based on the map style.

### Class
ControlBase
```

--------------------------------

### CameraBoundsOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for setting the bounds of the map control's camera.

```APIDOC
## Interface: CameraBoundsOptions

### Description
The options for setting the bounds of the map control's camera.
```

--------------------------------

### ControlOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for adding a control to the map.

```APIDOC
## Interface: ControlOptions

### Description
The options for adding a control to the map.
```

--------------------------------

### fromLatLng (object)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Generates a Position object from an object containing coordinate properties (case-insensitive).

```APIDOC
## fromLatLng(latLng)

### Description
Generates a Position object from an object that contains coordinate information. The object is scanned for the following properties using a case insensitive test. Longitude: lng, longitude, lon, x Latitude: lat, latitude, y Elevation: elv, elevation, alt, altitude, z

### Parameters

- **latLng** (object) - Required - The object to extract coordinate information from.

### Returns
Position - A Position object that represents the provided LatLng information.
```

--------------------------------

### TileLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Options used when rendering raster tiled images in a TileLayer.

```APIDOC
## Interface: TileLayerOptions

### Description
Defines the configuration options for rendering raster tile images within a TileLayer on the map.

### Usage
These options are used when creating or configuring a TileLayer to display tiled map imagery.
```

--------------------------------

### MediaLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options used when rendering canvas, image, raster tile, and video layers.

```APIDOC
## Interface: MediaLayerOptions

### Description
Options used when rendering canvas, image, raster tile, and video layers.
```

--------------------------------

### Properties

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

A set of properties that can be used with a `PopupTemplate`.

```APIDOC
## Interface: Properties

### Description
A set of properties that can be used with a `PopupTemplate`.
```

--------------------------------

### Map Interaction and Management

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Classes for managing map events, displaying HTML markers, and handling map interactions.

```APIDOC
## Map Interaction and Management

### Description
Classes for managing map events, displaying HTML markers, and handling map interactions.

### Classes
- **EventManager**: A manager for the map control's events. Exposed through the `events` property of the `atlas.Map` class. Cannot be instantiated by the user.
- **HtmlMarker**: This class wraps an HTML element that can be displayed on the map.
```

--------------------------------

### Layer Initialization on Add

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

This method is called automatically when the layer is added to the map, performing necessary initialization tasks.

```typescript
function onAdd(map: Map)
```

--------------------------------

### Construct WebGLLayer

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Constructs a new WebGLLayer. An optional ID can be provided; otherwise, a random one is generated. The layer can be configured with WebGLLayerOptions.

```typescript
new WebGLLayer(id?: string, options?: WebGLLayerOptions)
```

--------------------------------

### RasterTileSourceOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options for a Raster Tile Source.

```APIDOC
## Interface: RasterTileSourceOptions

### Description
Options for a Raster Tile Source.
```

--------------------------------

### ImageLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options used when rendering Point objects in an ImageLayer.

```APIDOC
## Interface: ImageLayerOptions

### Description
Options used when rendering Point objects in an ImageLayer.
```

--------------------------------

### ElevationTileSourceOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options for an Elevation Tile Source.

```APIDOC
## Interface: ElevationTileSourceOptions

### Description
Options for an Elevation Tile Source.
```

--------------------------------

### Position.fromPosition

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Creates a clone of an existing Position object.

```APIDOC
## fromPosition(position: Position)

### Description
Clones a position.

### Parameters
* **position** (Position) - The position object to clone.
```

--------------------------------

### TextOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Options used to customize the text in a SymbolLayer.

```APIDOC
## Interface: TextOptions

### Description
Specifies options for customizing the appearance and behavior of text labels displayed within a SymbolLayer, such as font, color, and placement.

### Usage
These options are part of `SymbolLayerOptions` and are used to style the text components of symbols.
```

--------------------------------

### BubbleLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options used when rendering Point objects in a BubbleLayer.

```APIDOC
## Interface: BubbleLayerOptions

### Description
Options used when rendering Point objects in a BubbleLayer.
```

--------------------------------

### WebGLLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Options used to render graphics in a WebGLLayer.

```APIDOC
## Interface: WebGLLayerOptions

### Description
Specifies the configuration options for rendering custom graphics using WebGL within a `WebGLLayer` on the map.

### Usage
These options are applied when creating or updating a `WebGLLayer`.
```

--------------------------------

### Set WebGLLayer Options

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Updates the options of the WebGL layer with new configurations.

```typescript
function setOptions(options: WebGLLayerOptions)
```

--------------------------------

### Position Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Constructs a Position object with longitude, latitude, and an optional elevation.

```APIDOC
## new Position(longitude, latitude, elevation?)

### Description
Constructs a Position object.

### Parameters

- **longitude** (number) - Required - The position's longitude.
- **latitude** (number) - Required - The position's latitude.
- **elevation** (number) - Optional - The position's elevation.
```

--------------------------------

### onAdd(map)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

This method is called automatically when the layer is added to the map, serving as the initialization point for the layer's logic on the map.

```APIDOC
## onAdd(map)

### Description
Initialization method for the layer which is called when added to the map.

### Parameters

- **map** (Map, Required) - The map the layer has been added to.

### TypeScript Signature
```typescript
function onAdd(map: Map)
```

### Inherited From
Layer.onAdd
```

--------------------------------

### Instantiate VectorTileSource

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.source.vectortilesource

Creates a new instance of the VectorTileSource class. An optional ID and VectorTileSourceOptions can be provided.

```typescript
new VectorTileSource(id?: string, options?: VectorTileSourceOptions)
```

--------------------------------

### Position Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Constructs a Position object with longitude, latitude, and optional elevation.

```APIDOC
## Position(number, number, number)

### Description
Constructs a Position.

### Parameters
* **longitude** (number) - The longitude of the position.
* **latitude** (number) - The latitude of the position.
* **elevation** (number) - Optional. The elevation of the position.
```

--------------------------------

### toString

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Returns a string representation of an array.

```APIDOC
## toString()

### Description
Returns a string representation of an array.

### Returns
string
**Inherited From** Array.toString
```

--------------------------------

### StyleControlOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

The options for a StyleControl object.

```APIDOC
## Interface: StyleControlOptions

### Description
Defines the configuration options for customizing the behavior and appearance of the Style Control, which allows users to switch map styles.

### Usage
These options are used when initializing a StyleControl.
```

--------------------------------

### buildContainer Method (Inherited)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.control.zoomcontrol

Builds the outermost container for the control, applying styling and listeners. This method is inherited from ControlBase.

```APIDOC
## buildContainer<K>(map: Map, style: ControlStyle, ariaLabel?: string, tagName?: K)

### Description
Build the outermost container for the control, applies styling including any listeners for auto styling.

### Parameters
#### Parameters
- **map** (Map)
- **style** (ControlStyle)
- **ariaLabel** (string) - Optional
- **tagName** (K) - Optional

### Returns
HTMLElementTagNameMap[K] - The built container element.

### Inherited From
ControlBase.buildContainer
```

--------------------------------

### AuthenticationOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options for specifying how the map control should authenticate with the Azure Maps services.

```APIDOC
## Interface: AuthenticationOptions

### Description
Options for specifying how the map control should authenticate with the Azure Maps services.
```

--------------------------------

### MapConfigurationStyle

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Represents the information for a single style within a map configuration.

```APIDOC
## Interface: MapConfigurationStyle

### Description
Represents the info for a single style.
```

--------------------------------

### LineLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options used when rendering various geometry types in a line layer.

```APIDOC
## Interface: LineLayerOptions

### Description
Options used when rendering SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon, and MultiPolygon objects in a line layer.
```

--------------------------------

### ScaleControlOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Defines the configuration options for a ScaleControl object.

```APIDOC
## Interface: ScaleControlOptions

### Description
Specifies the various options available for customizing the appearance and behavior of the Scale Control on the map.

### Usage
These options are passed during the initialization of a ScaleControl instance.
```

--------------------------------

### PitchControlOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for a PitchControl object.

```APIDOC
## Interface: PitchControlOptions

### Description
The options for a PitchControl object.
```

--------------------------------

### AnimationOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for animating changes to the map control's camera.

```APIDOC
## Interface: AnimationOptions

### Description
The options for animating changes to the map control's camera.
```

--------------------------------

### FullscreenControl

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

A control to make the map or a specified element fullscreen.

```APIDOC
## FullscreenControl

### Description
A control to make the map or a specified element fullscreen.

### Class
FullscreenControl
```

--------------------------------

### fromLatLng (number[])

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Generates a Position object from an array containing latitude and longitude, or latitude, longitude, and elevation.

```APIDOC
## fromLatLng(latLng)

### Description
Generates a Position object from an array that has the format; [lat, lng] or [lat, lng, elv].

### Parameters

- **latLng** (number[]) - Required - An array that contains latitude/longitude information in the format; [lat, lng] or [lat, lng, elv].

### Returns
Position - A Position object that represents the provided LatLng information.
```

--------------------------------

### PropertyInfo

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Specifies details of how a property is to be displayed.

```APIDOC
## Interface: PropertyInfo

### Description
Species details of how a property is to be displayed.
```

--------------------------------

### join

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Adds all the elements of an array separated by the specified separator string. This method is inherited from the Array.join method.

```APIDOC
## join(string)

### Description
Adds all the elements of an array separated by the specified separator string.

### Parameters
#### Path Parameters
* **separator** (string) - A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

### Returns
string

**Inherited From** Array.join
```

--------------------------------

### slice

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Returns a section of an array.

```APIDOC
## slice(number, number)

### Description
Returns a section of an array.

### Parameters 

start
    
number
The beginning of the specified portion of the array. 

end
    
number
The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

### Returns
number[]
**Inherited From** Array.slice
```

--------------------------------

### CompassControlOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The options for a CompassControl object.

```APIDOC
## Interface: CompassControlOptions

### Description
The options for a CompassControl object.
```

--------------------------------

### TrafficOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

The options for setting traffic on the map.

```APIDOC
## Interface: TrafficOptions

### Description
Contains options for configuring the display and behavior of traffic data overlays on the map.

### Usage
These options are used to enable, disable, or customize the visual representation of traffic conditions.
```

--------------------------------

### Core Map Class

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The main class for creating and controlling an interactive web map.

```APIDOC
## Core Map Class

### Description
The main class for creating and controlling an interactive web map.

### Class
- **Map**: The control for a visual and interactive web map.
```

--------------------------------

### Data and Source Management

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Classes for managing data sources and different types of data sources for the map.

```APIDOC
## Data and Source Management

### Description
Classes for managing data sources and different types of data sources for the map.

### Classes
- **DataSource**: A data source class that makes it easy to manage shapes data that will be displayed on the map. A data source must be added to a layer before it is visible on the map. The DataSource class may be used with the SymbolLayer, LineLayer, PolygonLayer, BubbleLayer, and HeatMapLayer.
- **ElevationTileSource**: Elevation tile source describes how to access elevation (raster DEM) tile data. It can then be used to enable map elevation via `map.enableElevation(elevationSource)`.
- **Source**: A base abstract class in which all other source objects extend. A source must be added to a layer before it is visible on the map.
- **VectorTileSource**: A vector tile source describes how to access a vector tile layer. Vector tile sources can be used with; SymbolLayer, LineLayer, PolygonLayer, BubbleLayer, HeatmapLayer and VectorTileLayer.
```

--------------------------------

### SymbolLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Options used when rendering geometries in a SymbolLayer.

```APIDOC
## Interface: SymbolLayerOptions

### Description
Contains options for configuring how symbols (like icons and text labels) are rendered within a SymbolLayer on the map.

### Usage
These options are applied when creating or updating a SymbolLayer to control symbol appearance and placement.
```

--------------------------------

### MapConfiguration

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Represents the contents of a map configuration, holding a list of available styles.

```APIDOC
## Interface: MapConfiguration

### Description
Represents the contents of map configuration holding a list of styles available to them.
```

--------------------------------

### Construct ZoomControl

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.control.zoomcontrol

Constructs a new ZoomControl instance. Options can be provided to configure the control.

```typescript
new ZoomControl(options?: ZoomControlOptions)
```

--------------------------------

### PolygonExtrusionLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options used when rendering `Polygon` and `MultiPolygon` objects in a `PolygonExtrusionLayer`.

```APIDOC
## Interface: PolygonExtrusionLayerOptions

### Description
Options used when rendering `Polygon` and `MultiPolygon` objects in a `PolygonExtrusionLayer`.
```

--------------------------------

### EventArgs

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Event arguments object.

```APIDOC
## Interface: EventArgs

### Description
Event arguments object.
```

--------------------------------

### ZoomControlOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

The options for a ZoomControl object.

```APIDOC
## Interface: ZoomControlOptions

### Description
Specifies the configuration options for the Zoom Control, which provides buttons for users to zoom the map in and out.

### Usage
These options are passed during the initialization of a ZoomControl instance.
```

--------------------------------

### HeatMapLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options used when rendering Point objects in a HeatMapLayer.

```APIDOC
## Interface: HeatMapLayerOptions

### Description
Options used when rendering Point objects in a HeatMapLayer.
```

--------------------------------

### ServiceOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Global properties that can be applied to all Azure Maps service requests.

```APIDOC
## Interface: ServiceOptions

### Description
Contains global properties that affect all service requests made through the Azure Maps SDK, such as authentication credentials or endpoint configurations.

### Usage
These options can be set globally or per-request to configure service interactions.
```

--------------------------------

### reduce((previousValue, currentValue, currentIndex, array) => number, number)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Calls the specified callback function for all the elements in an array with an initial value. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. This overload is inherited from Array.reduce.

```APIDOC
## reduce((previousValue, currentValue, currentIndex, array) => number, initialValue: number)

### Description
Calls the specified callback function for all the elements in an array with an initial value.

### Signature
```typescript
function reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number
```

### Parameters

*   **callbackfn** (function) - A function that accepts up to four arguments.
*   **initialValue** (number) - The initial value to start the accumulation.

### Returns
number - The value that results from the reduction.

### Inherited From
Array.reduce
```

--------------------------------

### PolygonLayerOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Options used when rendering Polygon and MultiPolygon objects in a PolygonLayer.

```APIDOC
## Interface: PolygonLayerOptions

### Description
Options used when rendering Polygon and MultiPolygon objects in a PolygonLayer.
```

--------------------------------

### VectorTileSourceOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Options for a `VectorTileSource`, a data source for managing shape data displayed on the map.

```APIDOC
## Interface: VectorTileSourceOptions

### Description
Provides options for configuring a `VectorTileSource`, which is used to manage and display vector-based shape data on the map. A data source must be added to a layer to become visible.

### Usage
These options are used when creating a `VectorTileSource` instance.
```

--------------------------------

### map<U>

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Calls a defined callback function on each element of an array, and returns an array that contains the results. This method is inherited from the Array.map method.

```APIDOC
## map<U>

### Description
Calls a defined callback function on each element of an array, and returns an array that contains the results.

### Signature
```typescript
function map<U>(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any): U[]
```

### Parameters

*   **callbackfn** (function) - A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
*   **thisArg** (any, optional) - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

### Returns
U[] - An array containing the results of the callback function applied to each element.

### Inherited From
Array.map
```

--------------------------------

### HyperLinkFormatOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Format option for hyperlink strings.

```APIDOC
## Interface: HyperLinkFormatOptions

### Description
Format option for hyperlink strings.
```

--------------------------------

### Perform Action for Each Array Element

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Performs a specified action for each element in an array using a callback function. Inherited from Array.forEach.

```typescript
function forEach(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any)
```

--------------------------------

### ZoomControl Constructor

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.control.zoomcontrol

Constructs a new instance of the ZoomControl class. It accepts optional ZoomControlOptions to configure the control's behavior.

```APIDOC
## new ZoomControl(options?: ZoomControlOptions)

### Description
Constructs a ZoomControl.

### Parameters
#### Parameters
- **options** (ZoomControlOptions) - Optional - The options for the control.
```

--------------------------------

### Position.fromLatLng

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Generates a Position object from latitude and longitude values, or from various object formats containing coordinate information.

```APIDOC
## fromLatLng(latitude: number, longitude: number, elevation?: number)

### Description
Generates a Position object from latitude and longitude values.

### Parameters
* **latitude** (number) - The latitude.
* **longitude** (number) - The longitude.
* **elevation** (number) - Optional. The elevation.
```

```APIDOC
## fromLatLng(coordinates: number[])

### Description
Generates a Position object from an array that has the format; [lat, lng] or [lat, lng, elv].

### Parameters
* **coordinates** (Array<number>) - An array containing latitude, longitude, and optional elevation.
```

```APIDOC
## fromLatLng(coordinateObject: object)

### Description
Generates a Position object from an object that contains coordinate information. The object is scanned for the following properties using a case insensitive test: Longitude: lng, longitude, lon, x; Latitude: lat, latitude, y; Elevation: elv, elevation, alt, altitude, z.

### Parameters
* **coordinateObject** (object) - An object containing coordinate properties.
```

--------------------------------

### WebGLRenderer

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Interface for rendering WebGL graphics in a WebGLLayer.

```APIDOC
## Interface: WebGLRenderer

### Description
Defines the interface for objects responsible for rendering graphics using WebGL within the context of a `WebGLLayer`.

### Usage
This interface is implemented by custom renderers used with `WebGLLayer`.
```

--------------------------------

### some

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Determines whether the specified callback function returns true for any element of an array.

```APIDOC
## some((value: number, index: number, array: number[]) => unknown, any)

### Description
Determines whether the specified callback function returns true for any element of an array.

### Parameters 

callbackfn
    
(value: number, index: number, array: number[]) => unknown
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in the array until the callbackfn returns a value which is coercible to the Boolean value true, or until the end of the array. 

thisArg
    
any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

### Returns
boolean
**Inherited From** Array.some
```

--------------------------------

### Initialize ZoomControl on Map

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.control.zoomcontrol

The initialization method for the ZoomControl, called when the control is added to the map. It returns an HTMLElement to be placed on the map.

```typescript
function onAdd(map: Map): HTMLElement
```

--------------------------------

### reverse

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Reverses the elements in an Array.

```APIDOC
## reverse()

### Description
Reverses the elements in an Array.

### Returns
number[]
**Inherited From** Array.reverse
```

--------------------------------

### StyleControl

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

A control for changing the style of the map.

```APIDOC
## StyleControl

### Description
A control for changing the style of the map.

### Class
StyleControl
```

--------------------------------

### reduce((previousValue, currentValue, currentIndex, array) => number)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. This overload is inherited from Array.reduce.

```APIDOC
## reduce((previousValue, currentValue, currentIndex, array) => number)

### Description
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

### Signature
```typescript
function reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number
```

### Parameters

*   **callbackfn** (function) - A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

### Returns
number - The value that results from the reduction.

### Inherited From
Array.reduce
```

--------------------------------

### ClusteredProperties

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The properties which will exist for ClusteredProperties.

```APIDOC
## Interface: ClusteredProperties

### Description
The properties which will exist for ClusteredProperties.
```

--------------------------------

### fromLatLngs

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Converts an array of coordinate objects or arrays into an array of Position objects.

```APIDOC
## fromLatLngs(latLngs)

### Description
Converts an array of objects that contain coordinate information into an array of Positions. Objects that can't be converted are discarded. Each object is either an array in the format; [lat, lng] or [lat, lng, elv], or an object with the any combination of the following properties: Longitude: lng, longitude, lon, x Latitude: lat, latitude, y Elevation: elv, elevation, alt, altitude, z

### Parameters

- **latLngs** (Array<object | number[]>) - Required - The objects that contain coordinate information.

### Returns
Position[] - An array of Position objects that contain all the provided coordinate information.
```

--------------------------------

### reduce<U>((previousValue, currentValue, currentIndex, array) => U, U)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Calls the specified callback function for all the elements in an array with a specified initial value type. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. This overload is inherited from Array.reduce.

```APIDOC
## reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U)

### Description
Calls the specified callback function for all the elements in an array with a specified initial value type. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

### Signature
```typescript
function reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U
```

### Parameters

*   **callbackfn** (function) - A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
*   **initialValue** (U) - If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

### Returns
U - The value that results from the reduction.

### Inherited From
Array.reduce
```

--------------------------------

### every

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Determines whether all the members of an array satisfy the specified test. This method is inherited from the Array.every method.

```APIDOC
## every((value: number, index: number, array: number[]) => unknown, any)

### Description
Determines whether all the members of an array satisfy the specified test.

### Parameters
#### Path Parameters
* **callbackfn** (value: number, index: number, array: number[]) => unknown - A function that accepts up to three arguments. The every method calls the callbackfn function for each element in the array until the callbackfn returns a value which is coercible to the Boolean value false, or until the end of the array.
* **thisArg** (any) - An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

### Returns
boolean

**Inherited From** Array.every
```

--------------------------------

### Map Layers

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Classes for rendering various types of data on the map, including bubbles, heatmaps, images, lines, polygons, and symbols.

```APIDOC
## Map Layers

### Description
Classes for rendering various types of data on the map, including bubbles, heatmaps, images, lines, polygons, and symbols.

### Classes
- **BubbleLayer**: Renders Point objects as scalable circles (bubbles).
- **HeatMapLayer**: Represent the density of data using different colors (HeatMap).
- **ImageLayer**: Overlays an image on the map with each corner anchored to a coordinate on the map. Also known as a ground or image overlay.
- **Layer**: Abstract class for other layer classes to extend.
- **LineLayer**: Renders line data on the map. Can be used with SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon, and MultiPolygon objects.
- **PolygonExtrusionLayer**: Renders extruded filled `Polygon` and `MultiPolygon` objects on the map.
- **PolygonLayer**: Renders filled Polygon and MultiPolygon objects on the map.
- **SymbolLayer**: Renders point based data as symbols on the map using text and/or icons. Symbols can also be created for line and polygon data as well.
- **TileLayer**: Renders raster tiled images on top of the map tiles.
- **WebGLLayer**: Enables custom rendering logic with access to the WebGL context of the map.
```

--------------------------------

### StyleControlEvents

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The events supported by the `StyleControl`.

```APIDOC
## Interface: StyleControlEvents

### Description
The events supported by the `StyleControl`.
```

--------------------------------

### StyleOverrides

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

Allows overriding the default styles for map elements.

```APIDOC
## Interface: StyleOverrides

### Description
Provides a mechanism to override the default styling of specific map elements, enabling fine-grained visual customization.

### Usage
This interface is used to define custom styles that take precedence over the map's default style rules.
```

--------------------------------

### sort

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Sorts an array.

```APIDOC
## sort((a: number, b: number) => number)

### Description
Sorts an array.

### Parameters 

compareFn
    
(a: number, b: number) => number
Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

### Returns
this
**Inherited From** Array.sort
```

--------------------------------

### reduceRight((previousValue, currentValue, currentIndex, array) => number, number)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Calls the specified callback function for all the elements in an array, in descending order, with an initial value. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. This overload is inherited from Array.reduceRight.

```APIDOC
## reduceRight((previousValue, currentValue, currentIndex, array) => number, initialValue: number)

### Description
Calls the specified callback function for all the elements in an array, in descending order, with an initial value.

### Signature
```typescript
function reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number
```

### Parameters

*   **callbackfn** (function) - A function that accepts up to four arguments.
*   **initialValue** (number) - The initial value to start the accumulation.

### Returns
number - The value that results from the reduction.

### Inherited From
Array.reduceRight
```

--------------------------------

### Control

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

An interface for defining a control of the map.

```APIDOC
## Interface: Control

### Description
An interface for defining a control of the map.
```

--------------------------------

### Build Control Container

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.control.zoomcontrol

Builds the outermost container for a control, applying styling and setting up listeners for auto-styling. This method is inherited from ControlBase.

```typescript
function buildContainer<K>(map: Map, style: ControlStyle, ariaLabel?: string, tagName?: K): HTMLElementTagNameMap[K]
```

--------------------------------

### HtmlMarkerEvents

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Events associated with HtmlMarker objects.

```APIDOC
## Interface: HtmlMarkerEvents

### Description
Events associated with HtmlMarker objects.
```

--------------------------------

### reduceRight

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

```APIDOC
## reduceRight<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, U)

### Description
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

### Parameters 

callbackfn
    
(previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. 

initialValue
    
U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

### Returns
U
**Inherited From** Array.reduceRight
```

--------------------------------

### TrafficControlOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

The options for a TrafficControl object.

```APIDOC
## Interface: TrafficControlOptions

### Description
Specifies the configuration options for the Traffic Control, which allows users to view and interact with traffic information on the map.

### Usage
These options are passed when initializing a TrafficControl instance.
```

--------------------------------

### Create an array of Positions from coordinate data

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Converts an array of coordinate data, which can be either number arrays ([lat, lng] or [lat, lng, elv]) or objects with coordinate properties, into an array of Position objects. Invalid entries are discarded.

```TypeScript
static function fromLatLngs(latLngs: Array<object | number[]>): Position[]
```

--------------------------------

### getMap()

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.layer.webgllayer

Returns the map instance to which this layer is currently attached, or null if it has not been added to a map.

```APIDOC
## getMap()

### Description
Gets the map that the layer is currently added to, or null.

### Returns
- **Map**: The Map instance the layer is on, or null.

### TypeScript Signature
```typescript
function getMap(): Map
```

### Inherited From
Layer.getMap
```

--------------------------------

### MapElementStyles

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

The style of the map element.

```APIDOC
## Interface: MapElementStyles

### Description
The style of the map element.
```

--------------------------------

### reduceRight((previousValue, currentValue, currentIndex, array) => number)

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. This overload is inherited from Array.reduceRight.

```APIDOC
## reduceRight((previousValue, currentValue, currentIndex, array) => number)

### Description
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

### Signature
```typescript
function reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number
```

### Parameters

*   **callbackfn** (function) - A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

### Returns
number - The value that results from the reduction.

### Inherited From
Array.reduceRight
```

--------------------------------

### DataSourceOptions

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

A data source for managing shape data that will be displayed on the map. A data source must be added to a layer before it is visible on the map. Options for a `DataSourceOptions`.

```APIDOC
## Interface: DataSourceOptions

### Description
A data source for managing shape data that will be displayed on the map. A data source must be added to a layer before it is visible on the map. Options for a `DataSourceOptions`.
```

--------------------------------

### Position.fromLatLngs

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Converts an array of coordinate objects or arrays into an array of Position objects, discarding any invalid entries.

```APIDOC
## fromLatLngs(coordinates: Array<object | number[]>)

### Description
Converts an array of objects that contain coordinate information into an array of Positions. Objects that can't be converted are discarded. Each object is either an array in the format; [lat, lng] or [lat, lng, elv], or an object with the any combination of the following properties: Longitude: lng, longitude, lon, x; Latitude: lat, latitude, y; Elevation: elv, elevation, alt, altitude, z.

### Parameters
* **coordinates** (Array<object | number[]>) - An array of coordinate data.
```

--------------------------------

### PitchControl

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

A control for changing the pitch of the map.

```APIDOC
## PitchControl

### Description
A control for changing the pitch of the map.

### Class
PitchControl
```

--------------------------------

### ScaleControl

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/?view=azure-maps-typescript-latest

A control to display a scale bar on the map.

```APIDOC
## ScaleControl

### Description
A control to display a scale bar on the map.

### Class
ScaleControl
```

--------------------------------

### MapMouseEvent

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

Event object returned by the maps when a mouse event occurs.

```APIDOC
## Interface: MapMouseEvent

### Description
Event object returned by the maps when a mouse event occurs.
```

--------------------------------

### PopupManager

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control

A manager for the map control's popups, exposed through the `popups` property of the `atlas.Map` class. This cannot be instantiated by the user.

```APIDOC
## Interface: PopupManager

### Description
A manager for the map control's popups. Exposed through the `popups` property of the `atlas.Map` class. Cannot be instantiated by the user.
```

--------------------------------

### Construct a Position object

Source: https://learn.microsoft.com/en-us/javascript/api/azure-maps-control/atlas.data.position

Creates a new Position object with specified longitude, latitude, and optional elevation.

```TypeScript
new Position(longitude: number, latitude: number, elevation?: number)
```
Tokens:
Raw