AzureMapsControl.Components 1.12.0-alpha0028

This is a prerelease version of AzureMapsControl.Components.
There is a newer version of this package available.
See the version list below for details.
dotnet add package AzureMapsControl.Components --version 1.12.0-alpha0028
                    
NuGet\Install-Package AzureMapsControl.Components -Version 1.12.0-alpha0028
                    
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.12.0-alpha0028" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AzureMapsControl.Components" Version="1.12.0-alpha0028" />
                    
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.12.0-alpha0028
                    
#r "nuget: AzureMapsControl.Components, 1.12.0-alpha0028"
                    
#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.12.0-alpha0028
                    
#: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.12.0-alpha0028&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=AzureMapsControl.Components&version=1.12.0-alpha0028&prerelease
                    
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 rel="stylesheet" href="https://atlas.microsoft.com/sdk/javascript/mapcontrol/2/atlas.min.css" type="text/css" />
<script src="https://atlas.microsoft.com/sdk/javascript/mapcontrol/2/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/2/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/2/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/2/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 net5.0 is compatible.  net5.0-windows was computed.  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 was computed.  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 was computed.  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 252 12/19/2024
2.0.0-net9.9 77 12/19/2024
2.0.0-net9.8 80 12/19/2024
2.0.0-net9.7 90 12/19/2024
2.0.0-net9.6 82 12/18/2024
2.0.0-net9.5 76 12/18/2024
2.0.0-net9.4 89 12/18/2024
2.0.0-net9.3 81 12/18/2024
2.0.0-net9.2 103 12/18/2024
1.17.0 1,957 10/9/2025
1.16.1 32,072 6/18/2024
1.16.0 751 6/14/2024
1.16.0-alpha0003 160 6/14/2024
1.16.0-alpha0001 468 3/27/2024
1.15.0 6,837 3/12/2024
1.15.0-alpha0002 169 3/12/2024
1.14.1 579 2/28/2024
1.14.0 1,131 12/22/2023
1.14.0-alpha0015 183 12/22/2023
1.13.0 26,964 9/14/2022
1.13.0-alpha0001 379 9/13/2022
1.12.0 3,281 8/3/2022
1.12.0-alpha0038 318 8/3/2022
1.12.0-alpha0028 357 7/8/2022
1.12.0-alpha0019 293 7/7/2022
1.12.0-alpha0011 330 6/14/2022
1.12.0-alpha0004 414 2/2/2022
1.12.0-alpha0003 360 2/2/2022
1.11.0 9,700 11/12/2021
1.11.0-alpha0015 399 11/12/2021
1.10.0 519 11/8/2021
1.10.0-net60-alpha0001 309 10/19/2021
1.10.0-alpha0010 379 11/8/2021
1.9.0 1,523 8/4/2021
1.9.0-alpha0006 472 8/4/2021
1.8.3 1,178 7/14/2021
1.8.3-beta0001 423 7/14/2021
1.8.2 605 7/13/2021
1.8.2-beta0001 464 7/13/2021
1.8.1 719 6/25/2021
1.8.1-beta0001 476 6/25/2021
1.8.0 574 6/19/2021
1.8.0-html-marker-laye0001 447 6/8/2021
1.8.0-alpha0003 464 6/19/2021
1.7.1 711 6/8/2021
1.7.1-beta0001 449 6/3/2021
1.7.0 666 5/31/2021
1.7.0-alpha0014 459 5/31/2021
1.7.0-alpha0004 424 5/18/2021
1.7.0-alpha0001 422 5/13/2021
1.6.1 744 5/18/2021
1.6.1-beta0001 432 5/18/2021
1.6.0 612 5/7/2021
1.6.0-alpha0050 484 5/7/2021
1.6.0-alpha0031 482 5/7/2021
1.6.0-alpha0015 453 5/7/2021
1.5.2 582 5/6/2021
1.5.2-beta0001 480 5/6/2021
1.5.1 829 4/30/2021
1.5.1-beta0001 422 4/30/2021
1.5.0 604 4/26/2021
1.5.0-alpha0016 445 4/23/2021
1.4.0 566 4/23/2021
1.4.0-alpha0005 440 4/20/2021
1.3.0 640 4/19/2021
1.3.0-beta0003 492 4/17/2021
1.3.0-beta0002 450 4/17/2021
1.3.0-beta0001 453 4/17/2021
1.3.0-alpha0001 432 4/16/2021
1.2.0 550 4/15/2021
1.2.0-alpha0004 416 4/15/2021
1.1.0 634 4/13/2021
1.1.0-alpha0015 407 4/13/2021
1.0.0 662 4/9/2021
1.0.0-beta0008 448 3/26/2021
1.0.0-beta0007 446 3/24/2021
1.0.0-beta0006 466 3/23/2021
1.0.0-beta0005 458 3/22/2021
1.0.0-beta0004 477 3/19/2021
1.0.0-beta0003 457 3/19/2021
1.0.0-beta0002 463 3/19/2021
1.0.0-beta0001 442 3/19/2021
0.17.1 558 4/6/2021
0.17.1-beta0001 417 4/5/2021
0.17.0 605 3/24/2021
0.16.0 599 3/23/2021
0.15.0 793 3/8/2021
0.15.0-alpha0038 472 3/8/2021
0.14.0 596 3/5/2021
0.14.0-alpha0003 431 3/5/2021
0.13.0 608 3/3/2021
0.13.0-alpha0001 454 3/3/2021
0.12.0 681 2/18/2021
0.12.0-typescript0001 454 2/18/2021
0.12.0-publish-typescri0001 459 2/18/2021
0.12.0-alpha0018 460 2/18/2021
0.11.0 592 2/17/2021
0.11.0-alpha0003 422 2/17/2021
0.10.1 596 2/15/2021
0.10.0 555 2/15/2021
0.10.0-alpha0011 418 2/15/2021
0.10.0-alpha0005 421 2/15/2021
0.9.0 635 1/24/2021
0.9.0-alpha0013 521 1/24/2021
0.9.0-alpha0006 525 1/3/2021
0.9.0-alpha0003 485 12/8/2020
0.8.1 648 1/3/2021
0.8.0 722 12/8/2020
0.8.0-beta0001 464 12/8/2020
0.8.0-alpha0005 503 11/25/2020
0.7.1 668 11/25/2020
0.7.0 679 11/25/2020
0.7.0-beta0001 512 11/25/2020
0.7.0-alpha0002 484 11/24/2020
0.6.0-beta0001 521 11/24/2020
0.6.0-alpha0005 503 11/24/2020
0.6.0-alpha0001 492 11/23/2020
0.5.2 1,888 11/24/2020
0.5.1 629 11/23/2020
0.5.0 625 11/19/2020
0.4.0 621 11/12/2020
0.3.0-beta0001 557 11/12/2020
0.3.0-alpha0019 471 11/19/2020
0.3.0-alpha0010 502 11/12/2020
0.3.0-alpha0004 546 11/12/2020
0.2.0 624 11/12/2020
0.2.0-beta0003 573 11/12/2020
0.2.0-beta0002 536 11/12/2020
0.2.0-beta0001 515 11/11/2020
0.1.0 724 11/11/2020
0.1.0-beta0002 527 11/11/2020
0.1.0-beta0001 529 11/11/2020
0.1.0-alpha0236 557 11/11/2020
0.1.0-alpha0116 510 11/11/2020
0.1.0-alpha0112 531 11/11/2020
0.1.0-alpha0097 523 11/11/2020
0.1.0-alpha0091 545 11/11/2020
0.1.0-alpha0090 562 11/10/2020
0.1.0-alpha0089 535 11/10/2020
0.1.0-alpha0088 555 11/10/2020
0.1.0-alpha0087 547 11/10/2020
0.1.0-alpha0086 542 11/10/2020
0.1.0-alpha0085 550 11/10/2020
0.1.0-alpha0084 546 11/10/2020
0.1.0-alpha0083 538 11/10/2020
0.1.0-alpha0082 589 11/9/2020
0.1.0-alpha0081 603 11/9/2020
0.1.0-alpha0080 583 11/9/2020
0.1.0-alpha0079 552 11/7/2020
0.1.0-alpha0077 759 11/6/2020
0.1.0-alpha0076 691 11/6/2020
0.1.0-alpha0074 623 11/6/2020
0.1.0-alpha0071 563 11/6/2020
0.0.1-ci-20201106.2 478 11/6/2020
0.0.1-ci-20201106.1 405 11/6/2020
0.0.1-ci-20201105.7 450 11/5/2020
0.0.1-ci-20201105.6 456 11/5/2020
0.0.1-ci-20201105.5 463 11/5/2020
0.0.1-ci-20201105.4 454 11/5/2020
0.0.1-ci-20201105.3 428 11/5/2020
0.0.1-ci-20201105.2 416 11/5/2020
0.0.1-ci-20201105.1 396 11/5/2020
0.0.1-ci-20201104.2 408 11/4/2020
0.0.1-ci-20201104.1 417 11/4/2020
0.0.1-ci-20201030.5 410 10/30/2020
0.0.1-ci-20201030.4 411 10/30/2020
0.0.1-ci-20201030.3 437 10/30/2020
0.0.1-ci-20201030.2 447 10/30/2020
0.0.1-ci-20201030.1 428 10/30/2020
0.0.1-ci-20201029.3 410 10/29/2020
0.0.1-ci-20201029.2 444 10/29/2020
0.0.1-ci-20201029.1 408 10/29/2020
0.0.1-ci-20201028.1 389 10/28/2020
0.0.1-ci-20201027.1 407 10/27/2020
0.0.1-ci-20201026.2 449 10/26/2020
0.0.1-ci-20201026.1 389 10/26/2020
0.0.1-ci-20201023.2 438 10/23/2020
0.0.1-ci-20201023.1 427 10/23/2020
0.0.1-ci-20201022.1 411 10/22/2020
0.0.1-ci-20201008.1 405 10/8/2020
0.0.1-ci-20201005.1 471 10/5/2020
0.0.1-ci-20200407.1 468 4/7/2020
0.0.1-ci-20200406.3 479 4/6/2020
0.0.1-ci-20200406.2 463 4/6/2020
0.0.1-ci-20200406.1 470 4/6/2020
0.0.1-ci-20200403.5 490 4/3/2020
0.0.1-ci-20200403.4 471 4/3/2020
0.0.1-ci-20200403.3 474 4/3/2020
0.0.1-ci-20200403.2 459 4/3/2020
0.0.1-ci-20200403.1 474 4/3/2020
0.0.1-ci-20200402.2 472 4/2/2020
0.0.1-ci-20200402.1 496 4/2/2020