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 229 12/19/2024
2.0.0-net9.9 64 12/19/2024
2.0.0-net9.8 67 12/19/2024
2.0.0-net9.7 72 12/19/2024
2.0.0-net9.6 67 12/18/2024
2.0.0-net9.5 63 12/18/2024
2.0.0-net9.4 71 12/18/2024
2.0.0-net9.3 69 12/18/2024
2.0.0-net9.2 84 12/18/2024
1.17.0 963 10/9/2025
1.16.1 30,508 6/18/2024
1.16.0 594 6/14/2024
1.16.0-alpha0003 150 6/14/2024
1.16.0-alpha0001 439 3/27/2024
1.15.0 6,773 3/12/2024
1.15.0-alpha0002 159 3/12/2024
1.14.1 557 2/28/2024
1.14.0 1,121 12/22/2023
1.14.0-alpha0015 170 12/22/2023
1.13.0 26,763 9/14/2022
1.13.0-alpha0001 359 9/13/2022
1.12.0 3,262 8/3/2022
1.12.0-alpha0038 297 8/3/2022
1.12.0-alpha0028 342 7/8/2022
1.12.0-alpha0019 278 7/7/2022
1.12.0-alpha0011 309 6/14/2022
1.12.0-alpha0004 393 2/2/2022
1.12.0-alpha0003 345 2/2/2022
1.11.0 9,670 11/12/2021
1.11.0-alpha0015 384 11/12/2021
1.10.0 508 11/8/2021
1.10.0-net60-alpha0001 290 10/19/2021
1.10.0-alpha0010 361 11/8/2021
1.9.0 1,505 8/4/2021
1.9.0-alpha0006 453 8/4/2021
1.8.3 1,155 7/14/2021
1.8.3-beta0001 407 7/14/2021
1.8.2 586 7/13/2021
1.8.2-beta0001 448 7/13/2021
1.8.1 701 6/25/2021
1.8.1-beta0001 459 6/25/2021
1.8.0 557 6/19/2021
1.8.0-html-marker-laye0001 432 6/8/2021
1.8.0-alpha0003 450 6/19/2021
1.7.1 695 6/8/2021
1.7.1-beta0001 430 6/3/2021
1.7.0 654 5/31/2021
1.7.0-alpha0014 446 5/31/2021
1.7.0-alpha0004 406 5/18/2021
1.7.0-alpha0001 403 5/13/2021
1.6.1 727 5/18/2021
1.6.1-beta0001 416 5/18/2021
1.6.0 593 5/7/2021
1.6.0-alpha0050 470 5/7/2021
1.6.0-alpha0031 466 5/7/2021
1.6.0-alpha0015 442 5/7/2021
1.5.2 565 5/6/2021
1.5.2-beta0001 460 5/6/2021
1.5.1 812 4/30/2021
1.5.1-beta0001 407 4/30/2021
1.5.0 578 4/26/2021
1.5.0-alpha0016 423 4/23/2021
1.4.0 548 4/23/2021
1.4.0-alpha0005 425 4/20/2021
1.3.0 623 4/19/2021
1.3.0-beta0003 478 4/17/2021
1.3.0-beta0002 429 4/17/2021
1.3.0-beta0001 436 4/17/2021
1.3.0-alpha0001 417 4/16/2021
1.2.0 536 4/15/2021
1.2.0-alpha0004 399 4/15/2021
1.1.0 616 4/13/2021
1.1.0-alpha0015 390 4/13/2021
1.0.0 647 4/9/2021
1.0.0-beta0008 430 3/26/2021
1.0.0-beta0007 426 3/24/2021
1.0.0-beta0006 450 3/23/2021
1.0.0-beta0005 434 3/22/2021
1.0.0-beta0004 464 3/19/2021
1.0.0-beta0003 443 3/19/2021
1.0.0-beta0002 446 3/19/2021
1.0.0-beta0001 426 3/19/2021
0.17.1 530 4/6/2021
0.17.1-beta0001 401 4/5/2021
0.17.0 589 3/24/2021
0.16.0 579 3/23/2021
0.15.0 776 3/8/2021
0.15.0-alpha0038 459 3/8/2021
0.14.0 581 3/5/2021
0.14.0-alpha0003 416 3/5/2021
0.13.0 594 3/3/2021
0.13.0-alpha0001 436 3/3/2021
0.12.0 667 2/18/2021
0.12.0-typescript0001 440 2/18/2021
0.12.0-publish-typescri0001 443 2/18/2021
0.12.0-alpha0018 445 2/18/2021
0.11.0 574 2/17/2021
0.11.0-alpha0003 408 2/17/2021
0.10.1 581 2/15/2021
0.10.0 544 2/15/2021
0.10.0-alpha0011 403 2/15/2021
0.10.0-alpha0005 410 2/15/2021
0.9.0 613 1/24/2021
0.9.0-alpha0013 504 1/24/2021
0.9.0-alpha0006 505 1/3/2021
0.9.0-alpha0003 471 12/8/2020
0.8.1 629 1/3/2021
0.8.0 706 12/8/2020
0.8.0-beta0001 445 12/8/2020
0.8.0-alpha0005 485 11/25/2020
0.7.1 644 11/25/2020
0.7.0 656 11/25/2020
0.7.0-beta0001 494 11/25/2020
0.7.0-alpha0002 463 11/24/2020
0.6.0-beta0001 500 11/24/2020
0.6.0-alpha0005 486 11/24/2020
0.6.0-alpha0001 473 11/23/2020
0.5.2 1,867 11/24/2020
0.5.1 613 11/23/2020
0.5.0 603 11/19/2020
0.4.0 601 11/12/2020
0.3.0-beta0001 534 11/12/2020
0.3.0-alpha0019 448 11/19/2020
0.3.0-alpha0010 485 11/12/2020
0.3.0-alpha0004 525 11/12/2020
0.2.0 613 11/12/2020
0.2.0-beta0003 553 11/12/2020
0.2.0-beta0002 517 11/12/2020
0.2.0-beta0001 499 11/11/2020
0.1.0 700 11/11/2020
0.1.0-beta0002 511 11/11/2020
0.1.0-beta0001 506 11/11/2020
0.1.0-alpha0236 534 11/11/2020
0.1.0-alpha0116 491 11/11/2020
0.1.0-alpha0112 511 11/11/2020
0.1.0-alpha0097 504 11/11/2020
0.1.0-alpha0091 524 11/11/2020
0.1.0-alpha0090 541 11/10/2020
0.1.0-alpha0089 515 11/10/2020
0.1.0-alpha0088 536 11/10/2020
0.1.0-alpha0087 533 11/10/2020
0.1.0-alpha0086 525 11/10/2020
0.1.0-alpha0085 533 11/10/2020
0.1.0-alpha0084 531 11/10/2020
0.1.0-alpha0083 518 11/10/2020
0.1.0-alpha0082 567 11/9/2020
0.1.0-alpha0081 581 11/9/2020
0.1.0-alpha0080 566 11/9/2020
0.1.0-alpha0079 533 11/7/2020
0.1.0-alpha0077 738 11/6/2020
0.1.0-alpha0076 674 11/6/2020
0.1.0-alpha0074 602 11/6/2020
0.1.0-alpha0071 547 11/6/2020
0.0.1-ci-20201106.2 459 11/6/2020
0.0.1-ci-20201106.1 388 11/6/2020
0.0.1-ci-20201105.7 431 11/5/2020
0.0.1-ci-20201105.6 438 11/5/2020
0.0.1-ci-20201105.5 445 11/5/2020
0.0.1-ci-20201105.4 437 11/5/2020
0.0.1-ci-20201105.3 410 11/5/2020
0.0.1-ci-20201105.2 392 11/5/2020
0.0.1-ci-20201105.1 380 11/5/2020
0.0.1-ci-20201104.2 390 11/4/2020
0.0.1-ci-20201104.1 397 11/4/2020
0.0.1-ci-20201030.5 390 10/30/2020
0.0.1-ci-20201030.4 401 10/30/2020
0.0.1-ci-20201030.3 416 10/30/2020
0.0.1-ci-20201030.2 427 10/30/2020
0.0.1-ci-20201030.1 409 10/30/2020
0.0.1-ci-20201029.3 393 10/29/2020
0.0.1-ci-20201029.2 430 10/29/2020
0.0.1-ci-20201029.1 394 10/29/2020
0.0.1-ci-20201028.1 376 10/28/2020
0.0.1-ci-20201027.1 390 10/27/2020
0.0.1-ci-20201026.2 426 10/26/2020
0.0.1-ci-20201026.1 374 10/26/2020
0.0.1-ci-20201023.2 423 10/23/2020
0.0.1-ci-20201023.1 401 10/23/2020
0.0.1-ci-20201022.1 393 10/22/2020
0.0.1-ci-20201008.1 382 10/8/2020
0.0.1-ci-20201005.1 456 10/5/2020
0.0.1-ci-20200407.1 450 4/7/2020
0.0.1-ci-20200406.3 463 4/6/2020
0.0.1-ci-20200406.2 449 4/6/2020
0.0.1-ci-20200406.1 451 4/6/2020
0.0.1-ci-20200403.5 470 4/3/2020
0.0.1-ci-20200403.4 453 4/3/2020
0.0.1-ci-20200403.3 460 4/3/2020
0.0.1-ci-20200403.2 444 4/3/2020
0.0.1-ci-20200403.1 458 4/3/2020
0.0.1-ci-20200402.2 452 4/2/2020
0.0.1-ci-20200402.1 476 4/2/2020