AzureMapsControl.Components 1.16.1

There is a newer prerelease version of this package available.
See the version list below for details.
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.
<PackageVersion Include="AzureMapsControl.Components" Version="1.16.1" />
                    
Directory.Packages.props
<PackageReference Include="AzureMapsControl.Components" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version 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.
#addin nuget:?package=AzureMapsControl.Components&version=1.16.1
                    
Install as a Cake Addin
#tool nuget:?package=AzureMapsControl.Components&version=1.16.1
                    
Install as a Cake Tool

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
2.0.0-net9.10 183 12/19/2024
2.0.0-net9.9 55 12/19/2024
2.0.0-net9.8 56 12/19/2024
2.0.0-net9.7 60 12/19/2024
2.0.0-net9.6 55 12/18/2024
2.0.0-net9.5 55 12/18/2024
2.0.0-net9.4 57 12/18/2024
2.0.0-net9.3 56 12/18/2024
2.0.0-net9.2 72 12/18/2024
1.16.1 22,014 6/18/2024
1.16.0 176 6/14/2024
1.16.0-alpha0003 113 6/14/2024
1.16.0-alpha0001 359 3/27/2024
1.15.0 6,434 3/12/2024
1.15.0-alpha0002 111 3/12/2024
1.14.1 479 2/28/2024
1.14.0 1,045 12/22/2023
1.14.0-alpha0015 129 12/22/2023
1.13.0 25,958 9/14/2022
1.13.0-alpha0001 279 9/13/2022
1.12.0 3,174 8/3/2022
1.12.0-alpha0038 201 8/3/2022
1.12.0-alpha0028 245 7/8/2022
1.12.0-alpha0019 196 7/7/2022
1.12.0-alpha0011 206 6/14/2022
1.12.0-alpha0004 284 2/2/2022
1.12.0-alpha0003 230 2/2/2022
1.11.0 9,202 11/12/2021
1.11.0-alpha0015 271 11/12/2021
1.10.0 417 11/8/2021
1.10.0-net60-alpha0001 218 10/19/2021
1.10.0-alpha0010 277 11/8/2021
1.9.0 1,395 8/4/2021
1.9.0-alpha0006 360 8/4/2021
1.8.3 1,066 7/14/2021
1.8.3-beta0001 319 7/14/2021
1.8.2 491 7/13/2021
1.8.2-beta0001 357 7/13/2021
1.8.1 609 6/25/2021
1.8.1-beta0001 365 6/25/2021
1.8.0 464 6/19/2021
1.8.0-html-marker-laye0001 335 6/8/2021
1.8.0-alpha0003 335 6/19/2021
1.7.1 582 6/8/2021
1.7.1-beta0001 330 6/3/2021
1.7.0 555 5/31/2021
1.7.0-alpha0014 355 5/31/2021
1.7.0-alpha0004 315 5/18/2021
1.7.0-alpha0001 321 5/13/2021
1.6.1 630 5/18/2021
1.6.1-beta0001 319 5/18/2021
1.6.0 510 5/7/2021
1.6.0-alpha0050 359 5/7/2021
1.6.0-alpha0031 371 5/7/2021
1.6.0-alpha0015 347 5/7/2021
1.5.2 469 5/6/2021
1.5.2-beta0001 362 5/6/2021
1.5.1 713 4/30/2021
1.5.1-beta0001 323 4/30/2021
1.5.0 481 4/26/2021
1.5.0-alpha0016 335 4/23/2021
1.4.0 451 4/23/2021
1.4.0-alpha0005 331 4/20/2021
1.3.0 508 4/19/2021
1.3.0-beta0003 359 4/17/2021
1.3.0-beta0002 335 4/17/2021
1.3.0-beta0001 347 4/17/2021
1.3.0-alpha0001 323 4/16/2021
1.2.0 440 4/15/2021
1.2.0-alpha0004 306 4/15/2021
1.1.0 504 4/13/2021
1.1.0-alpha0015 299 4/13/2021
1.0.0 540 4/9/2021
1.0.0-beta0008 338 3/26/2021
1.0.0-beta0007 344 3/24/2021
1.0.0-beta0006 353 3/23/2021
1.0.0-beta0005 353 3/22/2021
1.0.0-beta0004 350 3/19/2021
1.0.0-beta0003 346 3/19/2021
1.0.0-beta0002 346 3/19/2021
1.0.0-beta0001 331 3/19/2021
0.17.1 433 4/6/2021
0.17.1-beta0001 311 4/5/2021
0.17.0 496 3/24/2021
0.16.0 469 3/23/2021
0.15.0 672 3/8/2021
0.15.0-alpha0038 359 3/8/2021
0.14.0 477 3/5/2021
0.14.0-alpha0003 315 3/5/2021
0.13.0 490 3/3/2021
0.13.0-alpha0001 331 3/3/2021
0.12.0 565 2/18/2021
0.12.0-typescript0001 342 2/18/2021
0.12.0-publish-typescri0001 343 2/18/2021
0.12.0-alpha0018 326 2/18/2021
0.11.0 473 2/17/2021
0.11.0-alpha0003 310 2/17/2021
0.10.1 482 2/15/2021
0.10.0 443 2/15/2021
0.10.0-alpha0011 302 2/15/2021
0.10.0-alpha0005 313 2/15/2021
0.9.0 512 1/24/2021
0.9.0-alpha0013 408 1/24/2021
0.9.0-alpha0006 380 1/3/2021
0.9.0-alpha0003 368 12/8/2020
0.8.1 523 1/3/2021
0.8.0 602 12/8/2020
0.8.0-beta0001 343 12/8/2020
0.8.0-alpha0005 382 11/25/2020
0.7.1 537 11/25/2020
0.7.0 524 11/25/2020
0.7.0-beta0001 386 11/25/2020
0.7.0-alpha0002 372 11/24/2020
0.6.0-beta0001 398 11/24/2020
0.6.0-alpha0005 388 11/24/2020
0.6.0-alpha0001 370 11/23/2020
0.5.2 1,758 11/24/2020
0.5.1 509 11/23/2020
0.5.0 496 11/19/2020
0.4.0 506 11/12/2020
0.3.0-beta0001 411 11/12/2020
0.3.0-alpha0019 344 11/19/2020
0.3.0-alpha0010 384 11/12/2020
0.3.0-alpha0004 406 11/12/2020
0.2.0 508 11/12/2020
0.2.0-beta0003 447 11/12/2020
0.2.0-beta0002 411 11/12/2020
0.2.0-beta0001 392 11/11/2020
0.1.0 583 11/11/2020
0.1.0-beta0002 409 11/11/2020
0.1.0-beta0001 401 11/11/2020
0.1.0-alpha0236 433 11/11/2020
0.1.0-alpha0116 390 11/11/2020
0.1.0-alpha0112 405 11/11/2020
0.1.0-alpha0097 407 11/11/2020
0.1.0-alpha0091 423 11/11/2020
0.1.0-alpha0090 421 11/10/2020
0.1.0-alpha0089 417 11/10/2020
0.1.0-alpha0088 435 11/10/2020
0.1.0-alpha0087 432 11/10/2020
0.1.0-alpha0086 421 11/10/2020
0.1.0-alpha0085 437 11/10/2020
0.1.0-alpha0084 423 11/10/2020
0.1.0-alpha0083 414 11/10/2020
0.1.0-alpha0082 468 11/9/2020
0.1.0-alpha0081 475 11/9/2020
0.1.0-alpha0080 467 11/9/2020
0.1.0-alpha0079 431 11/7/2020
0.1.0-alpha0077 622 11/6/2020
0.1.0-alpha0076 586 11/6/2020
0.1.0-alpha0074 498 11/6/2020
0.1.0-alpha0071 441 11/6/2020
0.0.1-ci-20201106.2 353 11/6/2020
0.0.1-ci-20201106.1 310 11/6/2020
0.0.1-ci-20201105.7 351 11/5/2020
0.0.1-ci-20201105.6 361 11/5/2020
0.0.1-ci-20201105.5 367 11/5/2020
0.0.1-ci-20201105.4 357 11/5/2020
0.0.1-ci-20201105.3 310 11/5/2020
0.0.1-ci-20201105.2 315 11/5/2020
0.0.1-ci-20201105.1 302 11/5/2020
0.0.1-ci-20201104.2 312 11/4/2020
0.0.1-ci-20201104.1 321 11/4/2020
0.0.1-ci-20201030.5 314 10/30/2020
0.0.1-ci-20201030.4 325 10/30/2020
0.0.1-ci-20201030.3 336 10/30/2020
0.0.1-ci-20201030.2 330 10/30/2020
0.0.1-ci-20201030.1 307 10/30/2020
0.0.1-ci-20201029.3 313 10/29/2020
0.0.1-ci-20201029.2 333 10/29/2020
0.0.1-ci-20201029.1 315 10/29/2020
0.0.1-ci-20201028.1 298 10/28/2020
0.0.1-ci-20201027.1 315 10/27/2020
0.0.1-ci-20201026.2 345 10/26/2020
0.0.1-ci-20201026.1 291 10/26/2020
0.0.1-ci-20201023.2 349 10/23/2020
0.0.1-ci-20201023.1 319 10/23/2020
0.0.1-ci-20201022.1 315 10/22/2020
0.0.1-ci-20201008.1 304 10/8/2020
0.0.1-ci-20201005.1 360 10/5/2020
0.0.1-ci-20200407.1 359 4/7/2020
0.0.1-ci-20200406.3 364 4/6/2020
0.0.1-ci-20200406.2 369 4/6/2020
0.0.1-ci-20200406.1 372 4/6/2020
0.0.1-ci-20200403.5 360 4/3/2020
0.0.1-ci-20200403.4 373 4/3/2020
0.0.1-ci-20200403.3 376 4/3/2020
0.0.1-ci-20200403.2 363 4/3/2020
0.0.1-ci-20200403.1 365 4/3/2020
0.0.1-ci-20200402.2 368 4/2/2020
0.0.1-ci-20200402.1 395 4/2/2020