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 185 12/19/2024
2.0.0-net9.9 55 12/19/2024
2.0.0-net9.8 57 12/19/2024
2.0.0-net9.7 61 12/19/2024
2.0.0-net9.6 56 12/18/2024
2.0.0-net9.5 57 12/18/2024
2.0.0-net9.4 58 12/18/2024
2.0.0-net9.3 57 12/18/2024
2.0.0-net9.2 73 12/18/2024
1.16.1 22,899 6/18/2024
1.16.0 177 6/14/2024
1.16.0-alpha0003 115 6/14/2024
1.16.0-alpha0001 362 3/27/2024
1.15.0 6,460 3/12/2024
1.15.0-alpha0002 112 3/12/2024
1.14.1 485 2/28/2024
1.14.0 1,045 12/22/2023
1.14.0-alpha0015 130 12/22/2023
1.13.0 26,029 9/14/2022
1.13.0-alpha0001 280 9/13/2022
1.12.0 3,175 8/3/2022
1.12.0-alpha0038 203 8/3/2022
1.12.0-alpha0028 249 7/8/2022
1.12.0-alpha0019 197 7/7/2022
1.12.0-alpha0011 210 6/14/2022
1.12.0-alpha0004 285 2/2/2022
1.12.0-alpha0003 235 2/2/2022
1.11.0 9,218 11/12/2021
1.11.0-alpha0015 275 11/12/2021
1.10.0 419 11/8/2021
1.10.0-net60-alpha0001 221 10/19/2021
1.10.0-alpha0010 278 11/8/2021
1.9.0 1,398 8/4/2021
1.9.0-alpha0006 361 8/4/2021
1.8.3 1,068 7/14/2021
1.8.3-beta0001 321 7/14/2021
1.8.2 493 7/13/2021
1.8.2-beta0001 359 7/13/2021
1.8.1 611 6/25/2021
1.8.1-beta0001 367 6/25/2021
1.8.0 466 6/19/2021
1.8.0-html-marker-laye0001 337 6/8/2021
1.8.0-alpha0003 339 6/19/2021
1.7.1 586 6/8/2021
1.7.1-beta0001 332 6/3/2021
1.7.0 557 5/31/2021
1.7.0-alpha0014 357 5/31/2021
1.7.0-alpha0004 317 5/18/2021
1.7.0-alpha0001 324 5/13/2021
1.6.1 632 5/18/2021
1.6.1-beta0001 321 5/18/2021
1.6.0 512 5/7/2021
1.6.0-alpha0050 361 5/7/2021
1.6.0-alpha0031 373 5/7/2021
1.6.0-alpha0015 349 5/7/2021
1.5.2 471 5/6/2021
1.5.2-beta0001 364 5/6/2021
1.5.1 716 4/30/2021
1.5.1-beta0001 325 4/30/2021
1.5.0 483 4/26/2021
1.5.0-alpha0016 337 4/23/2021
1.4.0 453 4/23/2021
1.4.0-alpha0005 334 4/20/2021
1.3.0 512 4/19/2021
1.3.0-beta0003 363 4/17/2021
1.3.0-beta0002 337 4/17/2021
1.3.0-beta0001 349 4/17/2021
1.3.0-alpha0001 325 4/16/2021
1.2.0 442 4/15/2021
1.2.0-alpha0004 308 4/15/2021
1.1.0 507 4/13/2021
1.1.0-alpha0015 301 4/13/2021
1.0.0 542 4/9/2021
1.0.0-beta0008 340 3/26/2021
1.0.0-beta0007 346 3/24/2021
1.0.0-beta0006 355 3/23/2021
1.0.0-beta0005 355 3/22/2021
1.0.0-beta0004 354 3/19/2021
1.0.0-beta0003 348 3/19/2021
1.0.0-beta0002 348 3/19/2021
1.0.0-beta0001 333 3/19/2021
0.17.1 435 4/6/2021
0.17.1-beta0001 313 4/5/2021
0.17.0 498 3/24/2021
0.16.0 472 3/23/2021
0.15.0 674 3/8/2021
0.15.0-alpha0038 361 3/8/2021
0.14.0 479 3/5/2021
0.14.0-alpha0003 317 3/5/2021
0.13.0 492 3/3/2021
0.13.0-alpha0001 336 3/3/2021
0.12.0 567 2/18/2021
0.12.0-typescript0001 344 2/18/2021
0.12.0-publish-typescri0001 345 2/18/2021
0.12.0-alpha0018 329 2/18/2021
0.11.0 475 2/17/2021
0.11.0-alpha0003 312 2/17/2021
0.10.1 484 2/15/2021
0.10.0 445 2/15/2021
0.10.0-alpha0011 304 2/15/2021
0.10.0-alpha0005 315 2/15/2021
0.9.0 514 1/24/2021
0.9.0-alpha0013 410 1/24/2021
0.9.0-alpha0006 383 1/3/2021
0.9.0-alpha0003 370 12/8/2020
0.8.1 526 1/3/2021
0.8.0 604 12/8/2020
0.8.0-beta0001 345 12/8/2020
0.8.0-alpha0005 384 11/25/2020
0.7.1 539 11/25/2020
0.7.0 527 11/25/2020
0.7.0-beta0001 388 11/25/2020
0.7.0-alpha0002 374 11/24/2020
0.6.0-beta0001 400 11/24/2020
0.6.0-alpha0005 390 11/24/2020
0.6.0-alpha0001 373 11/23/2020
0.5.2 1,761 11/24/2020
0.5.1 511 11/23/2020
0.5.0 499 11/19/2020
0.4.0 510 11/12/2020
0.3.0-beta0001 414 11/12/2020
0.3.0-alpha0019 347 11/19/2020
0.3.0-alpha0010 387 11/12/2020
0.3.0-alpha0004 410 11/12/2020
0.2.0 511 11/12/2020
0.2.0-beta0003 450 11/12/2020
0.2.0-beta0002 415 11/12/2020
0.2.0-beta0001 395 11/11/2020
0.1.0 586 11/11/2020
0.1.0-beta0002 412 11/11/2020
0.1.0-beta0001 404 11/11/2020
0.1.0-alpha0236 436 11/11/2020
0.1.0-alpha0116 393 11/11/2020
0.1.0-alpha0112 408 11/11/2020
0.1.0-alpha0097 410 11/11/2020
0.1.0-alpha0091 426 11/11/2020
0.1.0-alpha0090 427 11/10/2020
0.1.0-alpha0089 420 11/10/2020
0.1.0-alpha0088 438 11/10/2020
0.1.0-alpha0087 435 11/10/2020
0.1.0-alpha0086 424 11/10/2020
0.1.0-alpha0085 440 11/10/2020
0.1.0-alpha0084 426 11/10/2020
0.1.0-alpha0083 417 11/10/2020
0.1.0-alpha0082 471 11/9/2020
0.1.0-alpha0081 478 11/9/2020
0.1.0-alpha0080 470 11/9/2020
0.1.0-alpha0079 434 11/7/2020
0.1.0-alpha0077 626 11/6/2020
0.1.0-alpha0076 589 11/6/2020
0.1.0-alpha0074 501 11/6/2020
0.1.0-alpha0071 444 11/6/2020
0.0.1-ci-20201106.2 357 11/6/2020
0.0.1-ci-20201106.1 313 11/6/2020
0.0.1-ci-20201105.7 354 11/5/2020
0.0.1-ci-20201105.6 364 11/5/2020
0.0.1-ci-20201105.5 370 11/5/2020
0.0.1-ci-20201105.4 360 11/5/2020
0.0.1-ci-20201105.3 314 11/5/2020
0.0.1-ci-20201105.2 318 11/5/2020
0.0.1-ci-20201105.1 305 11/5/2020
0.0.1-ci-20201104.2 315 11/4/2020
0.0.1-ci-20201104.1 324 11/4/2020
0.0.1-ci-20201030.5 317 10/30/2020
0.0.1-ci-20201030.4 328 10/30/2020
0.0.1-ci-20201030.3 339 10/30/2020
0.0.1-ci-20201030.2 334 10/30/2020
0.0.1-ci-20201030.1 312 10/30/2020
0.0.1-ci-20201029.3 317 10/29/2020
0.0.1-ci-20201029.2 337 10/29/2020
0.0.1-ci-20201029.1 318 10/29/2020
0.0.1-ci-20201028.1 301 10/28/2020
0.0.1-ci-20201027.1 318 10/27/2020
0.0.1-ci-20201026.2 348 10/26/2020
0.0.1-ci-20201026.1 294 10/26/2020
0.0.1-ci-20201023.2 352 10/23/2020
0.0.1-ci-20201023.1 322 10/23/2020
0.0.1-ci-20201022.1 318 10/22/2020
0.0.1-ci-20201008.1 307 10/8/2020
0.0.1-ci-20201005.1 363 10/5/2020
0.0.1-ci-20200407.1 365 4/7/2020
0.0.1-ci-20200406.3 368 4/6/2020
0.0.1-ci-20200406.2 372 4/6/2020
0.0.1-ci-20200406.1 375 4/6/2020
0.0.1-ci-20200403.5 365 4/3/2020
0.0.1-ci-20200403.4 376 4/3/2020
0.0.1-ci-20200403.3 379 4/3/2020
0.0.1-ci-20200403.2 366 4/3/2020
0.0.1-ci-20200403.1 371 4/3/2020
0.0.1-ci-20200402.2 371 4/2/2020
0.0.1-ci-20200402.1 398 4/2/2020