Class

AzureMapProvider

Initializes a new instance of the AzureMapProvider class with default settings and configures the Azure tile downloader.

Declaration

public AzureMapProvider()

Declaration

protected Dictionary<string, List<TileInfo>> cacheLoadReference

Field Value

Declaration

protected object lockObj

Field Value

Declaration

protected Dictionary<string, TileInfo> tileMatrix

Field Value

Gets or sets the Azure Maps subscription key used for API authentication and service access.

Declaration

public string AzureAPIKey { get; set; }

Property Value

Gets or sets the Azure Maps REST API version string used for service requests and feature compatibility.

Declaration

public string AzureAPIVersion { get; set; }

Property Value

Gets or sets the cache provider instance used for storing and retrieving map tiles from local storage.

Declaration

public IMapCacheProvider CacheProvider { get; set; }

Property Value

Implements IMapTileProvider.CacheProvider

Gets or sets a value indicating whether tile caching is enabled for storing downloaded tiles locally to improve performance.

Declaration

public bool EnableCaching { get; set; }

Property Value

Implements IMapTileProvider.EnableCaching

Gets the unique identifier for this Azure Maps provider instance.

Declaration

public string Id { get; }

Property Value

Implements IMapProvider.Id

Gets or sets a value indicating whether this AzureMapProvider has completed initialization and is ready for use.

Declaration

public bool Initialized { get; protected set; }

Property Value

Gets or sets a value indicating whether this AzureMapProvider is currently performing initialization operations.

Declaration

public bool Initializing { get; protected set; }

Property Value

Gets or sets the culture information used for localizing Azure Maps tiles, search results, and service responses.

Declaration

public CultureInfo LanguageCulture { get; set; }

Property Value

Gets or sets the maximum zoom level supported by this Azure Maps provider for tile requests and map display.

Declaration

public int MaxZoomLevel { get; set; }

Property Value

Implements IMapProvider.MaxZoomLevel

Gets or sets the minimum zoom level supported by this Azure Maps provider for tile requests and map display.

Declaration

public int MinZoomLevel { get; set; }

Property Value

Implements IMapProvider.MinZoomLevel

Gets the settings that control tile rendering behavior.

Declaration

public MapTileProviderSettings Settings { get; }

Property Value

Implements IMapTileProvider.Settings

Gets or sets the tile downloader instance responsible for asynchronously downloading map tiles from Azure Maps service.

Declaration

public IMapTileDownloader TileDownloader { get; set; }

Property Value

Implements IMapTileProvider.TileDownloader

Gets or sets the Azure Maps tile set type that determines the visual style and content of map tiles.

Declaration

public AzureTileSet TileSetID { get; set; }

Property Value

Gets the standard tile size in pixels used by this Azure Maps provider for all tile requests and rendering operations.

Declaration

public Size TileSize { get; }

Property Value

Implements IMapTileProvider.TileSize

Constructs the Azure Maps search request URI based on the search request parameters and selected search mode.

Declaration

protected virtual Uri BuildAzureSearchRequestUri(AzureSearchRequest request)

Parameters

Returns

Creates a deep copy of this AzureMapProvider instance with all configuration settings and state information.

Declaration

public object Clone()

Returns

Implements ICloneable.Clone()

Generates a unique cache key string for storing and retrieving tile images based on coordinates, zoom level, and tile set identifier.

Declaration

protected virtual string GetCacheKey(int tileX, int tileY, int zoomLevel)

Parameters

Returns

Generates map visual elements for the specified viewport by converting cached tile images into renderable map tile elements.

Declaration

public IEnumerable<MapVisualElement> GetContent(IMapViewport viewport)

Parameters

Returns

Implements IMapProvider.GetContent(IMapViewport)

Retrieves a list of supported map views based on available Azure tile sets with selection state information.

Declaration

public virtual List<MapViewInfo> GetSupportedViews()

Returns

Implements IMapProvider.GetSupportedViews()

Constructs the URI for retrieving a specific map tile from Azure Maps service using tile matrix coordinates and zoom level.

Declaration

public Uri GetTile(int tileMatrixX, int tileMatrixY, int zoomLevel)

Parameters

Returns

Synchronously retrieves a tile image from Azure Maps service or cache using the specified tile matrix coordinates and zoom level.

Declaration

public Image GetTileImage(int tileMatrixX, int tileMatrixY, int zoomLevel)

Parameters

Returns

Implements IMapTileProvider.GetTileImage(int, int, int)

Retrieves the tile image for the specified TileInfo either from cache or by downloading from Azure Maps service.

Declaration

protected virtual void GetTileInfoImage(TileInfo tileInfo)

Parameters

Initializes the Azure Maps provider by verifying service connectivity and preparing the tile matrix for use.

Declaration

public void Initialize()

Implements IMapProvider.Initialize()

Handles the completion of asynchronous file loading from cache and initiates tile download if cache content is unavailable.

Declaration

protected virtual void OnFileLoadAsyncComplete(string fileName, byte[] content)

Parameters

Raises the InitializationComplete event to notify subscribers that provider initialization has finished.

Declaration

protected virtual void OnInitializationComplete(EventArgs e)

Parameters

Raises the InitializationError event to notify subscribers that provider initialization has failed.

Declaration

protected virtual void OnInitializationError(InitializationErrorEventArgs e)

Parameters

Raises the ProviderUpdated event to notify subscribers that provider content has changed.

Declaration

protected virtual void OnProviderUpdated(EventArgs e)

Parameters

Raises the SearchCompleted event to notify subscribers that a search operation has finished successfully.

Declaration

protected virtual void OnSearchCompleted(AzureSearchCompletedEventArgs e)

Parameters

Raises the SearchError event to notify subscribers that a search operation has encountered an error.

Declaration

protected virtual void OnSearchError(SearchErrorEventArgs e)

Parameters

Handles tile download completion events, manages cache storage, and updates wraparound tiles with downloaded content.

Declaration

protected virtual void OnTileDownloadComplete(object sender, TileInfoEventArgs e)

Parameters

Performs an asynchronous search operation using Azure Maps search services with the specified search request parameters.

Declaration

public void SearchAsync(AzureSearchRequest request)

Parameters

Implements IAzureMapSearchProvider.SearchAsync(AzureSearchRequest)

Processes the JSON search result response from Azure Maps service and deserializes it using multiple encoding strategies.

Declaration

protected virtual void SearchRequest(string searchResult)

Parameters

Sets the active map view by configuring the tile set identifier based on the specified view information.

Declaration

public void SetView(MapViewInfo view)

Parameters

Implements IMapProvider.SetView(MapViewInfo)

Responds to viewport changes by calculating visible tiles, managing tile downloads, and updating the tile matrix for rendering.

Declaration

public void ViewportChanged(IMapViewport viewport, ViewportChangeAction action)

Parameters

Implements IMapProvider.ViewportChanged(IMapViewport, ViewportChangeAction)

Occurs when the Azure Maps provider has completed its initialization process and is ready for use.

Declaration

public event EventHandler InitializationComplete

Event Value

Implements IMapProvider.InitializationComplete

Occurs when provider initialization encounters an error during setup.

Declaration

public event InitializationErrorEventHandler InitializationError

Event Value

Implements IMapProvider.InitializationError

Occurs when the provider content has been updated with new tile data or configuration changes.

Declaration

public event EventHandler ProviderUpdated

Event Value

Implements IMapProvider.ProviderUpdated

Occurs when an Azure Maps search operation has completed successfully with search results.

Declaration

public event EventHandler<AzureSearchCompletedEventArgs> SearchCompleted

Event Value

Implements IAzureMapSearchProvider.SearchCompleted

Occurs when a search operation encounters an error during execution.

Declaration

public event EventHandler<SearchErrorEventArgs> SearchError

Event Value

Implements IAzureMapSearchProvider.SearchError