AzureMapsControl.Components 1.16.1

dotnet add package AzureMapsControl.Components --version 1.16.1
NuGet\Install-Package AzureMapsControl.Components -Version 1.16.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AzureMapsControl.Components" Version="1.16.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AzureMapsControl.Components --version 1.16.1
#r "nuget: AzureMapsControl.Components, 1.16.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AzureMapsControl.Components as a Cake Addin
#addin nuget:?package=AzureMapsControl.Components&version=1.16.1

// Install AzureMapsControl.Components as a Cake Tool
#tool nuget:?package=AzureMapsControl.Components&version=1.16.1

Nuget Nuget (with prereleases) Build Unit Test release codecov Slack

This library allows you to use Azure Maps inside your razor application.

Custom Azure Map

Install the Nuget Package

This library is available on Nuget as AzureMapsControl.Components.

Setup

Add the css and scripts

You will need to add the atlas script and css files as well as the script generated by the library on your application.

<link href="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.css" rel="stylesheet" />
<script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.js"></script>
<script src="_content/AzureMapsControl.Components/azure-maps-control.js"></script>

Or use the minimized version :

<script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.js"></script>
<script src="_content/AzureMapsControl.Components/azure-maps-control.min.js"></script>

Register the Components

You will need to pass the authentication information of your AzureMaps instance to the library. SubscriptionKey, Aad and Anonymous authentication are supported. You will need to call the AddAzureMapsControl method on your services.

You can authenticate using a subscription key :

    // This method gets called by the runtime. Use this method to add services to the container.
    // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddRazorPages();
        services.AddServerSideBlazor();
        
        services.AddAzureMapsControl(configuration => configuration.SubscriptionKey = "Your Subscription Key");
    }

Or using Azure Active Directory:

public void ConfigureServices(IServiceCollection services)
        {
            services.AddRazorPages();
            services.AddServerSideBlazor(options => options.DetailedErrors = true);

            services.AddAzureMapsControl(configuration => {
                configuration.AadAppId = "Your Aad App Id";
                configuration.AadTenant = "Your Aad Tenant";
                configuration.ClientId = "Your Client Id";
            });
        }

The Anonymous authentication requires only a ClientId:

public void ConfigureServices(IServiceCollection services)
        {
            services.AddRazorPages();
            services.AddServerSideBlazor(options => options.DetailedErrors = true);

            services.AddAzureMapsControl(configuration => configuration.ClientId = Configuration["AzureMaps:ClientId"])
        }

It also needs to fetch the token to send to the requests of the atlas library. For that, you have to override the azureMapsControl.Extensions.getTokenCallback method on your application after referencing azure-maps-control.min.js and resolve the token in it. For example :

@page "/"
@namespace AzureMapsControl.Sample.Pages
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
@{
    Layout = null;
}

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>AzureMapsControl.Sample</title>
    <base href="~/" />
    <link rel="stylesheet" href="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.css" type="text/css" />
    <link rel="stylesheet" href="https://atlas.microsoft.com/sdk/javascript/drawing/0.1/atlas-drawing.min.css" type="text/css" />
    <style>
        body {
            margin: 0;
        }

        #map {
            position: absolute;
            width: 100%;
            min-width: 290px;
            height: 100%;
        }
    </style>
</head>
<body>
    <app>
        <component type="typeof(App)" render-mode="ServerPrerendered" />
    </app>
    <script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/3/atlas.min.js"></script>
    <script src="https://atlas.microsoft.com/sdk/javascript/drawing/0.1/atlas-drawing.min.js"></script>
    <script src="_content/AzureMapsControl.Components/azure-maps-control.min.js"></script>
    <script src="_framework/blazor.server.js"></script>
    <script type="text/javascript">
        azureMapsControl.Extensions.getTokenCallback = (resolve, reject, map) => {
            const url = "url_of_my_token_endpoint";
            fetch(url).then(function (response) {
                return response.text();
            }).then(function (token) {
                resolve(token);
            });        
        };
    </script>
</body>
</html>

How to use

Want to contribute ?

Contributions are welcome! One of the best way to start is to take a look at the list of issues where help is wanted.

If you need a new feature which is not listed on the issues, feel free to open a new one. Take also a look at the Contributing guidelines.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.16.1 121 6/18/2024
1.16.0 107 6/14/2024
1.16.0-alpha0003 67 6/14/2024
1.16.0-alpha0001 191 3/27/2024
1.15.0 3,021 3/12/2024
1.15.0-alpha0002 71 3/12/2024
1.14.1 382 2/28/2024
1.14.0 938 12/22/2023
1.14.0-alpha0015 89 12/22/2023
1.13.0 21,219 9/14/2022
1.13.0-alpha0001 216 9/13/2022
1.12.0 3,063 8/3/2022
1.12.0-alpha0038 126 8/3/2022
1.12.0-alpha0028 149 7/8/2022
1.12.0-alpha0019 126 7/7/2022
1.12.0-alpha0011 130 6/14/2022
1.12.0-alpha0004 205 2/2/2022
1.12.0-alpha0003 145 2/2/2022
1.11.0 8,269 11/12/2021
1.11.0-alpha0015 196 11/12/2021
1.10.0 332 11/8/2021
1.10.0-net60-alpha0001 157 10/19/2021
1.10.0-alpha0010 184 11/8/2021
1.9.0 1,296 8/4/2021
1.9.0-alpha0006 281 8/4/2021
1.8.3 984 7/14/2021
1.8.3-beta0001 243 7/14/2021
1.8.2 412 7/13/2021
1.8.2-beta0001 265 7/13/2021
1.8.1 523 6/25/2021
1.8.1-beta0001 290 6/25/2021
1.8.0 382 6/19/2021
1.8.0-html-marker-laye0001 260 6/8/2021
1.8.0-alpha0003 260 6/19/2021
1.7.1 492 6/8/2021
1.7.1-beta0001 253 6/3/2021
1.7.0 473 5/31/2021
1.7.0-alpha0014 274 5/31/2021
1.7.0-alpha0004 239 5/18/2021
1.7.0-alpha0001 244 5/13/2021
1.6.1 538 5/18/2021
1.6.1-beta0001 244 5/18/2021
1.6.0 413 5/7/2021
1.6.0-alpha0050 267 5/7/2021
1.6.0-alpha0031 290 5/7/2021
1.6.0-alpha0015 263 5/7/2021
1.5.2 380 5/6/2021
1.5.2-beta0001 285 5/6/2021
1.5.1 622 4/30/2021
1.5.1-beta0001 232 4/30/2021
1.5.0 389 4/26/2021
1.5.0-alpha0016 250 4/23/2021
1.4.0 360 4/23/2021
1.4.0-alpha0005 248 4/20/2021
1.3.0 413 4/19/2021
1.3.0-beta0003 275 4/17/2021
1.3.0-beta0002 252 4/17/2021
1.3.0-beta0001 266 4/17/2021
1.3.0-alpha0001 245 4/16/2021
1.2.0 348 4/15/2021
1.2.0-alpha0004 218 4/15/2021
1.1.0 396 4/13/2021
1.1.0-alpha0015 220 4/13/2021
1.0.0 431 4/9/2021
1.0.0-beta0008 253 3/26/2021
1.0.0-beta0007 260 3/24/2021
1.0.0-beta0006 275 3/23/2021
1.0.0-beta0005 270 3/22/2021
1.0.0-beta0004 261 3/19/2021
1.0.0-beta0003 243 3/19/2021
1.0.0-beta0002 260 3/19/2021
1.0.0-beta0001 245 3/19/2021
0.17.1 344 4/6/2021
0.17.1-beta0001 231 4/5/2021
0.17.0 410 3/24/2021
0.16.0 361 3/23/2021
0.15.0 579 3/8/2021
0.15.0-alpha0038 274 3/8/2021
0.14.0 389 3/5/2021
0.14.0-alpha0003 232 3/5/2021
0.13.0 392 3/3/2021
0.13.0-alpha0001 243 3/3/2021
0.12.0 472 2/18/2021
0.12.0-typescript0001 252 2/18/2021
0.12.0-publish-typescri0001 244 2/18/2021
0.12.0-alpha0018 233 2/18/2021
0.11.0 382 2/17/2021
0.11.0-alpha0003 225 2/17/2021
0.10.1 376 2/15/2021
0.10.0 354 2/15/2021
0.10.0-alpha0011 217 2/15/2021
0.10.0-alpha0005 228 2/15/2021
0.9.0 421 1/24/2021
0.9.0-alpha0013 304 1/24/2021
0.9.0-alpha0006 291 1/3/2021
0.9.0-alpha0003 281 12/8/2020
0.8.1 433 1/3/2021
0.8.0 510 12/8/2020
0.8.0-beta0001 257 12/8/2020
0.8.0-alpha0005 296 11/25/2020
0.7.1 441 11/25/2020
0.7.0 424 11/25/2020
0.7.0-beta0001 295 11/25/2020
0.7.0-alpha0002 279 11/24/2020
0.6.0-beta0001 314 11/24/2020
0.6.0-alpha0005 294 11/24/2020
0.6.0-alpha0001 284 11/23/2020
0.5.2 1,651 11/24/2020
0.5.1 419 11/23/2020
0.5.0 398 11/19/2020
0.4.0 409 11/12/2020
0.3.0-beta0001 315 11/12/2020
0.3.0-alpha0019 262 11/19/2020
0.3.0-alpha0010 302 11/12/2020
0.3.0-alpha0004 307 11/12/2020
0.2.0 416 11/12/2020
0.2.0-beta0003 333 11/12/2020
0.2.0-beta0002 322 11/12/2020
0.2.0-beta0001 308 11/11/2020
0.1.0 470 11/11/2020
0.1.0-beta0002 319 11/11/2020
0.1.0-beta0001 314 11/11/2020
0.1.0-alpha0236 341 11/11/2020
0.1.0-alpha0116 303 11/11/2020
0.1.0-alpha0112 319 11/11/2020
0.1.0-alpha0097 320 11/11/2020
0.1.0-alpha0091 320 11/11/2020
0.1.0-alpha0090 325 11/10/2020
0.1.0-alpha0089 330 11/10/2020
0.1.0-alpha0088 340 11/10/2020
0.1.0-alpha0087 347 11/10/2020
0.1.0-alpha0086 334 11/10/2020
0.1.0-alpha0085 349 11/10/2020
0.1.0-alpha0084 331 11/10/2020
0.1.0-alpha0083 332 11/10/2020
0.1.0-alpha0082 381 11/9/2020
0.1.0-alpha0081 387 11/9/2020
0.1.0-alpha0080 385 11/9/2020
0.1.0-alpha0079 343 11/7/2020
0.1.0-alpha0077 514 11/6/2020
0.1.0-alpha0076 502 11/6/2020
0.1.0-alpha0074 415 11/6/2020
0.1.0-alpha0071 350 11/6/2020
0.0.1-ci-20201106.2 277 11/6/2020
0.0.1-ci-20201106.1 237 11/6/2020
0.0.1-ci-20201105.7 277 11/5/2020
0.0.1-ci-20201105.6 290 11/5/2020
0.0.1-ci-20201105.5 295 11/5/2020
0.0.1-ci-20201105.4 288 11/5/2020
0.0.1-ci-20201105.3 231 11/5/2020
0.0.1-ci-20201105.2 243 11/5/2020
0.0.1-ci-20201105.1 227 11/5/2020
0.0.1-ci-20201104.2 237 11/4/2020
0.0.1-ci-20201104.1 249 11/4/2020
0.0.1-ci-20201030.5 243 10/30/2020
0.0.1-ci-20201030.4 251 10/30/2020
0.0.1-ci-20201030.3 265 10/30/2020
0.0.1-ci-20201030.2 247 10/30/2020
0.0.1-ci-20201030.1 231 10/30/2020
0.0.1-ci-20201029.3 234 10/29/2020
0.0.1-ci-20201029.2 259 10/29/2020
0.0.1-ci-20201029.1 244 10/29/2020
0.0.1-ci-20201028.1 228 10/28/2020
0.0.1-ci-20201027.1 245 10/27/2020
0.0.1-ci-20201026.2 275 10/26/2020
0.0.1-ci-20201026.1 219 10/26/2020
0.0.1-ci-20201023.2 271 10/23/2020
0.0.1-ci-20201023.1 251 10/23/2020
0.0.1-ci-20201022.1 243 10/22/2020
0.0.1-ci-20201008.1 227 10/8/2020
0.0.1-ci-20201005.1 277 10/5/2020
0.0.1-ci-20200407.1 279 4/7/2020
0.0.1-ci-20200406.3 283 4/6/2020
0.0.1-ci-20200406.2 293 4/6/2020
0.0.1-ci-20200406.1 296 4/6/2020
0.0.1-ci-20200403.5 281 4/3/2020
0.0.1-ci-20200403.4 290 4/3/2020
0.0.1-ci-20200403.3 300 4/3/2020
0.0.1-ci-20200403.2 286 4/3/2020
0.0.1-ci-20200403.1 286 4/3/2020
0.0.1-ci-20200402.2 288 4/2/2020
0.0.1-ci-20200402.1 311 4/2/2020