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.
#:package AzureMapsControl.Components@1.16.1
                    
#: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.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 190 12/19/2024
2.0.0-net9.9 56 12/19/2024
2.0.0-net9.8 58 12/19/2024
2.0.0-net9.7 62 12/19/2024
2.0.0-net9.6 58 12/18/2024
2.0.0-net9.5 58 12/18/2024
2.0.0-net9.4 59 12/18/2024
2.0.0-net9.3 58 12/18/2024
2.0.0-net9.2 75 12/18/2024
1.16.1 23,547 6/18/2024
1.16.0 181 6/14/2024
1.16.0-alpha0003 118 6/14/2024
1.16.0-alpha0001 366 3/27/2024
1.15.0 6,493 3/12/2024
1.15.0-alpha0002 116 3/12/2024
1.14.1 488 2/28/2024
1.14.0 1,048 12/22/2023
1.14.0-alpha0015 132 12/22/2023
1.13.0 26,092 9/14/2022
1.13.0-alpha0001 293 9/13/2022
1.12.0 3,188 8/3/2022
1.12.0-alpha0038 217 8/3/2022
1.12.0-alpha0028 264 7/8/2022
1.12.0-alpha0019 211 7/7/2022
1.12.0-alpha0011 226 6/14/2022
1.12.0-alpha0004 300 2/2/2022
1.12.0-alpha0003 250 2/2/2022
1.11.0 9,249 11/12/2021
1.11.0-alpha0015 292 11/12/2021
1.10.0 434 11/8/2021
1.10.0-net60-alpha0001 236 10/19/2021
1.10.0-alpha0010 294 11/8/2021
1.9.0 1,414 8/4/2021
1.9.0-alpha0006 377 8/4/2021
1.8.3 1,082 7/14/2021
1.8.3-beta0001 335 7/14/2021
1.8.2 507 7/13/2021
1.8.2-beta0001 373 7/13/2021
1.8.1 626 6/25/2021
1.8.1-beta0001 382 6/25/2021
1.8.0 482 6/19/2021
1.8.0-html-marker-laye0001 353 6/8/2021
1.8.0-alpha0003 355 6/19/2021
1.7.1 602 6/8/2021
1.7.1-beta0001 348 6/3/2021
1.7.0 572 5/31/2021
1.7.0-alpha0014 372 5/31/2021
1.7.0-alpha0004 331 5/18/2021
1.7.0-alpha0001 338 5/13/2021
1.6.1 647 5/18/2021
1.6.1-beta0001 335 5/18/2021
1.6.0 525 5/7/2021
1.6.0-alpha0050 376 5/7/2021
1.6.0-alpha0031 387 5/7/2021
1.6.0-alpha0015 363 5/7/2021
1.5.2 485 5/6/2021
1.5.2-beta0001 381 5/6/2021
1.5.1 730 4/30/2021
1.5.1-beta0001 340 4/30/2021
1.5.0 498 4/26/2021
1.5.0-alpha0016 351 4/23/2021
1.4.0 468 4/23/2021
1.4.0-alpha0005 350 4/20/2021
1.3.0 527 4/19/2021
1.3.0-beta0003 380 4/17/2021
1.3.0-beta0002 352 4/17/2021
1.3.0-beta0001 363 4/17/2021
1.3.0-alpha0001 342 4/16/2021
1.2.0 456 4/15/2021
1.2.0-alpha0004 323 4/15/2021
1.1.0 526 4/13/2021
1.1.0-alpha0015 315 4/13/2021
1.0.0 557 4/9/2021
1.0.0-beta0008 354 3/26/2021
1.0.0-beta0007 361 3/24/2021
1.0.0-beta0006 372 3/23/2021
1.0.0-beta0005 369 3/22/2021
1.0.0-beta0004 370 3/19/2021
1.0.0-beta0003 365 3/19/2021
1.0.0-beta0002 363 3/19/2021
1.0.0-beta0001 348 3/19/2021
0.17.1 450 4/6/2021
0.17.1-beta0001 328 4/5/2021
0.17.0 513 3/24/2021
0.16.0 490 3/23/2021
0.15.0 691 3/8/2021
0.15.0-alpha0038 378 3/8/2021
0.14.0 497 3/5/2021
0.14.0-alpha0003 333 3/5/2021
0.13.0 507 3/3/2021
0.13.0-alpha0001 353 3/3/2021
0.12.0 583 2/18/2021
0.12.0-typescript0001 360 2/18/2021
0.12.0-publish-typescri0001 361 2/18/2021
0.12.0-alpha0018 345 2/18/2021
0.11.0 490 2/17/2021
0.11.0-alpha0003 327 2/17/2021
0.10.1 500 2/15/2021
0.10.0 460 2/15/2021
0.10.0-alpha0011 319 2/15/2021
0.10.0-alpha0005 330 2/15/2021
0.9.0 529 1/24/2021
0.9.0-alpha0013 426 1/24/2021
0.9.0-alpha0006 401 1/3/2021
0.9.0-alpha0003 385 12/8/2020
0.8.1 541 1/3/2021
0.8.0 619 12/8/2020
0.8.0-beta0001 361 12/8/2020
0.8.0-alpha0005 399 11/25/2020
0.7.1 555 11/25/2020
0.7.0 546 11/25/2020
0.7.0-beta0001 405 11/25/2020
0.7.0-alpha0002 389 11/24/2020
0.6.0-beta0001 416 11/24/2020
0.6.0-alpha0005 406 11/24/2020
0.6.0-alpha0001 389 11/23/2020
0.5.2 1,778 11/24/2020
0.5.1 527 11/23/2020
0.5.0 514 11/19/2020
0.4.0 527 11/12/2020
0.3.0-beta0001 430 11/12/2020
0.3.0-alpha0019 361 11/19/2020
0.3.0-alpha0010 401 11/12/2020
0.3.0-alpha0004 425 11/12/2020
0.2.0 526 11/12/2020
0.2.0-beta0003 465 11/12/2020
0.2.0-beta0002 434 11/12/2020
0.2.0-beta0001 411 11/11/2020
0.1.0 602 11/11/2020
0.1.0-beta0002 426 11/11/2020
0.1.0-beta0001 419 11/11/2020
0.1.0-alpha0236 451 11/11/2020
0.1.0-alpha0116 408 11/11/2020
0.1.0-alpha0112 424 11/11/2020
0.1.0-alpha0097 424 11/11/2020
0.1.0-alpha0091 441 11/11/2020
0.1.0-alpha0090 444 11/10/2020
0.1.0-alpha0089 435 11/10/2020
0.1.0-alpha0088 453 11/10/2020
0.1.0-alpha0087 450 11/10/2020
0.1.0-alpha0086 440 11/10/2020
0.1.0-alpha0085 456 11/10/2020
0.1.0-alpha0084 443 11/10/2020
0.1.0-alpha0083 431 11/10/2020
0.1.0-alpha0082 486 11/9/2020
0.1.0-alpha0081 493 11/9/2020
0.1.0-alpha0080 484 11/9/2020
0.1.0-alpha0079 448 11/7/2020
0.1.0-alpha0077 641 11/6/2020
0.1.0-alpha0076 603 11/6/2020
0.1.0-alpha0074 516 11/6/2020
0.1.0-alpha0071 458 11/6/2020
0.0.1-ci-20201106.2 373 11/6/2020
0.0.1-ci-20201106.1 327 11/6/2020
0.0.1-ci-20201105.7 369 11/5/2020
0.0.1-ci-20201105.6 378 11/5/2020
0.0.1-ci-20201105.5 384 11/5/2020
0.0.1-ci-20201105.4 375 11/5/2020
0.0.1-ci-20201105.3 331 11/5/2020
0.0.1-ci-20201105.2 333 11/5/2020
0.0.1-ci-20201105.1 319 11/5/2020
0.0.1-ci-20201104.2 330 11/4/2020
0.0.1-ci-20201104.1 339 11/4/2020
0.0.1-ci-20201030.5 331 10/30/2020
0.0.1-ci-20201030.4 343 10/30/2020
0.0.1-ci-20201030.3 353 10/30/2020
0.0.1-ci-20201030.2 351 10/30/2020
0.0.1-ci-20201030.1 330 10/30/2020
0.0.1-ci-20201029.3 332 10/29/2020
0.0.1-ci-20201029.2 351 10/29/2020
0.0.1-ci-20201029.1 332 10/29/2020
0.0.1-ci-20201028.1 316 10/28/2020
0.0.1-ci-20201027.1 333 10/27/2020
0.0.1-ci-20201026.2 362 10/26/2020
0.0.1-ci-20201026.1 309 10/26/2020
0.0.1-ci-20201023.2 366 10/23/2020
0.0.1-ci-20201023.1 336 10/23/2020
0.0.1-ci-20201022.1 332 10/22/2020
0.0.1-ci-20201008.1 322 10/8/2020
0.0.1-ci-20201005.1 379 10/5/2020
0.0.1-ci-20200407.1 383 4/7/2020
0.0.1-ci-20200406.3 385 4/6/2020
0.0.1-ci-20200406.2 390 4/6/2020
0.0.1-ci-20200406.1 391 4/6/2020
0.0.1-ci-20200403.5 386 4/3/2020
0.0.1-ci-20200403.4 392 4/3/2020
0.0.1-ci-20200403.3 395 4/3/2020
0.0.1-ci-20200403.2 382 4/3/2020
0.0.1-ci-20200403.1 387 4/3/2020
0.0.1-ci-20200402.2 388 4/2/2020
0.0.1-ci-20200402.1 414 4/2/2020