AzureMapsControl.Components 1.17.0

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package AzureMapsControl.Components --version 1.17.0
                    
NuGet\Install-Package AzureMapsControl.Components -Version 1.17.0
                    
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.17.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AzureMapsControl.Components" Version="1.17.0" />
                    
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.17.0
                    
#r "nuget: AzureMapsControl.Components, 1.17.0"
                    
#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.
#:package AzureMapsControl.Components@1.17.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=AzureMapsControl.Components&version=1.17.0
                    
Install as a Cake Addin
#tool nuget:?package=AzureMapsControl.Components&version=1.17.0
                    
Install as a Cake Tool

Nuget Nuget (with prereleases) Downloads 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 218 12/19/2024
2.0.0-net9.9 58 12/19/2024
2.0.0-net9.8 62 12/19/2024
2.0.0-net9.7 63 12/19/2024
2.0.0-net9.6 60 12/18/2024
2.0.0-net9.5 60 12/18/2024
2.0.0-net9.4 64 12/18/2024
2.0.0-net9.3 63 12/18/2024
2.0.0-net9.2 79 12/18/2024
1.17.0 500 10/9/2025
1.16.1 29,320 6/18/2024
1.16.0 523 6/14/2024
1.16.0-alpha0003 146 6/14/2024
1.16.0-alpha0001 425 3/27/2024
1.15.0 6,732 3/12/2024
1.15.0-alpha0002 147 3/12/2024
1.14.1 546 2/28/2024
1.14.0 1,114 12/22/2023
1.14.0-alpha0015 163 12/22/2023
1.13.0 26,668 9/14/2022
1.13.0-alpha0001 345 9/13/2022
1.12.0 3,246 8/3/2022
1.12.0-alpha0038 279 8/3/2022
1.12.0-alpha0028 319 7/8/2022
1.12.0-alpha0019 264 7/7/2022
1.12.0-alpha0011 298 6/14/2022
1.12.0-alpha0004 377 2/2/2022
1.12.0-alpha0003 329 2/2/2022
1.11.0 9,589 11/12/2021
1.11.0-alpha0015 365 11/12/2021
1.10.0 493 11/8/2021
1.10.0-net60-alpha0001 274 10/19/2021
1.10.0-alpha0010 346 11/8/2021
1.9.0 1,490 8/4/2021
1.9.0-alpha0006 437 8/4/2021
1.8.3 1,141 7/14/2021
1.8.3-beta0001 393 7/14/2021
1.8.2 569 7/13/2021
1.8.2-beta0001 432 7/13/2021
1.8.1 684 6/25/2021
1.8.1-beta0001 440 6/25/2021
1.8.0 542 6/19/2021
1.8.0-html-marker-laye0001 415 6/8/2021
1.8.0-alpha0003 431 6/19/2021
1.7.1 682 6/8/2021
1.7.1-beta0001 412 6/3/2021
1.7.0 637 5/31/2021
1.7.0-alpha0014 429 5/31/2021
1.7.0-alpha0004 390 5/18/2021
1.7.0-alpha0001 386 5/13/2021
1.6.1 711 5/18/2021
1.6.1-beta0001 397 5/18/2021
1.6.0 577 5/7/2021
1.6.0-alpha0050 454 5/7/2021
1.6.0-alpha0031 452 5/7/2021
1.6.0-alpha0015 429 5/7/2021
1.5.2 548 5/6/2021
1.5.2-beta0001 444 5/6/2021
1.5.1 793 4/30/2021
1.5.1-beta0001 390 4/30/2021
1.5.0 562 4/26/2021
1.5.0-alpha0016 408 4/23/2021
1.4.0 527 4/23/2021
1.4.0-alpha0005 411 4/20/2021
1.3.0 606 4/19/2021
1.3.0-beta0003 462 4/17/2021
1.3.0-beta0002 414 4/17/2021
1.3.0-beta0001 421 4/17/2021
1.3.0-alpha0001 402 4/16/2021
1.2.0 517 4/15/2021
1.2.0-alpha0004 383 4/15/2021
1.1.0 600 4/13/2021
1.1.0-alpha0015 373 4/13/2021
1.0.0 630 4/9/2021
1.0.0-beta0008 416 3/26/2021
1.0.0-beta0007 413 3/24/2021
1.0.0-beta0006 433 3/23/2021
1.0.0-beta0005 419 3/22/2021
1.0.0-beta0004 450 3/19/2021
1.0.0-beta0003 426 3/19/2021
1.0.0-beta0002 426 3/19/2021
1.0.0-beta0001 411 3/19/2021
0.17.1 512 4/6/2021
0.17.1-beta0001 384 4/5/2021
0.17.0 575 3/24/2021
0.16.0 560 3/23/2021
0.15.0 753 3/8/2021
0.15.0-alpha0038 439 3/8/2021
0.14.0 563 3/5/2021
0.14.0-alpha0003 395 3/5/2021
0.13.0 572 3/3/2021
0.13.0-alpha0001 421 3/3/2021
0.12.0 646 2/18/2021
0.12.0-typescript0001 424 2/18/2021
0.12.0-publish-typescri0001 427 2/18/2021
0.12.0-alpha0018 427 2/18/2021
0.11.0 554 2/17/2021
0.11.0-alpha0003 389 2/17/2021
0.10.1 563 2/15/2021
0.10.0 524 2/15/2021
0.10.0-alpha0011 384 2/15/2021
0.10.0-alpha0005 390 2/15/2021
0.9.0 593 1/24/2021
0.9.0-alpha0013 488 1/24/2021
0.9.0-alpha0006 483 1/3/2021
0.9.0-alpha0003 448 12/8/2020
0.8.1 608 1/3/2021
0.8.0 684 12/8/2020
0.8.0-beta0001 424 12/8/2020
0.8.0-alpha0005 465 11/25/2020
0.7.1 623 11/25/2020
0.7.0 635 11/25/2020
0.7.0-beta0001 475 11/25/2020
0.7.0-alpha0002 441 11/24/2020
0.6.0-beta0001 479 11/24/2020
0.6.0-alpha0005 469 11/24/2020
0.6.0-alpha0001 455 11/23/2020
0.5.2 1,847 11/24/2020
0.5.1 593 11/23/2020
0.5.0 583 11/19/2020
0.4.0 581 11/12/2020
0.3.0-beta0001 511 11/12/2020
0.3.0-alpha0019 428 11/19/2020
0.3.0-alpha0010 464 11/12/2020
0.3.0-alpha0004 506 11/12/2020
0.2.0 593 11/12/2020
0.2.0-beta0003 529 11/12/2020
0.2.0-beta0002 498 11/12/2020
0.2.0-beta0001 480 11/11/2020
0.1.0 674 11/11/2020
0.1.0-beta0002 490 11/11/2020
0.1.0-beta0001 486 11/11/2020
0.1.0-alpha0236 518 11/11/2020
0.1.0-alpha0116 475 11/11/2020
0.1.0-alpha0112 493 11/11/2020
0.1.0-alpha0097 489 11/11/2020
0.1.0-alpha0091 507 11/11/2020
0.1.0-alpha0090 518 11/10/2020
0.1.0-alpha0089 498 11/10/2020
0.1.0-alpha0088 519 11/10/2020
0.1.0-alpha0087 513 11/10/2020
0.1.0-alpha0086 504 11/10/2020
0.1.0-alpha0085 512 11/10/2020
0.1.0-alpha0084 514 11/10/2020
0.1.0-alpha0083 495 11/10/2020
0.1.0-alpha0082 552 11/9/2020
0.1.0-alpha0081 558 11/9/2020
0.1.0-alpha0080 546 11/9/2020
0.1.0-alpha0079 516 11/7/2020
0.1.0-alpha0077 722 11/6/2020
0.1.0-alpha0076 656 11/6/2020
0.1.0-alpha0074 582 11/6/2020
0.1.0-alpha0071 523 11/6/2020
0.0.1-ci-20201106.2 436 11/6/2020
0.0.1-ci-20201106.1 368 11/6/2020
0.0.1-ci-20201105.7 414 11/5/2020
0.0.1-ci-20201105.6 421 11/5/2020
0.0.1-ci-20201105.5 427 11/5/2020
0.0.1-ci-20201105.4 417 11/5/2020
0.0.1-ci-20201105.3 388 11/5/2020
0.0.1-ci-20201105.2 374 11/5/2020
0.0.1-ci-20201105.1 359 11/5/2020
0.0.1-ci-20201104.2 369 11/4/2020
0.0.1-ci-20201104.1 379 11/4/2020
0.0.1-ci-20201030.5 372 10/30/2020
0.0.1-ci-20201030.4 383 10/30/2020
0.0.1-ci-20201030.3 396 10/30/2020
0.0.1-ci-20201030.2 409 10/30/2020
0.0.1-ci-20201030.1 389 10/30/2020
0.0.1-ci-20201029.3 372 10/29/2020
0.0.1-ci-20201029.2 409 10/29/2020
0.0.1-ci-20201029.1 376 10/29/2020
0.0.1-ci-20201028.1 358 10/28/2020
0.0.1-ci-20201027.1 375 10/27/2020
0.0.1-ci-20201026.2 408 10/26/2020
0.0.1-ci-20201026.1 351 10/26/2020
0.0.1-ci-20201023.2 407 10/23/2020
0.0.1-ci-20201023.1 380 10/23/2020
0.0.1-ci-20201022.1 374 10/22/2020
0.0.1-ci-20201008.1 364 10/8/2020
0.0.1-ci-20201005.1 437 10/5/2020
0.0.1-ci-20200407.1 433 4/7/2020
0.0.1-ci-20200406.3 445 4/6/2020
0.0.1-ci-20200406.2 432 4/6/2020
0.0.1-ci-20200406.1 433 4/6/2020
0.0.1-ci-20200403.5 449 4/3/2020
0.0.1-ci-20200403.4 435 4/3/2020
0.0.1-ci-20200403.3 438 4/3/2020
0.0.1-ci-20200403.2 422 4/3/2020
0.0.1-ci-20200403.1 443 4/3/2020
0.0.1-ci-20200402.2 431 4/2/2020
0.0.1-ci-20200402.1 457 4/2/2020